From 69a87e6210a06df6e9c58cbcf0d178ef7f5c5e8f Mon Sep 17 00:00:00 2001 From: Brian Pescatore Date: Sun, 21 Jun 2026 18:48:09 +0000 Subject: [PATCH] Add requestId query parameter to all operations --- connection-coordinator/parameters/_index.yaml | 11 +++++++++++ connection-coordinator/paths/channels.yaml | 5 +++++ connection-coordinator/paths/connections.yaml | 7 +++++++ connection-coordinator/paths/environments.yaml | 3 +++ connection-coordinator/paths/features.yaml | 4 ++++ connection-coordinator/paths/interconnects.yaml | 2 ++ connection-coordinator/paths/issues.yaml | 6 ++++++ connection-coordinator/paths/macseckeys.yaml | 4 ++++ connection-coordinator/paths/providers.yaml | 5 ++++- connection-coordinator/schemas/common.yaml | 2 +- 10 files changed, 47 insertions(+), 2 deletions(-) diff --git a/connection-coordinator/parameters/_index.yaml b/connection-coordinator/parameters/_index.yaml index c5cc1d4..efbee48 100644 --- a/connection-coordinator/parameters/_index.yaml +++ b/connection-coordinator/parameters/_index.yaml @@ -79,6 +79,17 @@ parameters: type: string style: simple + x-request-id: + description: |- + Unique identifier for the request, used for tracing and idempotency. + in: query + name: requestId + required: false + schema: + type: string + format: uuid + example: 550e8400-e29b-41d4-a716-446655440000 + alt: description: Data format for response. explode: true diff --git a/connection-coordinator/paths/channels.yaml b/connection-coordinator/paths/channels.yaml index 39568ac..7826e27 100644 --- a/connection-coordinator/paths/channels.yaml +++ b/connection-coordinator/paths/channels.yaml @@ -3,6 +3,7 @@ AllChannels: description: List all channels associated with an interconnect. operationId: ListChannels parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -45,6 +46,7 @@ OneChannel: description: Get details about a specific channel. operationId: GetChannel parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -70,6 +72,7 @@ NotifyMaintenance: is consistent with the server provider. operationId: NotifyMaintenance parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -95,6 +98,7 @@ GetMaintenanceEvents: description: Get all maintenance events associated with a channel. operationId: GetMaintenanceEvents parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -121,6 +125,7 @@ RequestMacSecKeyRotation: key on the partner side using the MACsec key management APIs. operationId: RequestMacSecKeyRotation parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" diff --git a/connection-coordinator/paths/connections.yaml b/connection-coordinator/paths/connections.yaml index 6599392..6d9c493 100644 --- a/connection-coordinator/paths/connections.yaml +++ b/connection-coordinator/paths/connections.yaml @@ -3,6 +3,7 @@ AllConnections: description: List all connections associated with a given interconnect. operationId: ListConnections parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -63,6 +64,7 @@ AllConnections: created. operationId: CreateConnection parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -97,6 +99,7 @@ OneConnection: description: Delete a specific connection. operationId: DeleteConnection parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -115,6 +118,7 @@ OneConnection: description: Get details about a specific connection. operationId: GetConnection parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -144,6 +148,7 @@ OneConnection: resource. operationId: UpdateConnection parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -181,6 +186,7 @@ GenerateFeatureGuidance: with a given connection and return the results. operationId: GenerateFeatureGuidance parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -219,6 +225,7 @@ NotifyConnectionStatus: is consistent with the server provider. operationId: NotifyConnectionStatus parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" diff --git a/connection-coordinator/paths/environments.yaml b/connection-coordinator/paths/environments.yaml index 4f6d971..542eb74 100644 --- a/connection-coordinator/paths/environments.yaml +++ b/connection-coordinator/paths/environments.yaml @@ -3,6 +3,7 @@ AllEnvironments: description: List all environments associated with a CSP. operationId: ListEnvironments parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - description: |- The maximum number of environments to return. The service may return fewer @@ -43,6 +44,7 @@ OneEnvironment: description: Get details about a specific environment. operationId: GetEnvironment parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" responses: @@ -66,6 +68,7 @@ ConfirmActivationKey: response. operationId: ConfirmActivationKey parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" requestBody: diff --git a/connection-coordinator/paths/features.yaml b/connection-coordinator/paths/features.yaml index 15973ce..494d2df 100644 --- a/connection-coordinator/paths/features.yaml +++ b/connection-coordinator/paths/features.yaml @@ -3,6 +3,7 @@ AllFeatures: description: List all features associated with a given connection. operationId: ListFeatures parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -69,6 +70,7 @@ AllFeatures: resource. operationId: CreateFeature parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -104,6 +106,7 @@ OneFeature: description: Delete a specific feature. operationId: DeleteFeature parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -123,6 +126,7 @@ OneFeature: description: Get details about a specific feature. operationId: GetFeature parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" diff --git a/connection-coordinator/paths/interconnects.yaml b/connection-coordinator/paths/interconnects.yaml index 148db9e..9aa5891 100644 --- a/connection-coordinator/paths/interconnects.yaml +++ b/connection-coordinator/paths/interconnects.yaml @@ -3,6 +3,7 @@ AllInterconnects: description: List all interconnects associated with a specified environment. operationId: ListInterconnects parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - description: |- @@ -44,6 +45,7 @@ OneInterconnect: description: Get details about a specific interconnect. operationId: GetInterconnect parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" diff --git a/connection-coordinator/paths/issues.yaml b/connection-coordinator/paths/issues.yaml index 0d5c91f..69a7a61 100644 --- a/connection-coordinator/paths/issues.yaml +++ b/connection-coordinator/paths/issues.yaml @@ -3,6 +3,7 @@ AllIssues: description: Lists Issues in a given project and location. operationId: ListIssues parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - description: 'Optional. The maximum number of issues to return. The service may return fewer than @@ -37,6 +38,7 @@ AllIssues: description: Creates a new Issue in a given project and location. operationId: CreateIssue parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - description: 'Required. The ID to use for the issue, which will become the final component of the issue''s resource name.' @@ -66,6 +68,7 @@ OneIssue: description: Gets details of a single Issue. operationId: GetIssue parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/issue" responses: @@ -83,6 +86,7 @@ CloseIssue: description: Closes an Issue. operationId: CloseIssue parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/issue" requestBody: @@ -106,6 +110,7 @@ AddComment: description: Adds a comment to a Issue. operationId: AddComment parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/issue" requestBody: @@ -129,6 +134,7 @@ ListComments: description: Lists comments for a Issue. operationId: ListComments parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/issue" - description: 'Optional. The maximum number of comments to return. The service diff --git a/connection-coordinator/paths/macseckeys.yaml b/connection-coordinator/paths/macseckeys.yaml index 40ff52e..bb306d3 100644 --- a/connection-coordinator/paths/macseckeys.yaml +++ b/connection-coordinator/paths/macseckeys.yaml @@ -3,6 +3,7 @@ AllMacSecKeys: description: Create a new MACsec key on the channel operationId: CreateMacSecKey parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -42,6 +43,7 @@ AllMacSecKeys: description: List all the MACsec keys associated with the channel operationId: ListMacSecKeys parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -62,6 +64,7 @@ OneMacSecKey: description: Get the specific MACsec key associated with the channel operationId: GetMacSecKey parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" @@ -81,6 +84,7 @@ OneMacSecKey: description: Delete the specific MACsec key associated with the channel operationId: DeleteMacSecKey parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" - $ref: "../parameters/_index.yaml#/parameters/provider" - $ref: "../parameters/_index.yaml#/parameters/environment" - $ref: "../parameters/_index.yaml#/parameters/interconnect" diff --git a/connection-coordinator/paths/providers.yaml b/connection-coordinator/paths/providers.yaml index f96084a..d060302 100644 --- a/connection-coordinator/paths/providers.yaml +++ b/connection-coordinator/paths/providers.yaml @@ -2,6 +2,8 @@ AllProviders: get: description: Get details on a specific provider managed by this server. operationId: ListProviders + parameters: + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" responses: default: content: @@ -17,7 +19,8 @@ OneProvider: description: Get details on a specific provider managed by this server. operationId: GetProvider parameters: - - $ref: "../parameters/_index.yaml#/parameters/provider" + - $ref: "../parameters/_index.yaml#/parameters/x-request-id" + - $ref: "../parameters/_index.yaml#/parameters/provider" responses: default: content: diff --git a/connection-coordinator/schemas/common.yaml b/connection-coordinator/schemas/common.yaml index 3696190..014ae16 100644 --- a/connection-coordinator/schemas/common.yaml +++ b/connection-coordinator/schemas/common.yaml @@ -37,4 +37,4 @@ Empty: description: |- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. - type: object \ No newline at end of file + type: object