Skip to content

Commit 2ee828b

Browse files
committed
Update add-new-api.md
1 parent 92f8da0 commit 2ee828b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/add-new-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ class Response {
169169

170170
### Add endpoint request and response examples
171171

172-
Add an `examples` folder and `request` and `xxx_response` subfolders (where `xxx` is the relevant response code).
172+
Add an `examples` folder and `request` and `xxx_response` subfolders (where `xxx` is the relevant response code). The file names within these folders should be unique (for example,`DownsampleRequestExample1.yaml` not `RequestExample1.yaml`).
173173

174174
These examples are for use in the API documentation and must adhere to the [OpenAPI 3.0 Example object specification](https://spec.openapis.org/oas/v3.0.3#example-object). They must have a `value` field that contains the request or response body.
175175
If there are multiple examples for the endpoint, they must each have a brief `summary` field, which is used as the label for the example. You can also optionaly provide an explanation in a `description` field.

0 commit comments

Comments
 (0)