From d85d7bff163cb6593e7d83d29c1bb192e15fd240 Mon Sep 17 00:00:00 2001 From: Junbo Wang Date: Mon, 29 Nov 2021 17:42:09 +0800 Subject: [PATCH 1/4] [Azure SignalR Service]changes introduced by new version of Swashbuckle --- .../2021-10-01/examples/Operations_List.json | 6 +- .../stable/2021-10-01/signalr.json | 556 +++++++-------- .../stable/2021-10-01/webpubsub.json | 633 ++++++++++-------- 3 files changed, 632 insertions(+), 563 deletions(-) diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/examples/Operations_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/examples/Operations_List.json index 7d66cc1daea4..6733b1c5df30 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/examples/Operations_List.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/examples/Operations_List.json @@ -7,12 +7,12 @@ "body": { "value": [ { - "name": "Microsoft.SignalRService/WebPubSub/read", + "name": "Microsoft.SignalRService/SignalR/read", "isDataAction": false, "display": { "provider": "Microsoft.SignalRService", - "resource": "WebPubSub", - "operation": "Manage WebPubSub (read-only)", + "resource": "SignalR", + "operation": "Manage SignalR (read-only)", "description": "View the resource settings and configurations in the management portal or through API" }, "properties": {} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/signalr.json index cd201ce763b9..79c19950b8f8 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/signalr.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/signalr.json @@ -1,20 +1,10 @@ { "swagger": "2.0", "info": { - "version": "2021-10-01", "title": "SignalRManagementClient", - "description": "REST API for Azure SignalR Service" + "description": "REST API for Azure SignalR Service", + "version": "2021-10-01" }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], "paths": { "/providers/Microsoft.SignalRService/operations": { "get": { @@ -23,6 +13,9 @@ ], "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.", "operationId": "Operations_List", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -59,28 +52,34 @@ ], "description": "Checks that the resource name is valid and is not already in use.", "operationId": "SignalR_CheckNameAvailability", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "location", "in": "path", + "name": "location", "description": "the region", "required": true, "type": "string" }, { - "name": "parameters", + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "body", + "name": "parameters", "description": "Parameters supplied to the operation.", "required": true, "schema": { "$ref": "#/definitions/NameAvailabilityParameters" } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -111,19 +110,22 @@ ], "description": "List resource usage quotas by location.", "operationId": "Usages_List", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "location", + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { "in": "path", + "name": "location", "description": "the location like \"eastus\"", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -157,12 +159,15 @@ ], "description": "Handles requests to list all resources in a subscription.", "operationId": "SignalR_ListBySubscription", + "produces": [ + "application/json" + ], "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -196,15 +201,18 @@ ], "description": "Handles requests to list all resources in a resource group.", "operationId": "SignalR_ListByResourceGroup", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -238,10 +246,10 @@ ], "description": "Get the resource and its properties.", "operationId": "SignalR_Get", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -250,6 +258,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -278,27 +289,33 @@ ], "description": "Create or update a resource.", "operationId": "SignalR_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "parameters", - "in": "body", - "description": "Parameters for the create or update operation", - "required": true, - "schema": { - "$ref": "#/definitions/SignalRResource" - } + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceName" + "in": "body", + "name": "parameters", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/SignalRResource" + } } ], "responses": { @@ -338,9 +355,6 @@ "description": "Operation to delete a resource.", "operationId": "SignalR_Delete", "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -349,6 +363,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -381,27 +398,33 @@ ], "description": "Operation to update an exiting resource.", "operationId": "SignalR_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "parameters", - "in": "body", - "description": "Parameters for the update operation", - "required": true, - "schema": { - "$ref": "#/definitions/SignalRResource" - } + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceName" + "in": "body", + "name": "parameters", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/SignalRResource" + } } ], "responses": { @@ -436,10 +459,10 @@ ], "description": "Get the access keys of the resource.", "operationId": "SignalR_ListKeys", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -448,6 +471,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -478,10 +504,10 @@ ], "description": "List private endpoint connections", "operationId": "SignalRPrivateEndpointConnections_List", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -490,6 +516,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -523,25 +552,28 @@ ], "description": "Get the specified private endpoint connection", "operationId": "SignalRPrivateEndpointConnections_Get", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "The name of the private endpoint connection", - "required": true, - "type": "string" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "in": "path", + "name": "privateEndpointConnectionName", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -570,34 +602,40 @@ ], "description": "Update the state of specified private endpoint connection", "operationId": "SignalRPrivateEndpointConnections_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "privateEndpointConnectionName", + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { "in": "path", + "name": "privateEndpointConnectionName", "description": "The name of the private endpoint connection", "required": true, "type": "string" }, { - "name": "parameters", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "body", + "name": "parameters", "description": "The resource of private endpoint and its properties", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -628,23 +666,23 @@ "operationId": "SignalRPrivateEndpointConnections_Delete", "parameters": [ { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "The name of the private endpoint connection", - "required": true, - "type": "string" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "in": "path", + "name": "privateEndpointConnectionName", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -679,10 +717,10 @@ ], "description": "Get the private link resources that need to be created for a resource.", "operationId": "SignalRPrivateLinkResources_List", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -691,6 +729,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -724,27 +765,33 @@ ], "description": "Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", "operationId": "SignalR_RegenerateKey", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "parameters", - "in": "body", - "description": "Parameter that describes the Regenerate Key Operation.", - "required": true, - "schema": { - "$ref": "#/definitions/RegenerateKeyParameters" - } + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceName" + "in": "body", + "name": "parameters", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } } ], "responses": { @@ -780,9 +827,6 @@ "description": "Operation to restart a resource.", "operationId": "SignalR_Restart", "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -791,6 +835,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -825,10 +872,10 @@ ], "description": "List shared private link resources", "operationId": "SignalRSharedPrivateLinkResources_List", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -837,6 +884,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -870,25 +920,28 @@ ], "description": "Get the specified shared private link resource", "operationId": "SignalRSharedPrivateLinkResources_Get", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "sharedPrivateLinkResourceName", - "in": "path", - "description": "The name of the shared private link resource", - "required": true, - "type": "string" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "in": "path", + "name": "sharedPrivateLinkResourceName", + "description": "The name of the shared private link resource", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -917,34 +970,40 @@ ], "description": "Create or update a shared private link resource", "operationId": "SignalRSharedPrivateLinkResources_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "sharedPrivateLinkResourceName", + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { "in": "path", + "name": "sharedPrivateLinkResourceName", "description": "The name of the shared private link resource", "required": true, "type": "string" }, { - "name": "parameters", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "body", + "name": "parameters", "description": "The shared private link resource", "required": true, "schema": { "$ref": "#/definitions/SharedPrivateLinkResource" } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -982,23 +1041,23 @@ "operationId": "SignalRSharedPrivateLinkResources_Delete", "parameters": [ { - "name": "sharedPrivateLinkResourceName", - "in": "path", - "description": "The name of the shared private link resource", - "required": true, - "type": "string" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "in": "path", + "name": "sharedPrivateLinkResourceName", + "description": "The name of the shared private link resource", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1033,10 +1092,10 @@ ], "description": "List all available skus of the resource.", "operationId": "SignalR_ListSkus", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -1045,6 +1104,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1071,7 +1133,7 @@ }, "definitions": { "ACLAction": { - "description": "Default action when no other rule matches", + "description": "Azure Networking ACL Action.", "enum": [ "Allow", "Deny" @@ -1119,7 +1181,7 @@ } }, "KeyType": { - "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).", + "description": "The type of access key.", "enum": [ "Primary", "Secondary", @@ -1150,8 +1212,7 @@ "type": "object", "properties": { "type": { - "$ref": "#/definitions/ManagedIdentityType", - "description": "Represent the identity type: systemAssigned, userAssigned, None" + "$ref": "#/definitions/ManagedIdentityType" }, "userAssignedIdentities": { "description": "Get or set the user assigned identities", @@ -1183,7 +1244,7 @@ } }, "ManagedIdentityType": { - "description": "Represent the identity type: systemAssigned, userAssigned, None", + "description": "Represents the identity type: systemAssigned, userAssigned, None", "enum": [ "None", "SystemAssigned", @@ -1257,8 +1318,8 @@ "NameAvailabilityParameters": { "description": "Data POST-ed to the nameAvailability action", "required": [ - "type", - "name" + "name", + "type" ], "type": "object", "properties": { @@ -1305,17 +1366,15 @@ "type": "boolean" }, "display": { - "$ref": "#/definitions/OperationDisplay", - "description": "The object that describes the operation." + "$ref": "#/definitions/OperationDisplay" }, "origin": { "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", "type": "string" }, "properties": { - "$ref": "#/definitions/OperationProperties", - "description": "Extra properties for the operation.", - "x-ms-client-flatten": false + "x-ms-client-flatten": false, + "$ref": "#/definitions/OperationProperties" } } }, @@ -1363,8 +1422,7 @@ "type": "object", "properties": { "serviceSpecification": { - "$ref": "#/definitions/ServiceSpecification", - "description": "The service specifications." + "$ref": "#/definitions/ServiceSpecification" } } }, @@ -1406,14 +1464,12 @@ ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "description": "Metadata pertaining to creation and last modification of the resource.", - "readOnly": true + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" }, "properties": { - "$ref": "#/definitions/PrivateEndpointConnectionProperties", - "description": "Properties of the private endpoint connection", - "x-ms-client-flatten": true + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointConnectionProperties" } } }, @@ -1439,13 +1495,11 @@ "type": "object", "properties": { "provisioningState": { - "$ref": "#/definitions/ProvisioningState", - "description": "Provisioning state of the private endpoint connection", - "readOnly": true + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" }, "privateEndpoint": { - "$ref": "#/definitions/PrivateEndpoint", - "description": "Private endpoint associated with the private endpoint connection" + "$ref": "#/definitions/PrivateEndpoint" }, "groupIds": { "description": "Group IDs", @@ -1456,8 +1510,7 @@ "readOnly": true }, "privateLinkServiceConnectionState": { - "$ref": "#/definitions/PrivateLinkServiceConnectionState", - "description": "Connection state" + "$ref": "#/definitions/PrivateLinkServiceConnectionState" } } }, @@ -1471,9 +1524,8 @@ ], "properties": { "properties": { - "$ref": "#/definitions/PrivateLinkResourceProperties", - "description": "Properties of a private link resource", - "x-ms-client-flatten": true + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkResourceProperties" } } }, @@ -1530,8 +1582,7 @@ "type": "object", "properties": { "status": { - "$ref": "#/definitions/PrivateLinkServiceConnectionStatus", - "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + "$ref": "#/definitions/PrivateLinkServiceConnectionStatus" }, "description": { "description": "The reason for approval/rejection of the connection.", @@ -1583,16 +1634,14 @@ { "$ref": "#/definitions/Resource" } - ], - "properties": {} + ] }, "RegenerateKeyParameters": { "description": "Parameters describes the request to regenerate access keys", "type": "object", "properties": { "keyType": { - "$ref": "#/definitions/KeyType", - "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive)." + "$ref": "#/definitions/KeyType" } } }, @@ -1657,8 +1706,7 @@ "type": "string" }, "tier": { - "$ref": "#/definitions/SignalRSkuTier", - "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead." + "$ref": "#/definitions/SignalRSkuTier" }, "size": { "description": "Not used. Retained for future use.", @@ -1704,7 +1752,7 @@ } }, "ServiceKind": { - "description": "The kind of the service - e.g. \"SignalR\" for \"Microsoft.SignalRService/SignalR\"", + "description": "The kind of the service, it can be SignalR or RawWebSockets", "enum": [ "SignalR", "RawWebSockets" @@ -1762,8 +1810,7 @@ "type": "string" }, "properties": { - "$ref": "#/definitions/ShareablePrivateLinkResourceProperties", - "description": "Describes the properties of a resource type that has been onboarded to private link service" + "$ref": "#/definitions/ShareablePrivateLinkResourceProperties" } } }, @@ -1777,14 +1824,12 @@ ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "description": "Metadata pertaining to creation and last modification of the resource.", - "readOnly": true + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" }, "properties": { - "$ref": "#/definitions/SharedPrivateLinkResourceProperties", - "description": "Describes the properties of a Shared Private Link Resource", - "x-ms-client-flatten": true + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedPrivateLinkResourceProperties" } } }, @@ -1822,18 +1867,16 @@ "type": "string" }, "provisioningState": { - "$ref": "#/definitions/ProvisioningState", - "description": "Provisioning state of the shared private link resource", - "readOnly": true + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" }, "requestMessage": { "description": "The request message for requesting approval of the shared private link resource", "type": "string" }, "status": { - "$ref": "#/definitions/SharedPrivateLinkResourceStatus", - "description": "Status of the shared private link resource", - "readOnly": true + "readOnly": true, + "$ref": "#/definitions/SharedPrivateLinkResourceStatus" } } }, @@ -1874,8 +1917,7 @@ "type": "object", "properties": { "flag": { - "$ref": "#/definitions/FeatureFlags", - "description": "FeatureFlags is the supported features of Azure SignalR service.\r\n- ServiceMode: Flag for backend server for SignalR service. Values allowed: \"Default\": have your own backend server; \"Serverless\": your application doesn't have a backend server; \"Classic\": for backward compatibility. Support both Default and Serverless mode but not recommended; \"PredefinedOnly\": for future use.\r\n- EnableConnectivityLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.\r\n- EnableMessagingLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.\r\n- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: \"true\"/\"false\", to enable/disable live trace feature." + "$ref": "#/definitions/FeatureFlags" }, "value": { "description": "Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.", @@ -1939,13 +1981,10 @@ "type": "object", "properties": { "defaultAction": { - "$ref": "#/definitions/ACLAction", - "description": "Default action when no other rule matches", - "default": "Deny" + "$ref": "#/definitions/ACLAction" }, "publicNetwork": { - "$ref": "#/definitions/NetworkACL", - "description": "ACL for requests from public network" + "$ref": "#/definitions/NetworkACL" }, "privateEndpoints": { "description": "ACLs for requests from private endpoints", @@ -1961,9 +2000,8 @@ "type": "object", "properties": { "provisioningState": { - "$ref": "#/definitions/ProvisioningState", - "description": "Provisioning state of the resource.", - "readOnly": true + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" }, "externalIP": { "description": "The publicly accessible IP of the resource.", @@ -2009,8 +2047,7 @@ "readOnly": true }, "tls": { - "$ref": "#/definitions/SignalRTlsSettings", - "description": "TLS settings." + "$ref": "#/definitions/SignalRTlsSettings" }, "hostNamePrefix": { "description": "Deprecated.", @@ -2025,20 +2062,16 @@ } }, "resourceLogConfiguration": { - "$ref": "#/definitions/ResourceLogConfiguration", - "description": "Resource log configuration of a Microsoft.SignalRService resource.\r\nIf resourceLogConfiguration isn't null or empty, it will override options \"EnableConnectivityLog\" and \"EnableMessagingLogs\" in features.\r\nOtherwise, use options \"EnableConnectivityLog\" and \"EnableMessagingLogs\" in features." + "$ref": "#/definitions/ResourceLogConfiguration" }, "cors": { - "$ref": "#/definitions/SignalRCorsSettings", - "description": "Cross-Origin Resource Sharing (CORS) settings." + "$ref": "#/definitions/SignalRCorsSettings" }, "upstream": { - "$ref": "#/definitions/ServerlessUpstreamSettings", - "description": "Upstream settings when the service is in server-less mode." + "$ref": "#/definitions/ServerlessUpstreamSettings" }, "networkACLs": { - "$ref": "#/definitions/SignalRNetworkACLs", - "description": "Network ACLs" + "$ref": "#/definitions/SignalRNetworkACLs" }, "publicNetworkAccess": { "description": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.", @@ -2047,18 +2080,16 @@ }, "disableLocalAuth": { "description": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work.", - "default": false, "type": "boolean" }, "disableAadAuth": { "description": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work.", - "default": false, "type": "boolean" } } }, "SignalRRequestType": { - "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "description": "The incoming request type to the service", "enum": [ "ClientConnection", "ServerConnection", @@ -2081,30 +2112,25 @@ ], "properties": { "sku": { - "$ref": "#/definitions/ResourceSku", - "description": "The billing information of the resource.(e.g. Free, Standard)" + "$ref": "#/definitions/ResourceSku" }, "properties": { - "$ref": "#/definitions/SignalRProperties", - "description": "Settings used to provision or configure the resource", - "x-ms-client-flatten": true + "x-ms-client-flatten": true, + "$ref": "#/definitions/SignalRProperties" }, "kind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of the service - e.g. \"SignalR\" for \"Microsoft.SignalRService/SignalR\"", "x-ms-mutability": [ "read", "create" - ] + ], + "$ref": "#/definitions/ServiceKind" }, "identity": { - "$ref": "#/definitions/ManagedIdentity", - "description": "The managed identity response" + "$ref": "#/definitions/ManagedIdentity" }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "description": "Metadata pertaining to creation and last modification of the resource.", - "readOnly": true + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" } } }, @@ -2145,7 +2171,6 @@ "properties": { "clientCertEnabled": { "description": "Request client certificate during TLS handshake if enabled", - "default": true, "type": "boolean" } } @@ -2169,8 +2194,7 @@ "type": "integer" }, "name": { - "$ref": "#/definitions/SignalRUsageName", - "description": "Localizable String object containing the name and a localized value." + "$ref": "#/definitions/SignalRUsageName" }, "unit": { "description": "Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.", @@ -2219,14 +2243,12 @@ "readOnly": true }, "sku": { - "$ref": "#/definitions/ResourceSku", - "description": "The exact set of keys that define this sku.", - "readOnly": true + "readOnly": true, + "$ref": "#/definitions/ResourceSku" }, "capacity": { - "$ref": "#/definitions/SkuCapacity", - "description": "Specifies the unit of the resource.", - "readOnly": true + "readOnly": true, + "$ref": "#/definitions/SkuCapacity" } } }, @@ -2262,9 +2284,8 @@ "readOnly": true }, "scaleType": { - "$ref": "#/definitions/ScaleType", - "description": "The scale type applicable to the sku.", - "readOnly": true + "readOnly": true, + "$ref": "#/definitions/ScaleType" } } }, @@ -2314,21 +2335,19 @@ } }, "UpstreamAuthSettings": { - "description": "Upstream auth settings.", + "description": "Upstream auth settings. If not set, no auth is used for upstream messages.", "type": "object", "properties": { "type": { - "$ref": "#/definitions/UpstreamAuthType", - "description": "Gets or sets the type of auth. None or ManagedIdentity is supported now." + "$ref": "#/definitions/UpstreamAuthType" }, "managedIdentity": { - "$ref": "#/definitions/ManagedIdentitySettings", - "description": "Gets or sets the managed identity settings. It's required if the auth type is set to ManagedIdentity." + "$ref": "#/definitions/ManagedIdentitySettings" } } }, "UpstreamAuthType": { - "description": "Gets or sets the type of auth. None or ManagedIdentity is supported now.", + "description": "Upstream auth type enum.", "enum": [ "None", "ManagedIdentity" @@ -2363,8 +2382,7 @@ "type": "string" }, "auth": { - "$ref": "#/definitions/UpstreamAuthSettings", - "description": "Gets or sets the auth settings for an upstream. If not set, no auth is used for upstream messages." + "$ref": "#/definitions/UpstreamAuthSettings" } } }, @@ -2387,30 +2405,30 @@ }, "parameters": { "ApiVersionParameter": { - "name": "api-version", "in": "query", + "name": "api-version", "description": "Client Api Version.", "required": true, "type": "string" }, "SubscriptionIdParameter": { - "name": "subscriptionId", "in": "path", + "name": "subscriptionId", "description": "Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", "required": true, "type": "string" }, "ResourceGroupParameter": { - "name": "resourceGroupName", "in": "path", + "name": "resourceGroupName", "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "ResourceName": { - "name": "resourceName", "in": "path", + "name": "resourceName", "description": "The name of the resource.", "required": true, "type": "string", @@ -2419,12 +2437,12 @@ }, "securityDefinitions": { "azure_auth": { + "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" }, - "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow" } }, @@ -2434,5 +2452,15 @@ "user_impersonation" ] } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" ] } diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json index e0ecfab89d57..32b23907c10a 100644 --- a/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json @@ -1,20 +1,10 @@ { "swagger": "2.0", "info": { - "version": "2021-10-01", "title": "WebPubSubManagementClient", - "description": "REST API for Azure WebPubSub Service" + "description": "REST API for Azure WebPubSub Service", + "version": "2021-10-01" }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], "paths": { "/providers/Microsoft.SignalRService/operations": { "get": { @@ -23,6 +13,9 @@ ], "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.", "operationId": "Operations_List", + "produces": [ + "application/json" + ], "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -59,28 +52,34 @@ ], "description": "Checks that the resource name is valid and is not already in use.", "operationId": "WebPubSub_CheckNameAvailability", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "location", "in": "path", + "name": "location", "description": "the region", "required": true, "type": "string" }, { - "name": "parameters", + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "body", + "name": "parameters", "description": "Parameters supplied to the operation.", "required": true, "schema": { "$ref": "#/definitions/NameAvailabilityParameters" } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -111,19 +110,22 @@ ], "description": "List resource usage quotas by location.", "operationId": "Usages_List", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "location", + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { "in": "path", + "name": "location", "description": "the location like \"eastus\"", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -157,12 +159,15 @@ ], "description": "Handles requests to list all resources in a subscription.", "operationId": "WebPubSub_ListBySubscription", + "produces": [ + "application/json" + ], "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -196,15 +201,18 @@ ], "description": "Handles requests to list all resources in a resource group.", "operationId": "WebPubSub_ListByResourceGroup", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -238,10 +246,10 @@ ], "description": "Get the resource and its properties.", "operationId": "WebPubSub_Get", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -250,6 +258,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -278,27 +289,33 @@ ], "description": "Create or update a resource.", "operationId": "WebPubSub_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "parameters", - "in": "body", - "description": "Parameters for the create or update operation", - "required": true, - "schema": { - "$ref": "#/definitions/WebPubSubResource" - } + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceName" + "in": "body", + "name": "parameters", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } } ], "responses": { @@ -338,9 +355,6 @@ "description": "Operation to delete a resource.", "operationId": "WebPubSub_Delete", "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -349,6 +363,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -381,27 +398,33 @@ ], "description": "Operation to update an exiting resource.", "operationId": "WebPubSub_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "parameters", - "in": "body", - "description": "Parameters for the update operation", - "required": true, - "schema": { - "$ref": "#/definitions/WebPubSubResource" - } + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceName" + "in": "body", + "name": "parameters", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } } ], "responses": { @@ -436,10 +459,10 @@ ], "description": "List hub settings.", "operationId": "WebPubSubHubs_List", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -448,6 +471,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -481,25 +507,28 @@ ], "description": "Get a hub setting.", "operationId": "WebPubSubHubs_Get", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "hubName", - "in": "path", - "description": "The hub name.", - "required": true, - "type": "string" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "in": "path", + "name": "hubName", + "description": "The hub name.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -528,34 +557,40 @@ ], "description": "Create or update a hub setting.", "operationId": "WebPubSubHubs_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "hubName", + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { "in": "path", + "name": "hubName", "description": "The hub name.", "required": true, "type": "string" }, { - "name": "parameters", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "body", + "name": "parameters", "description": "The resource of WebPubSubHub and its properties", "required": true, "schema": { "$ref": "#/definitions/WebPubSubHub" } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -593,23 +628,23 @@ "operationId": "WebPubSubHubs_Delete", "parameters": [ { - "name": "hubName", - "in": "path", - "description": "The hub name.", - "required": true, - "type": "string" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "in": "path", + "name": "hubName", + "description": "The hub name.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -644,10 +679,10 @@ ], "description": "Get the access keys of the resource.", "operationId": "WebPubSub_ListKeys", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -656,6 +691,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -686,10 +724,10 @@ ], "description": "List private endpoint connections", "operationId": "WebPubSubPrivateEndpointConnections_List", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -698,6 +736,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -731,25 +772,28 @@ ], "description": "Get the specified private endpoint connection", "operationId": "WebPubSubPrivateEndpointConnections_Get", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "The name of the private endpoint connection", - "required": true, - "type": "string" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "in": "path", + "name": "privateEndpointConnectionName", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -778,34 +822,40 @@ ], "description": "Update the state of specified private endpoint connection", "operationId": "WebPubSubPrivateEndpointConnections_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "privateEndpointConnectionName", + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { "in": "path", + "name": "privateEndpointConnectionName", "description": "The name of the private endpoint connection", "required": true, "type": "string" }, { - "name": "parameters", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "body", + "name": "parameters", "description": "The resource of private endpoint and its properties", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -836,23 +886,23 @@ "operationId": "WebPubSubPrivateEndpointConnections_Delete", "parameters": [ { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "The name of the private endpoint connection", - "required": true, - "type": "string" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "in": "path", + "name": "privateEndpointConnectionName", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -887,10 +937,10 @@ ], "description": "Get the private link resources that need to be created for a resource.", "operationId": "WebPubSubPrivateLinkResources_List", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -899,6 +949,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -932,27 +985,33 @@ ], "description": "Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", "operationId": "WebPubSub_RegenerateKey", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "parameters", - "in": "body", - "description": "Parameter that describes the Regenerate Key Operation.", - "required": true, - "schema": { - "$ref": "#/definitions/RegenerateKeyParameters" - } + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceName" + "in": "body", + "name": "parameters", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } } ], "responses": { @@ -988,9 +1047,6 @@ "description": "Operation to restart a resource.", "operationId": "WebPubSub_Restart", "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -999,6 +1055,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1033,10 +1092,10 @@ ], "description": "List shared private link resources", "operationId": "WebPubSubSharedPrivateLinkResources_List", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -1045,6 +1104,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1078,25 +1140,28 @@ ], "description": "Get the specified shared private link resource", "operationId": "WebPubSubSharedPrivateLinkResources_Get", + "produces": [ + "application/json" + ], "parameters": [ { - "name": "sharedPrivateLinkResourceName", - "in": "path", - "description": "The name of the shared private link resource", - "required": true, - "type": "string" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "in": "path", + "name": "sharedPrivateLinkResourceName", + "description": "The name of the shared private link resource", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1125,34 +1190,40 @@ ], "description": "Create or update a shared private link resource", "operationId": "WebPubSubSharedPrivateLinkResources_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "parameters": [ { - "name": "sharedPrivateLinkResourceName", + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { "in": "path", + "name": "sharedPrivateLinkResourceName", "description": "The name of the shared private link resource", "required": true, "type": "string" }, { - "name": "parameters", + "$ref": "#/parameters/ApiVersionParameter" + }, + { "in": "body", + "name": "parameters", "description": "The shared private link resource", "required": true, "schema": { "$ref": "#/definitions/SharedPrivateLinkResource" } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -1190,23 +1261,23 @@ "operationId": "WebPubSubSharedPrivateLinkResources_Delete", "parameters": [ { - "name": "sharedPrivateLinkResourceName", - "in": "path", - "description": "The name of the shared private link resource", - "required": true, - "type": "string" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ResourceName" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "in": "path", + "name": "sharedPrivateLinkResourceName", + "description": "The name of the shared private link resource", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1241,10 +1312,10 @@ ], "description": "List all available skus of the resource.", "operationId": "WebPubSub_ListSkus", + "produces": [ + "application/json" + ], "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -1253,6 +1324,9 @@ }, { "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1279,7 +1353,7 @@ }, "definitions": { "ACLAction": { - "description": "Default action when no other rule matches", + "description": "Azure Networking ACL Action.", "enum": [ "Allow", "Deny" @@ -1335,13 +1409,12 @@ } }, "auth": { - "$ref": "#/definitions/UpstreamAuthSettings", - "description": "Gets or sets the auth settings for an event handler. If not set, no auth is used." + "$ref": "#/definitions/UpstreamAuthSettings" } } }, "KeyType": { - "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).", + "description": "The type of access key.", "enum": [ "Primary", "Secondary", @@ -1404,8 +1477,7 @@ "type": "object", "properties": { "type": { - "$ref": "#/definitions/ManagedIdentityType", - "description": "Represent the identity type: systemAssigned, userAssigned, None" + "$ref": "#/definitions/ManagedIdentityType" }, "userAssignedIdentities": { "description": "Get or set the user assigned identities", @@ -1437,7 +1509,7 @@ } }, "ManagedIdentityType": { - "description": "Represent the identity type: systemAssigned, userAssigned, None", + "description": "Represents the identity type: systemAssigned, userAssigned, None", "enum": [ "None", "SystemAssigned", @@ -1511,8 +1583,8 @@ "NameAvailabilityParameters": { "description": "Data POST-ed to the nameAvailability action", "required": [ - "type", - "name" + "name", + "type" ], "type": "object", "properties": { @@ -1559,17 +1631,15 @@ "type": "boolean" }, "display": { - "$ref": "#/definitions/OperationDisplay", - "description": "The object that describes the operation." + "$ref": "#/definitions/OperationDisplay" }, "origin": { "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", "type": "string" }, "properties": { - "$ref": "#/definitions/OperationProperties", - "description": "Extra properties for the operation.", - "x-ms-client-flatten": false + "x-ms-client-flatten": false, + "$ref": "#/definitions/OperationProperties" } } }, @@ -1617,8 +1687,7 @@ "type": "object", "properties": { "serviceSpecification": { - "$ref": "#/definitions/ServiceSpecification", - "description": "The service specifications." + "$ref": "#/definitions/ServiceSpecification" } } }, @@ -1660,14 +1729,12 @@ ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "description": "Metadata pertaining to creation and last modification of the resource.", - "readOnly": true + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" }, "properties": { - "$ref": "#/definitions/PrivateEndpointConnectionProperties", - "description": "Properties of the private endpoint connection", - "x-ms-client-flatten": true + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointConnectionProperties" } } }, @@ -1693,13 +1760,11 @@ "type": "object", "properties": { "provisioningState": { - "$ref": "#/definitions/ProvisioningState", - "description": "Provisioning state of the private endpoint connection", - "readOnly": true + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" }, "privateEndpoint": { - "$ref": "#/definitions/PrivateEndpoint", - "description": "Private endpoint associated with the private endpoint connection" + "$ref": "#/definitions/PrivateEndpoint" }, "groupIds": { "description": "Group IDs", @@ -1710,8 +1775,7 @@ "readOnly": true }, "privateLinkServiceConnectionState": { - "$ref": "#/definitions/PrivateLinkServiceConnectionState", - "description": "Connection state" + "$ref": "#/definitions/PrivateLinkServiceConnectionState" } } }, @@ -1725,9 +1789,8 @@ ], "properties": { "properties": { - "$ref": "#/definitions/PrivateLinkResourceProperties", - "description": "Properties of a private link resource", - "x-ms-client-flatten": true + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkResourceProperties" } } }, @@ -1784,8 +1847,7 @@ "type": "object", "properties": { "status": { - "$ref": "#/definitions/PrivateLinkServiceConnectionStatus", - "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + "$ref": "#/definitions/PrivateLinkServiceConnectionStatus" }, "description": { "description": "The reason for approval/rejection of the connection.", @@ -1837,16 +1899,14 @@ { "$ref": "#/definitions/Resource" } - ], - "properties": {} + ] }, "RegenerateKeyParameters": { "description": "Parameters describes the request to regenerate access keys", "type": "object", "properties": { "keyType": { - "$ref": "#/definitions/KeyType", - "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive)." + "$ref": "#/definitions/KeyType" } } }, @@ -1911,8 +1971,7 @@ "type": "string" }, "tier": { - "$ref": "#/definitions/WebPubSubSkuTier", - "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead." + "$ref": "#/definitions/WebPubSubSkuTier" }, "size": { "description": "Not used. Retained for future use.", @@ -1991,8 +2050,7 @@ "type": "string" }, "properties": { - "$ref": "#/definitions/ShareablePrivateLinkResourceProperties", - "description": "Describes the properties of a resource type that has been onboarded to private link service" + "$ref": "#/definitions/ShareablePrivateLinkResourceProperties" } } }, @@ -2006,14 +2064,12 @@ ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "description": "Metadata pertaining to creation and last modification of the resource.", - "readOnly": true + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" }, "properties": { - "$ref": "#/definitions/SharedPrivateLinkResourceProperties", - "description": "Describes the properties of a Shared Private Link Resource", - "x-ms-client-flatten": true + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedPrivateLinkResourceProperties" } } }, @@ -2051,18 +2107,16 @@ "type": "string" }, "provisioningState": { - "$ref": "#/definitions/ProvisioningState", - "description": "Provisioning state of the shared private link resource", - "readOnly": true + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" }, "requestMessage": { "description": "The request message for requesting approval of the shared private link resource", "type": "string" }, "status": { - "$ref": "#/definitions/SharedPrivateLinkResourceStatus", - "description": "Status of the shared private link resource", - "readOnly": true + "readOnly": true, + "$ref": "#/definitions/SharedPrivateLinkResourceStatus" } } }, @@ -2100,8 +2154,7 @@ "type": "integer" }, "name": { - "$ref": "#/definitions/SignalRServiceUsageName", - "description": "Localizable String object containing the name and a localized value." + "$ref": "#/definitions/SignalRServiceUsageName" }, "unit": { "description": "Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.", @@ -2150,14 +2203,12 @@ "readOnly": true }, "sku": { - "$ref": "#/definitions/ResourceSku", - "description": "The exact set of keys that define this sku.", - "readOnly": true + "readOnly": true, + "$ref": "#/definitions/ResourceSku" }, "capacity": { - "$ref": "#/definitions/SkuCapacity", - "description": "Specifies the unit of the resource.", - "readOnly": true + "readOnly": true, + "$ref": "#/definitions/SkuCapacity" } } }, @@ -2193,9 +2244,8 @@ "readOnly": true }, "scaleType": { - "$ref": "#/definitions/ScaleType", - "description": "The scale type applicable to the sku.", - "readOnly": true + "readOnly": true, + "$ref": "#/definitions/ScaleType" } } }, @@ -2245,21 +2295,19 @@ } }, "UpstreamAuthSettings": { - "description": "Upstream auth settings.", + "description": "Upstream auth settings. If not set, no auth is used for upstream messages.", "type": "object", "properties": { "type": { - "$ref": "#/definitions/UpstreamAuthType", - "description": "Gets or sets the type of auth. None or ManagedIdentity is supported now." + "$ref": "#/definitions/UpstreamAuthType" }, "managedIdentity": { - "$ref": "#/definitions/ManagedIdentitySettings", - "description": "Gets or sets the managed identity settings. It's required if the auth type is set to ManagedIdentity." + "$ref": "#/definitions/ManagedIdentitySettings" } } }, "UpstreamAuthType": { - "description": "Gets or sets the type of auth. None or ManagedIdentity is supported now.", + "description": "Upstream auth type enum.", "enum": [ "None", "ManagedIdentity" @@ -2299,13 +2347,11 @@ ], "properties": { "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "description": "Metadata pertaining to creation and last modification of the resource.", - "readOnly": true + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" }, "properties": { - "$ref": "#/definitions/WebPubSubHubProperties", - "description": "Properties of the hub setting." + "$ref": "#/definitions/WebPubSubHubProperties" } } }, @@ -2392,13 +2438,10 @@ "type": "object", "properties": { "defaultAction": { - "$ref": "#/definitions/ACLAction", - "description": "Default action when no other rule matches", - "default": "Deny" + "$ref": "#/definitions/ACLAction" }, "publicNetwork": { - "$ref": "#/definitions/NetworkACL", - "description": "ACL for requests from public network" + "$ref": "#/definitions/NetworkACL" }, "privateEndpoints": { "description": "ACLs for requests from private endpoints", @@ -2414,9 +2457,8 @@ "type": "object", "properties": { "provisioningState": { - "$ref": "#/definitions/ProvisioningState", - "description": "Provisioning state of the resource.", - "readOnly": true + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" }, "externalIP": { "description": "The publicly accessible IP of the resource.", @@ -2462,8 +2504,7 @@ "readOnly": true }, "tls": { - "$ref": "#/definitions/WebPubSubTlsSettings", - "description": "TLS settings." + "$ref": "#/definitions/WebPubSubTlsSettings" }, "hostNamePrefix": { "description": "Deprecated.", @@ -2471,16 +2512,13 @@ "readOnly": true }, "liveTraceConfiguration": { - "$ref": "#/definitions/LiveTraceConfiguration", - "description": "Live trace configuration of a Microsoft.SignalRService resource." + "$ref": "#/definitions/LiveTraceConfiguration" }, "resourceLogConfiguration": { - "$ref": "#/definitions/ResourceLogConfiguration", - "description": "Resource log configuration of a Microsoft.SignalRService resource.\r\nIf resourceLogConfiguration isn't null or empty, it will override options \"EnableConnectivityLog\" and \"EnableMessagingLogs\" in features.\r\nOtherwise, use options \"EnableConnectivityLog\" and \"EnableMessagingLogs\" in features." + "$ref": "#/definitions/ResourceLogConfiguration" }, "networkACLs": { - "$ref": "#/definitions/WebPubSubNetworkACLs", - "description": "Network ACLs" + "$ref": "#/definitions/WebPubSubNetworkACLs" }, "publicNetworkAccess": { "description": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.", @@ -2489,18 +2527,16 @@ }, "disableLocalAuth": { "description": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work.", - "default": false, "type": "boolean" }, "disableAadAuth": { "description": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work.", - "default": false, "type": "boolean" } } }, "WebPubSubRequestType": { - "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "description": "The incoming request type to the service", "enum": [ "ClientConnection", "ServerConnection", @@ -2523,22 +2559,18 @@ ], "properties": { "sku": { - "$ref": "#/definitions/ResourceSku", - "description": "The billing information of the resource.(e.g. Free, Standard)" + "$ref": "#/definitions/ResourceSku" }, "properties": { - "$ref": "#/definitions/WebPubSubProperties", - "description": "Settings used to provision or configure the resource", - "x-ms-client-flatten": true + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebPubSubProperties" }, "identity": { - "$ref": "#/definitions/ManagedIdentity", - "description": "The managed identity response" + "$ref": "#/definitions/ManagedIdentity" }, "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "description": "Metadata pertaining to creation and last modification of the resource.", - "readOnly": true + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" } } }, @@ -2579,7 +2611,6 @@ "properties": { "clientCertEnabled": { "description": "Request client certificate during TLS handshake if enabled", - "default": true, "type": "boolean" } } @@ -2587,30 +2618,30 @@ }, "parameters": { "ApiVersionParameter": { - "name": "api-version", "in": "query", + "name": "api-version", "description": "Client Api Version.", "required": true, "type": "string" }, "SubscriptionIdParameter": { - "name": "subscriptionId", "in": "path", + "name": "subscriptionId", "description": "Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", "required": true, "type": "string" }, "ResourceGroupParameter": { - "name": "resourceGroupName", "in": "path", + "name": "resourceGroupName", "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "ResourceName": { - "name": "resourceName", "in": "path", + "name": "resourceName", "description": "The name of the resource.", "required": true, "type": "string", @@ -2619,12 +2650,12 @@ }, "securityDefinitions": { "azure_auth": { + "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" }, - "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow" } }, @@ -2634,5 +2665,15 @@ "user_impersonation" ] } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" ] } From fd89b8b6330595a582fbca236e53822a0dde3afc Mon Sep 17 00:00:00 2001 From: Junbo Wang Date: Mon, 29 Nov 2021 18:56:04 +0800 Subject: [PATCH 2/4] add back default value --- .vscode/settings.json | 6 ++++++ .../Microsoft.SignalRService/stable/2021-10-01/signalr.json | 3 +++ .../stable/2021-10-01/webpubsub.json | 3 +++ 3 files changed, 12 insertions(+) diff --git a/.vscode/settings.json b/.vscode/settings.json index 76eab4509993..cbbd0ee052f3 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -23,5 +23,11 @@ "typescript.tsdk": "node_modules\\typescript\\lib", "[json]": { "editor.defaultFormatter": "esbenp.prettier-vscode" + }, + "markdownlint.config": { + "MD028": false, + "MD025": { + "front_matter_title": "" + } } } diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/signalr.json index 79c19950b8f8..86965330f93f 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/signalr.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/signalr.json @@ -2080,10 +2080,12 @@ }, "disableLocalAuth": { "description": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work.", + "default": false, "type": "boolean" }, "disableAadAuth": { "description": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work.", + "default": false, "type": "boolean" } } @@ -2171,6 +2173,7 @@ "properties": { "clientCertEnabled": { "description": "Request client certificate during TLS handshake if enabled", + "default": true, "type": "boolean" } } diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json index 32b23907c10a..49ac24a22e6f 100644 --- a/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json @@ -2527,10 +2527,12 @@ }, "disableLocalAuth": { "description": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work.", + "default": false, "type": "boolean" }, "disableAadAuth": { "description": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work.", + "default": false, "type": "boolean" } } @@ -2611,6 +2613,7 @@ "properties": { "clientCertEnabled": { "description": "Request client certificate during TLS handshake if enabled", + "default": true, "type": "boolean" } } From 8d115a81985ed6b4956aafff15e2722071d805af Mon Sep 17 00:00:00 2001 From: Junbo Wang Date: Tue, 30 Nov 2021 14:08:38 +0800 Subject: [PATCH 3/4] revert parameter orders --- .../stable/2021-10-01/signalr.json | 280 +++++++------- .../signalr/resource-manager/readme.md | 9 + .../stable/2021-10-01/webpubsub.json | 349 ++++++++---------- .../webpubsub/resource-manager/readme.md | 12 + 4 files changed, 316 insertions(+), 334 deletions(-) diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/signalr.json index 86965330f93f..2e2df3d8edab 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/signalr.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/signalr.json @@ -52,9 +52,6 @@ ], "description": "Checks that the resource name is valid and is not already in use.", "operationId": "SignalR_CheckNameAvailability", - "consumes": [ - "application/json" - ], "produces": [ "application/json" ], @@ -66,12 +63,6 @@ "required": true, "type": "string" }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "in": "body", "name": "parameters", @@ -80,6 +71,12 @@ "schema": { "$ref": "#/definitions/NameAvailabilityParameters" } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -114,9 +111,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, { "in": "path", "name": "location", @@ -126,6 +120,9 @@ }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -164,10 +161,10 @@ ], "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -206,13 +203,13 @@ ], "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" } ], "responses": { @@ -250,6 +247,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -258,9 +258,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -289,33 +286,30 @@ ], "description": "Create or update a resource.", "operationId": "SignalR_CreateOrUpdate", - "consumes": [ - "application/json" - ], "produces": [ "application/json" ], "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "in": "body", + "name": "parameters", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/SignalRResource" + } }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "in": "body", - "name": "parameters", - "description": "Parameters for the create or update operation", - "required": true, - "schema": { - "$ref": "#/definitions/SignalRResource" - } + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -355,6 +349,9 @@ "description": "Operation to delete a resource.", "operationId": "SignalR_Delete", "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -363,9 +360,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -398,33 +392,30 @@ ], "description": "Operation to update an exiting resource.", "operationId": "SignalR_Update", - "consumes": [ - "application/json" - ], "produces": [ "application/json" ], "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "in": "body", + "name": "parameters", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/SignalRResource" + } }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "in": "body", - "name": "parameters", - "description": "Parameters for the update operation", - "required": true, - "schema": { - "$ref": "#/definitions/SignalRResource" - } + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -463,6 +454,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -471,9 +465,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -508,6 +499,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -516,9 +510,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -556,15 +547,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - }, { "in": "path", "name": "privateEndpointConnectionName", @@ -574,6 +556,15 @@ }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -602,22 +593,10 @@ ], "description": "Update the state of specified private endpoint connection", "operationId": "SignalRPrivateEndpointConnections_Update", - "consumes": [ - "application/json" - ], "produces": [ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - }, { "in": "path", "name": "privateEndpointConnectionName", @@ -625,9 +604,6 @@ "required": true, "type": "string" }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "in": "body", "name": "parameters", @@ -636,6 +612,18 @@ "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -665,15 +653,6 @@ "description": "Delete the specified private endpoint connection", "operationId": "SignalRPrivateEndpointConnections_Delete", "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - }, { "in": "path", "name": "privateEndpointConnectionName", @@ -683,6 +662,15 @@ }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -721,6 +709,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -729,9 +720,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -765,33 +753,30 @@ ], "description": "Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", "operationId": "SignalR_RegenerateKey", - "consumes": [ - "application/json" - ], "produces": [ "application/json" ], "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "in": "body", + "name": "parameters", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "in": "body", - "name": "parameters", - "description": "Parameter that describes the Regenerate Key Operation.", - "required": true, - "schema": { - "$ref": "#/definitions/RegenerateKeyParameters" - } + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -827,6 +812,9 @@ "description": "Operation to restart a resource.", "operationId": "SignalR_Restart", "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -835,9 +823,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -876,6 +861,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -884,9 +872,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -924,15 +909,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - }, { "in": "path", "name": "sharedPrivateLinkResourceName", @@ -942,6 +918,15 @@ }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -970,22 +955,10 @@ ], "description": "Create or update a shared private link resource", "operationId": "SignalRSharedPrivateLinkResources_CreateOrUpdate", - "consumes": [ - "application/json" - ], "produces": [ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - }, { "in": "path", "name": "sharedPrivateLinkResourceName", @@ -993,9 +966,6 @@ "required": true, "type": "string" }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "in": "body", "name": "parameters", @@ -1004,6 +974,18 @@ "schema": { "$ref": "#/definitions/SharedPrivateLinkResource" } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -1040,15 +1022,6 @@ "description": "Delete the specified shared private link resource", "operationId": "SignalRSharedPrivateLinkResources_Delete", "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - }, { "in": "path", "name": "sharedPrivateLinkResourceName", @@ -1058,6 +1031,15 @@ }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -1096,6 +1078,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -1104,9 +1089,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { diff --git a/specification/signalr/resource-manager/readme.md b/specification/signalr/resource-manager/readme.md index 2401a6a579e3..25ded1bd1c2d 100644 --- a/specification/signalr/resource-manager/readme.md +++ b/specification/signalr/resource-manager/readme.md @@ -60,6 +60,15 @@ directive: where: - $.definitions.Sku reason: It's required by spec of enumerating SKUs for an existing resource + - suppress: ParametersOrder + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}"].get + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}"].delete + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}"].get + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}"].delete + reason: It can introduce a breaking change when updating parameter order, since SignalR service has already shipped public versions. ``` ### Tag: package-2021-09-01-preview diff --git a/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json b/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json index 49ac24a22e6f..f010b3ca4d39 100644 --- a/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json +++ b/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json @@ -52,9 +52,6 @@ ], "description": "Checks that the resource name is valid and is not already in use.", "operationId": "WebPubSub_CheckNameAvailability", - "consumes": [ - "application/json" - ], "produces": [ "application/json" ], @@ -66,12 +63,6 @@ "required": true, "type": "string" }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "in": "body", "name": "parameters", @@ -80,6 +71,12 @@ "schema": { "$ref": "#/definitions/NameAvailabilityParameters" } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -114,9 +111,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, { "in": "path", "name": "location", @@ -126,6 +120,9 @@ }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -164,10 +161,10 @@ ], "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -206,13 +203,13 @@ ], "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" } ], "responses": { @@ -250,6 +247,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -258,9 +258,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -289,33 +286,30 @@ ], "description": "Create or update a resource.", "operationId": "WebPubSub_CreateOrUpdate", - "consumes": [ - "application/json" - ], "produces": [ "application/json" ], "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "in": "body", + "name": "parameters", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "in": "body", - "name": "parameters", - "description": "Parameters for the create or update operation", - "required": true, - "schema": { - "$ref": "#/definitions/WebPubSubResource" - } + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -355,6 +349,9 @@ "description": "Operation to delete a resource.", "operationId": "WebPubSub_Delete", "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -363,9 +360,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -398,33 +392,30 @@ ], "description": "Operation to update an exiting resource.", "operationId": "WebPubSub_Update", - "consumes": [ - "application/json" - ], "produces": [ "application/json" ], "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "in": "body", + "name": "parameters", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/WebPubSubResource" + } }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "in": "body", - "name": "parameters", - "description": "Parameters for the update operation", - "required": true, - "schema": { - "$ref": "#/definitions/WebPubSubResource" - } + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -463,6 +454,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -471,9 +465,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -511,15 +502,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - }, { "in": "path", "name": "hubName", @@ -529,6 +511,15 @@ }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -557,22 +548,10 @@ ], "description": "Create or update a hub setting.", "operationId": "WebPubSubHubs_CreateOrUpdate", - "consumes": [ - "application/json" - ], "produces": [ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - }, { "in": "path", "name": "hubName", @@ -580,9 +559,6 @@ "required": true, "type": "string" }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "in": "body", "name": "parameters", @@ -591,6 +567,18 @@ "schema": { "$ref": "#/definitions/WebPubSubHub" } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -627,15 +615,6 @@ "description": "Delete a hub setting.", "operationId": "WebPubSubHubs_Delete", "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - }, { "in": "path", "name": "hubName", @@ -645,6 +624,15 @@ }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -683,6 +671,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -691,9 +682,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -728,6 +716,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -736,9 +727,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -776,15 +764,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - }, { "in": "path", "name": "privateEndpointConnectionName", @@ -794,6 +773,15 @@ }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -822,22 +810,10 @@ ], "description": "Update the state of specified private endpoint connection", "operationId": "WebPubSubPrivateEndpointConnections_Update", - "consumes": [ - "application/json" - ], "produces": [ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - }, { "in": "path", "name": "privateEndpointConnectionName", @@ -845,9 +821,6 @@ "required": true, "type": "string" }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "in": "body", "name": "parameters", @@ -856,6 +829,18 @@ "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -885,15 +870,6 @@ "description": "Delete the specified private endpoint connection", "operationId": "WebPubSubPrivateEndpointConnections_Delete", "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - }, { "in": "path", "name": "privateEndpointConnectionName", @@ -903,6 +879,15 @@ }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -941,6 +926,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -949,9 +937,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -985,33 +970,30 @@ ], "description": "Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", "operationId": "WebPubSub_RegenerateKey", - "consumes": [ - "application/json" - ], "produces": [ "application/json" ], "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "in": "body", + "name": "parameters", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ResourceName" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupParameter" }, { - "in": "body", - "name": "parameters", - "description": "Parameter that describes the Regenerate Key Operation.", - "required": true, - "schema": { - "$ref": "#/definitions/RegenerateKeyParameters" - } + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -1047,6 +1029,9 @@ "description": "Operation to restart a resource.", "operationId": "WebPubSub_Restart", "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -1055,9 +1040,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1096,6 +1078,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -1104,9 +1089,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1144,15 +1126,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - }, { "in": "path", "name": "sharedPrivateLinkResourceName", @@ -1162,6 +1135,15 @@ }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -1190,22 +1172,10 @@ ], "description": "Create or update a shared private link resource", "operationId": "WebPubSubSharedPrivateLinkResources_CreateOrUpdate", - "consumes": [ - "application/json" - ], "produces": [ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - }, { "in": "path", "name": "sharedPrivateLinkResourceName", @@ -1213,9 +1183,6 @@ "required": true, "type": "string" }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, { "in": "body", "name": "parameters", @@ -1224,6 +1191,18 @@ "schema": { "$ref": "#/definitions/SharedPrivateLinkResource" } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -1260,15 +1239,6 @@ "description": "Delete the specified shared private link resource", "operationId": "WebPubSubSharedPrivateLinkResources_Delete", "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ResourceName" - }, { "in": "path", "name": "sharedPrivateLinkResourceName", @@ -1278,6 +1248,15 @@ }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ResourceName" } ], "responses": { @@ -1316,6 +1295,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -1324,9 +1306,6 @@ }, { "$ref": "#/parameters/ResourceName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { diff --git a/specification/webpubsub/resource-manager/readme.md b/specification/webpubsub/resource-manager/readme.md index 6413fac4d99d..557e39d3af0e 100644 --- a/specification/webpubsub/resource-manager/readme.md +++ b/specification/webpubsub/resource-manager/readme.md @@ -57,6 +57,18 @@ directive: where: - $.definitions.Sku reason: It's required by spec of enumerating SKUs for an existing resource + - suppress: ParametersOrder + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}"].get + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}"].delete + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}"].get + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}"].delete + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}"].get + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}"].delete + reason: It can introduce a breaking change when updating parameter order, since Web PubSub service has already shipped public versions. ``` ### Tag: package-2021-10-01 From da655edb55978fde7dfcb59ebafd97e111a1361f Mon Sep 17 00:00:00 2001 From: Junbo Wang Date: Tue, 30 Nov 2021 14:51:21 +0800 Subject: [PATCH 4/4] Update settings.json --- .vscode/settings.json | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index cbbd0ee052f3..76eab4509993 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -23,11 +23,5 @@ "typescript.tsdk": "node_modules\\typescript\\lib", "[json]": { "editor.defaultFormatter": "esbenp.prettier-vscode" - }, - "markdownlint.config": { - "MD028": false, - "MD025": { - "front_matter_title": "" - } } }