Add version 1.1 to API docs #1828
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for versioned API documentation (v1.0 and v1.1) by updating the OpenAPI plugin configuration and switching to an autogenerated sidebar for the API docs.
- Switched
apiSidebarto use an autogeneratedAPI-docsdirectory. - Configured the OpenAPI plugin in
docusaurus.config.jsfor a default 1.0 spec and a new 1.1 spec underdocs/API-docs-1.1. - Removed the generated API docs from version control (not shown here).
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/sidebars.js | Removed custom import and now autogenerates apiSidebar from API-docs |
| docs/docusaurus.config.js | Added default version 1.0 and version 1.1 settings for the API plugin |
Comments suppressed due to low confidence (2)
docs/sidebars.js:20
- [nitpick] The sidebar is now autogenerated only for the
API-docsfolder; to support multiple API versions (e.g.,API-docs-1.1), consider generating separate sidebars per version or a version-aware sidebar configuration.
apiSidebar: [{type: 'autogenerated', dirName: 'API-docs'}],
docs/docusaurus.config.js:83
- The
specPathreferencesopensign.yaml, which looks like a typo and may prevent the spec from being found; confirm the filename (e.g.,openapi.yaml).
specPath: "docs/API-docs/opensign.yaml",
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Testing
npm test(fails: Error: no test specified)npm run buildindocshttps://chatgpt.com/codex/tasks/task_e_68548c1dbbd08328a52a49ae52785c1e