Skip to content

add guidance for example names #4432

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

Merged
jhendrixMSFT merged 1 commit into from
Nov 12, 2018
Merged

add guidance for example names #4432

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
2 changes: 1 addition & 1 deletion documentation/x-ms-examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ _This will keep the spec cleaner and easy to manage._
- The JSON schema for the content to be provided in the example file can be found [here](https://raw.githubusercontent.com/Azure/autorest/master/schema/example-schema.json).
```json5
"x-ms-examples": {
"example-name": { //Name of the example/scenario.
"example-name": { //Name of the example/scenario. It is free-form text and should succinctly describe the scenario.
"parameters": { //Provide examples for all the path, query, header, body, formData parameters as applicable.
...
},
Expand Down