Skip to content

Commit c3f685d

Browse files
author
sven
authored
template(openapi): fix typo (#50)
1 parent 70872ee commit c3f685d

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

template/openapi/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
## The `openapi` folder
22

3-
This folder contains your entrypoint `openapi.yaml`.
3+
This folder contains your entrypoint `openapi.yaml`.
44

55
That file contains references to the entire API definition.
66

77
Here are some sections to pay attention to:
88

9-
* Top-level **description**: this accepts markdown, and Redoc and Redocly API Reference will render it at the top of the docs. Consider maintaining your markdown in a separate file and [embedding it](https://docs.redoc.ly/api-reference-dics/embedded-markdown/). Note to Redoc community edition users, the special tags are only available to the Redocly API Reference users, but you can still embed markdown.
9+
* Top-level **description**: this accepts markdown, and Redoc and Redocly API Reference will render it at the top of the docs. Consider maintaining your markdown in a separate file and [embedding it](https://docs.redoc.ly/api-reference-docs/embedded-markdown/). Note to Redoc community edition users, the special tags are only available to the Redocly API Reference users, but you can still embed markdown.
1010
* Security schemes: you will define the scheme(s) your API uses for security (eg OAuth2, API Key, etc...). The security schemes are used by the Redocly API Reference "Try It" API console feature.
1111
* [Paths](paths/README.md): this defines each endpoint. A path can have one operation per http method.
1212
* Tags: it's a good idea to organize each operation. Each tag can have a description. The description is used as a section description within the reference docs.

0 commit comments

Comments
 (0)