From 75a304f523b93d1b1d579d4bbd74c9899635306e Mon Sep 17 00:00:00 2001 From: Vitalii Kurokhtin Date: Mon, 26 Jul 2021 14:48:50 -0700 Subject: [PATCH 1/3] Spec fixed to reflect new examples property --- .../2021-01-01-preview/definitions.json | 36 ++++++++++++++++--- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/definitions.json index e7cef40ed991..844aeccc50f6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/definitions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/definitions.json @@ -1,3 +1,4 @@ + { "swagger": "2.0", "info": { @@ -3715,6 +3716,10 @@ "typeName": { "type": "string", "description": "Type name defined by the schema." + }, + "examples": { + "$ref": "#/definitions/ParameterExamplesContract", + "description": "Exampled defined for the parameter." } }, "required": [ @@ -3723,6 +3728,33 @@ ], "description": "Operation parameters details." }, + "ParameterExamplesContract": { + "additionalProperties": { + "$ref": "#/definitions/ParameterExampleContract", + "description": "Parameter example." + }, + "description": "Parameter examples." + }, + "ParameterExampleContract": { + "description": "Parameter example.", + "properties": { + "summary": { + "type": "string", + "description": "Short description for the example" + }, + "description": { + "type": "string", + "description": "Long description for the example" + }, + "value": { + "description": "Example value. May be a primitive value, or an object." + }, + "externalValue": { + "type": "string", + "description": "A URL that points to the literal example" + } + } + }, "PipelineDiagnosticSettings": { "properties": { "request": { @@ -4687,10 +4719,6 @@ "type": "string", "description": "Specifies a registered or custom content type for this representation, e.g. application/xml." }, - "sample": { - "type": "string", - "description": "An example of the representation." - }, "schemaId": { "type": "string", "description": "Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." From d77335fb42bff2fba0231a2a4d162e550748468c Mon Sep 17 00:00:00 2001 From: Vitalii Kurokhtin Date: Wed, 11 Aug 2021 18:56:53 -0700 Subject: [PATCH 2/3] Prettier --- .../preview/2021-01-01-preview/definitions.json | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/definitions.json index 844aeccc50f6..095fe7e03a95 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/definitions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2021-01-01-preview/definitions.json @@ -1,4 +1,3 @@ - { "swagger": "2.0", "info": { From 7d7b6b54502e112f2cdd03d3c77a2812d2063c5b Mon Sep 17 00:00:00 2001 From: Vitalii Kurokhtin Date: Mon, 16 Aug 2021 12:05:35 -0700 Subject: [PATCH 3/3] suppressing incorrect warning --- .../apimanagement/resource-manager/readme.md | 33 ++++++++++--------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/specification/apimanagement/resource-manager/readme.md b/specification/apimanagement/resource-manager/readme.md index 5458143088a5..de19ed80ca5e 100644 --- a/specification/apimanagement/resource-manager/readme.md +++ b/specification/apimanagement/resource-manager/readme.md @@ -521,7 +521,7 @@ See configuration in [readme.java.md](./readme.java.md) ## Suppression ``` yaml -directive: +directive: - suppress: R4009 from: apimapis.json reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. @@ -557,53 +557,56 @@ directive: reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimnamedvalues.json - reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. + reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimgateways.json - reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. + reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimgroups.json - reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. + reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimcontenttypes.json reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimdeletedservices.json - reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. + reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimdiagnostics.json - reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. + reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimemailtemplates.json - reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. + reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimidentityprovider.json reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimissues.json - reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. + reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimloggers.json - reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. + reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimopenidconnectproviders.json - reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. + reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimpolicies.json - reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. + reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimportalrevisions.json reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimsettings.json - reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. + reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimtags.json - reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. + reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimtenant.json - reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. + reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. - suppress: R4009 from: apimnotifications.json - reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. + reason: Warning raised to error while PR was being reviewed. SystemData will implement in next preview version. + - suppress: R4037 + from: definitions.json + reason: We want customers to be able to supply any valid JSON token, object or otherwise ```