Skip to content

Commit

Permalink
add guidance for example names (#4432)
Browse files Browse the repository at this point in the history
  • Loading branch information
jhendrixMSFT authored Nov 12, 2018
1 parent eaf464e commit 6780e8a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion documentation/x-ms-examples.md
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

0 comments on commit 6780e8a

Please sign in to comment.