Add API Specifications documentation #2764
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documents the new API Specifications feature in the web editor, including how to import, organize, and manage OpenAPI and AsyncAPI specification files. Adds comprehensive documentation for the API Specs view, configuration options, and navigation integration.
Files changed
editor/api-specs.mdx- New documentation page for API specifications featureeditor/configurations.mdx- Added section for OpenAPI/AsyncAPI configuration fieldseditor/index.mdx- Added card linking to API specs documentationdocs.json- Addededitor/api-specsto navigation in all language versions (en, fr, es, zh)Generated from [EDITOR] API Specs @dks333
Note
Introduces documentation for managing API specification files in the web editor and updates navigation and configuration references.
editor/api-specs.mdxdetailing importing, organizing (folders/drag-and-drop), previewing, and linking OpenAPI/AsyncAPI specs (file vs URL) in navigationeditor/configurations.mdxwith OpenAPI/AsyncAPI configuration fields, modes, mutual exclusivity, and preview/clear actionseditor/index.mdxlinking to the new pagedocs.jsonto includeeditor/api-specsin the Web editor section for en, fr, es, and zhWritten by Cursor Bugbot for commit efe5286. This will update automatically on new commits. Configure here.