Parameter examples added (Azure#14836)

solankisamir · Aug 27, 2021 · 50d808a · 50d808a
1 parent c09ae23
commit 50d808a
Showing 1 changed file with 31 additions and 4 deletions.
diff --git a/...ment/resource-manager/Microsoft.ApiManagement/preview/2021-04-01-preview/definitions.json b/...ment/resource-manager/Microsoft.ApiManagement/preview/2021-04-01-preview/definitions.json
@@ -3727,6 +3727,10 @@
         "typeName": {
           "type": "string",
           "description": "Type name defined by the schema."
+        },
+        "examples": {
+          "$ref": "#/definitions/ParameterExamplesContract",
+          "description": "Exampled defined for the parameter."
         }
       },
       "required": [
@@ -3735,6 +3739,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": {
@@ -4699,10 +4730,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'."