Skip to content

Commit 5c6b5be

Browse files
authored
Describe what the id is (#189)
1 parent 3894009 commit 5c6b5be

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -210,14 +210,15 @@ You may also generate OpenAPI docs for a single path or OAS by specifying the un
210210
```bash
211211
yarn docusaurus gen-api-docs <id>
212212
```
213+
The <id> is the name of the folder of specs in "openapispecs" folder.
213214

214215
Example:
215216

216217
```bash
217218
yarn docusaurus gen-api-docs commerceextensions
218219
```
219220

220-
> The example above will only generate API docs relative to `commerceextensions`.
221+
> The example above will only generate API docs relative to `commerceextensions`.
221222
222223
### Cleaning API Docs
223224

@@ -233,6 +234,8 @@ You may also remove a particular set of API docs by specifying the unique `id` o
233234
yarn docusaurus clean-api-docs <id>
234235
```
235236

237+
The <id> is the name of the folder of specs in "openapispecs" folder.
238+
236239
Example:
237240

238241
```bash

0 commit comments

Comments
 (0)