From 58c8a1fca44150ec3c78734bdce727603a7f7cdf Mon Sep 17 00:00:00 2001 From: Shuangyan Lei Date: Wed, 17 Jul 2019 11:37:25 -0700 Subject: [PATCH 1/4] update attestation swagger --- .../2018-09-01-preview/attestation.json | 46 ++++++------------- .../examples/Create_AttestationProvider.json | 2 +- .../examples/Delete_AttestationProvider.json | 2 +- 3 files changed, 16 insertions(+), 34 deletions(-) diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/attestation.json b/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/attestation.json index 8825e71eac8b..4909d9ca3186 100644 --- a/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/attestation.json +++ b/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/attestation.json @@ -77,10 +77,10 @@ }, "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "providerName", @@ -122,17 +122,17 @@ }, "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "providerName", "in": "path", "required": true, "type": "string", - "pattern": "^[a-zA-Z0-9-]{3,24}$", + "pattern": "^[a-z0-9]{3,24}$", "description": "Name of the attestation service" }, { @@ -182,17 +182,17 @@ }, "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "providerName", "in": "path", "required": true, "type": "string", - "pattern": "^[a-zA-Z0-9-]{3,24}$", + "pattern": "^[a-z0-9]{3,24}$", "description": "Name of the attestation service" }, { @@ -200,12 +200,12 @@ } ], "responses": { - "202": { - "description": "Request accepted for deletion of attestation service" - }, "200": { "description": "Resource exists and was deleted successfully" }, + "202": { + "description": "Request accepted for deletion of attestation service" + }, "204": { "description": "Resource does not exist" }, @@ -235,7 +235,7 @@ "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" } ], "x-ms-pageable": { @@ -271,13 +271,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" } ], "x-ms-pageable": { @@ -469,24 +469,6 @@ } }, "parameters": { - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group to which the resource belongs.", - "required": true, - "type": "string", - "maxLength": 90, - "minLength": 1, - "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", - "x-ms-parameter-location": "method" - }, - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Subscription credentials that uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, "ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Create_AttestationProvider.json b/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Create_AttestationProvider.json index a9b3bd30b942..b3e4b9d1fc53 100644 --- a/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Create_AttestationProvider.json +++ b/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Create_AttestationProvider.json @@ -4,7 +4,7 @@ "serviceName": "sampleservicename", "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2018-09-01-preview", - "providerName": "providerName1", + "providerName": "providername1", "creationParams": "test" }, "responses": { diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Delete_AttestationProvider.json b/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Delete_AttestationProvider.json index f6a081df3cc1..2b4a5c9d7fe5 100644 --- a/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Delete_AttestationProvider.json +++ b/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Delete_AttestationProvider.json @@ -4,7 +4,7 @@ "serviceName": "sampleservicename", "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2018-09-01-preview", - "providerName": "providerName1" + "providerName": "providername1" }, "responses": { "202": { From c93894791f1d16459dc53cad5ac8017103a42fe8 Mon Sep 17 00:00:00 2001 From: Shuangyan Lei Date: Wed, 17 Jul 2019 12:50:21 -0700 Subject: [PATCH 2/4] Move attestation API under a preview folder --- .../2018-09-01-preview/attestation.json | 20 +++++++++---------- .../examples/Create_AttestationProvider.json | 0 .../examples/Delete_AttestationProvider.json | 0 .../examples/Get_AttestationProvider.json | 0 .../Get_AttestationProvidersList.json | 0 ...testationProvidersListByResourceGroup.json | 0 .../examples/Operations_List.json | 0 .../attestation/resource-manager/readme.md | 10 +++++----- 8 files changed, 15 insertions(+), 15 deletions(-) rename specification/attestation/resource-manager/Microsoft.Attestation/{ => preview}/2018-09-01-preview/attestation.json (91%) rename specification/attestation/resource-manager/Microsoft.Attestation/{ => preview}/2018-09-01-preview/examples/Create_AttestationProvider.json (100%) rename specification/attestation/resource-manager/Microsoft.Attestation/{ => preview}/2018-09-01-preview/examples/Delete_AttestationProvider.json (100%) rename specification/attestation/resource-manager/Microsoft.Attestation/{ => preview}/2018-09-01-preview/examples/Get_AttestationProvider.json (100%) rename specification/attestation/resource-manager/Microsoft.Attestation/{ => preview}/2018-09-01-preview/examples/Get_AttestationProvidersList.json (100%) rename specification/attestation/resource-manager/Microsoft.Attestation/{ => preview}/2018-09-01-preview/examples/Get_AttestationProvidersListByResourceGroup.json (100%) rename specification/attestation/resource-manager/Microsoft.Attestation/{ => preview}/2018-09-01-preview/examples/Operations_List.json (100%) diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/attestation.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json similarity index 91% rename from specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/attestation.json rename to specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json index 4909d9ca3186..039b68bd4a86 100644 --- a/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/attestation.json +++ b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json @@ -77,10 +77,10 @@ }, "parameters": [ { - "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "providerName", @@ -122,10 +122,10 @@ }, "parameters": [ { - "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "providerName", @@ -182,10 +182,10 @@ }, "parameters": [ { - "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "providerName", @@ -235,7 +235,7 @@ "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" } ], "x-ms-pageable": { @@ -271,13 +271,13 @@ }, "parameters": [ { - "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" } ], "x-ms-pageable": { @@ -357,7 +357,7 @@ ], "allOf": [ { - "$ref": "../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" } ], "properties": { diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Create_AttestationProvider.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Create_AttestationProvider.json similarity index 100% rename from specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Create_AttestationProvider.json rename to specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Create_AttestationProvider.json diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Delete_AttestationProvider.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Delete_AttestationProvider.json similarity index 100% rename from specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Delete_AttestationProvider.json rename to specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Delete_AttestationProvider.json diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Get_AttestationProvider.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvider.json similarity index 100% rename from specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Get_AttestationProvider.json rename to specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvider.json diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Get_AttestationProvidersList.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvidersList.json similarity index 100% rename from specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Get_AttestationProvidersList.json rename to specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvidersList.json diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Get_AttestationProvidersListByResourceGroup.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvidersListByResourceGroup.json similarity index 100% rename from specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Get_AttestationProvidersListByResourceGroup.json rename to specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_AttestationProvidersListByResourceGroup.json diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Operations_List.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Operations_List.json similarity index 100% rename from specification/attestation/resource-manager/Microsoft.Attestation/2018-09-01-preview/examples/Operations_List.json rename to specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Operations_List.json diff --git a/specification/attestation/resource-manager/readme.md b/specification/attestation/resource-manager/readme.md index c8165c33e5af..ab77741cbe77 100644 --- a/specification/attestation/resource-manager/readme.md +++ b/specification/attestation/resource-manager/readme.md @@ -26,16 +26,16 @@ These are the global settings for the Attestation API. ``` yaml openapi-type: arm -tag: package-2018-09 +tag: package-2018-09-preview ``` -### Tag: package-2018-09 +### Tag: package-2018-09-preview -These settings apply only when `--tag=package-2018-09` is specified on the command line. +These settings apply only when `--tag=package-2018-09-preview` is specified on the command line. -``` yaml $(tag) == 'package-2018-09' +``` yaml $(tag) == 'package-2018-09-preview' input-file: -- Microsoft.Attestation/2018-09-01-preview/attestation.json +- Microsoft.Attestation/preview/2018-09-01-preview/attestation.json ``` --- From 5c87ca3da4df1ef23bc7250ce029f375ea302108 Mon Sep 17 00:00:00 2001 From: Shuangyan Lei Date: Wed, 17 Jul 2019 15:11:44 -0700 Subject: [PATCH 3/4] fix the error response --- .../2018-09-01-preview/attestation.json | 68 ++++++------------- 1 file changed, 20 insertions(+), 48 deletions(-) diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json index 039b68bd4a86..bdb71e88990e 100644 --- a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json +++ b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json @@ -55,9 +55,9 @@ } }, "default": { - "description": "Attestation service error result", + "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResult" + "$ref": "#/definitions/CloudError" } } } @@ -104,7 +104,7 @@ "default": { "description": "Error result from Attestation service", "schema": { - "$ref": "#/definitions/ErrorResult" + "$ref": "#/definitions/CloudError" } } } @@ -164,7 +164,7 @@ "default": { "description": "Error result from Attestation service", "schema": { - "$ref": "#/definitions/ErrorResult" + "$ref": "#/definitions/CloudError" } } } @@ -212,7 +212,7 @@ "default": { "description": "Error result from Attestation service", "schema": { - "$ref": "#/definitions/ErrorResult" + "$ref": "#/definitions/CloudError" } } } @@ -251,7 +251,7 @@ "default": { "description": "Attestation service error result", "schema": { - "$ref": "#/definitions/ErrorResult" + "$ref": "#/definitions/CloudError" } } } @@ -294,7 +294,7 @@ "default": { "description": "Attestation service error result", "schema": { - "$ref": "#/definitions/ErrorResult" + "$ref": "#/definitions/CloudError" } } } @@ -395,56 +395,28 @@ } } }, - "ErrorResult": { - "type": "object", - "title": "Error", - "description": "Error description and code explaining why an operation failed.", + "CloudError": { + "x-ms-external": true, "properties": { "error": { - "type": "object", - "description": "Error object.", - "$ref": "#/definitions/ErrorResponseBody" + "$ref": "#/definitions/CloudErrorBody" } - } + }, + "description": "An error response from Attestation." }, - "ErrorResponseBody": { - "type": "object", - "title": "Error", - "description": "Error description and code explaining why an operation failed.", - "required": [ - "message", - "code" - ], + "CloudErrorBody": { + "x-ms-external": true, "properties": { - "message": { + "code": { "type": "string", - "description": "Description of the error." + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." }, - "code": { + "message": { "type": "string", - "description": "Service specific error code" + "description": "A message describing the error, intended to be suitable for displaying in a user interface." } - } - }, - "ErrorResponse": { - "type": "object", - "description": "Error response", - "properties": { - "error": { - "type": "object", - "description": "Error response", - "properties": { - "code": { - "type": "string", - "description": "Description of the error." - }, - "message": { - "type": "string", - "description": "Service specific error code." - } - } - } - } + }, + "description": "An error response from Attestation." }, "AttestationProviderListResult": { "description": "Attestation Providers List.", From 03f62ed5e2ec480598fdf6b807c86a33982bac04 Mon Sep 17 00:00:00 2001 From: Shuangyan Lei Date: Wed, 17 Jul 2019 16:04:18 -0700 Subject: [PATCH 4/4] remove the pattern validation from swaggle since the validation already appears on the server --- .../preview/2018-09-01-preview/attestation.json | 3 --- 1 file changed, 3 deletions(-) diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json index bdb71e88990e..2987cf4d8a5a 100644 --- a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json +++ b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json @@ -87,7 +87,6 @@ "in": "path", "required": true, "type": "string", - "pattern": "^[a-z0-9]{3,24}$", "description": "Name of the attestation service instance" }, { @@ -132,7 +131,6 @@ "in": "path", "required": true, "type": "string", - "pattern": "^[a-z0-9]{3,24}$", "description": "Name of the attestation service" }, { @@ -192,7 +190,6 @@ "in": "path", "required": true, "type": "string", - "pattern": "^[a-z0-9]{3,24}$", "description": "Name of the attestation service" }, {