Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .chronus/changes/lro-operation-id-metadata-2026-10-20.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
changeKind: feature
packages:
- "@azure-tools/typespec-azure-core"
- "@azure-tools/typespec-client-generator-core"
- "@azure-tools/azure-http-specs"
---

Add scoped, source-tagged `@lroOperationId` metadata for legacy services that expose server-issued operation identity through a linked status-monitor URI, its response body, or both, plus representative Spector scenarios.
46 changes: 46 additions & 0 deletions packages/azure-http-specs/spec-summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -1268,6 +1268,52 @@ Expected response body:
}
```

### Azure_ClientGenerator_Core_Lro_OperationId_analyze

- Endpoint: `post /azure/client-generator-core/lro/operation-id/documentModels/{modelId}:analyze`

Declares a legacy Document Intelligence-shaped flow for emitter tests of
`@lroOperationId` on the status-monitor operation ID path parameter.

The status-monitor body does not model the server-issued result ID. The service returns the
complete opaque status-monitor URI, including its API-version query, and polling must continue
with that URI. Emitter-specific client tests can separately expose `analysis-123` as operation
identity by binding the decorated `resultId` parameter to the returned URI.

Expected calls:

- POST `/documentModels/document-1:analyze` returns 202 with
`Operation-Location: {endpoint}/documentModels/document-1/analyzeResults/analysis-123?api-version=2022-12-01-preview`
- GET that exact status-monitor URI returns a running status
- GET that exact status-monitor URI returns a succeeded status with the analysis result

### Azure_ClientGenerator_Core_Lro_OperationId_startTranslation

- Endpoint: `post /azure/client-generator-core/lro/operation-id/translations:start`

Declares a status-body operation ID flow where the polling URI does not contain the identifier.

Expected calls:

- POST `/translations:start` returns 202 with
`Operation-Location: {endpoint}/translations/status?api-version=2022-12-01-preview`
- GET that exact status-monitor URI returns a running status with `id: translation-123`
- GET that exact status-monitor URI returns a succeeded status with the same ID and result

### Azure_ClientGenerator_Core_Lro_OperationId_startTranslationWithPath

- Endpoint: `post /azure/client-generator-core/lro/operation-id/translations:start-with-path`

Declares a Translation-shaped fallback flow with operation identity in both the
Operation-Location path and the status-monitor body.

Expected calls:

- POST `/translations:start-with-path` returns 202 with
`Operation-Location: {endpoint}/translations/operations/translation-456?api-version=2022-12-01-preview`
- GET that exact status-monitor URI returns a running status with `id: translation-456`
- GET that exact status-monitor URI returns a succeeded status with the same ID and result

### Azure_ClientGenerator_Core_NextLinkVerb_listItems

- Endpoint: `post /azure/client-generator-core/next-link-verb/items`
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
import "@azure-tools/typespec-azure-core";
import "@azure-tools/typespec-client-generator-core";
import "@typespec/spector";
import "@typespec/versioning";

// cspell:ignore operationid

using Azure.ClientGenerator.Core;
using Azure.Core;
using Spector;
using TypeSpec.Http;
using TypeSpec.Versioning;

@doc("Defines a legacy service-shaped HTTP flow for testing URI-derived LRO operation identity.")
@scenarioService(
"/azure/client-generator-core/lro/operation-id",
{
versioned: Versions,
}
)
@global.Azure.ClientGenerator.Core.clientNamespace(
"azure.clientgenerator.core.lro.operationid",
"java"
)
@global.Azure.ClientGenerator.Core.clientNamespace(
"specs.azure.clientgenerator.core.lro.operationid",
"python"
)
namespace _Specs_.Azure.ClientGenerator.Core.Lro.OperationId;

enum Versions {
v2022_12_01_preview: "2022-12-01-preview",
}

model DocumentAnalysisStatus {
status: global.Azure.Core.Foundations.OperationState;
result?: DocumentAnalysisResult;
}

model DocumentAnalysisResult {
summary: string;
}

@route("/documentModels/{modelId}/analyzeResults/{resultId}")
@get
op getDocumentAnalysisStatus(
@path modelId: string,

@lroOperationId
@path
resultId: string,

...global.Azure.Core.Foundations.ApiVersionParameter,
): DocumentAnalysisStatus;

@scenario
@scenarioDoc("""
Declares a legacy Document Intelligence-shaped flow for emitter tests of
`@lroOperationId` on the status-monitor operation ID path parameter.

The status-monitor body does not model the server-issued result ID. The service returns the
complete opaque status-monitor URI, including its API-version query, and polling must continue
with that URI. Emitter-specific client tests can separately expose `analysis-123` as operation
identity by binding the decorated `resultId` parameter to the returned URI.

Expected calls:
- POST `/documentModels/document-1:analyze` returns 202 with
`Operation-Location: {endpoint}/documentModels/document-1/analyzeResults/analysis-123?api-version=2022-12-01-preview`
- GET that exact status-monitor URI returns a running status
- GET that exact status-monitor URI returns a succeeded status with the analysis result
""")
@route("/documentModels/{modelId}:analyze")
@post
@pollingOperation(getDocumentAnalysisStatus)
op analyze(
@path modelId: string,
...global.Azure.Core.Foundations.ApiVersionParameter,
): global.Azure.Core.Foundations.AcceptedResponse &
global.Azure.Core.Foundations.LongRunningStatusLocation<DocumentAnalysisStatus>;

model TranslationStatus {
@lroOperationId
id: string;

status: global.Azure.Core.Foundations.OperationState;
result?: TranslationResult;
}

model TranslationResult {
translatedCharacters: int32;
}

@route("/translations/status")
@get
op getTranslationStatus(...global.Azure.Core.Foundations.ApiVersionParameter): TranslationStatus;

@scenario
@scenarioDoc("""
Declares a status-body operation ID flow where the polling URI does not contain the identifier.

Expected calls:
- POST `/translations:start` returns 202 with
`Operation-Location: {endpoint}/translations/status?api-version=2022-12-01-preview`
- GET that exact status-monitor URI returns a running status with `id: translation-123`
- GET that exact status-monitor URI returns a succeeded status with the same ID and result
""")
@route("/translations:start")
@post
@pollingOperation(getTranslationStatus)
op startTranslation(
...global.Azure.Core.Foundations.ApiVersionParameter,
): global.Azure.Core.Foundations.AcceptedResponse &
global.Azure.Core.Foundations.LongRunningStatusLocation<TranslationStatus>;

model TranslationWithPathStatus {
@lroOperationId
id: string;

status: global.Azure.Core.Foundations.OperationState;
result?: TranslationResult;
}

@route("/translations/operations/{operationId}")
@get
op getTranslationWithPathStatus(
@lroOperationId
@path
operationId: string,

...global.Azure.Core.Foundations.ApiVersionParameter,
): TranslationWithPathStatus;

@scenario
@scenarioDoc("""
Declares a Translation-shaped fallback flow with operation identity in both the
Operation-Location path and the status-monitor body.

Expected calls:
- POST `/translations:start-with-path` returns 202 with
`Operation-Location: {endpoint}/translations/operations/translation-456?api-version=2022-12-01-preview`
- GET that exact status-monitor URI returns a running status with `id: translation-456`
- GET that exact status-monitor URI returns a succeeded status with the same ID and result
""")
@route("/translations:start-with-path")
@post
@pollingOperation(getTranslationWithPathStatus)
op startTranslationWithPath(
...global.Azure.Core.Foundations.ApiVersionParameter,
): global.Azure.Core.Foundations.AcceptedResponse &
global.Azure.Core.Foundations.LongRunningStatusLocation<TranslationWithPathStatus>;
Loading
Loading