Skip to content

Commit 608dc8d

Browse files
docs: update api docs bundle
1 parent 9c41056 commit 608dc8d

3 files changed

Lines changed: 15949 additions & 1693 deletions

File tree

docs/api/lke/IMPORTANT.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
1-
# WARNING
1+
# IMPORTANT WARNING
22

33
**DO NOT EDIT THE ".yaml" AND ".mdx" FILES DIRECTLY IN THIS FOLDER!**
44

5-
These files are automatically generated by npm `run apidocs` scripts.
5+
These files are automatically generated by the `npm run apidocs` script.
66

7-
Any manual changes will be lost on the next automatic generation.
7+
Any manual changes will be lost in the next automatic generation.
88

9-
To modify the documentation or the OpenAPI specification, edit the appropriate source files in the `oas` folder.
9+
To modify the documentation or OpenAPI specification, edit the appropriate source files in the `oas` folder.
10+
11+
## How to edit
12+
13+
1. Edit the files in `oas/lke/`
14+
2. Run `npm run apidocs` to regenerate
15+
3. Check the result in this folder
16+
17+
## Source files structure
18+
19+
- `oas/lke/lke.openapi.yaml` - Main specification file
20+
- `oas/lke/components.openapi.yaml` - Reusable components
21+
- `oas/base/base.openapi.yaml` - Shared base components

0 commit comments

Comments
 (0)