Skip to content

Commit 6780e8a

Browse files
authored
add guidance for example names (#4432)
1 parent eaf464e commit 6780e8a

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

documentation/x-ms-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ _This will keep the spec cleaner and easy to manage._
8282
- 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).
8383
```json5
8484
"x-ms-examples": {
85-
"example-name": { //Name of the example/scenario.
85+
"example-name": { //Name of the example/scenario. It is free-form text and should succinctly describe the scenario.
8686
"parameters": { //Provide examples for all the path, query, header, body, formData parameters as applicable.
8787
...
8888
},

0 commit comments

Comments
 (0)