[API Docs] Generate reference from OpenAPI - #29
Open
phawk wants to merge 3 commits into
Open
Conversation
- Install locked Yarn dependencies during setup - Run Docusaurus on each workspace's allocated port - Allow independent workspaces to run concurrently - Expose the local development command as the default action
- Store the deployed public v1 contract as a checked-in snapshot. - Generate Docusaurus reference pages before local and CI builds. - Add curated endpoint navigation and language code samples. - Sync the sandbox contract without formatting-only file churn. - Validate the contract and documentation through GitHub Actions. - Open scheduled update PRs when the deployed contract changes. - Theme generated pages for PayHere light and dark modes. - Document the reference workflow and supported Node versions.
- Remove superseded hand-written API reference pages - Use the OpenAPI-generated reference as the sole API sidebar - Redirect all legacy API URLs with explicit HTTP 301 responses - Update site links to use canonical generated API routes - Document redirect maintenance for operation ID changes
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Generate the REST API reference from the sandbox OpenAPI contract so published documentation stays aligned with the Rails API.
Validation
yarn api:lintyarn api:sync --checkyarn build