Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parameter examples added #14836

Merged
merged 1 commit into from
Jul 27, 2021
Merged

Parameter examples added #14836

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 31 additions & 4 deletions ...ment/resource-manager/Microsoft.ApiManagement/preview/2021-04-01-preview/definitions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3715,6 +3715,10 @@
"typeName": {
"type": "string",
"description": "Type name defined by the schema."
},
"examples": {
"$ref": "#/definitions/ParameterExamplesContract",
"description": "Exampled defined for the parameter."
}
},
"required": [
Expand All @@ -3723,6 +3727,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": {
Expand Down Expand Up @@ -4687,10 +4718,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'."
Expand Down