Open
Conversation
Showcases three areas of improvement for the Open Payments API reference docs:
1. Spec improvements — proposed fixes to the OpenAPI YAML files including
titles on anonymous oneOf/anyOf objects, missing field descriptions, removal
of the orphaned wallet-address tag and unimplemented /did.json endpoint, and
updated info.description fields across all three specs. Changes are local
only and documented in docs/src/content/docs/resources/spec-improvements.mdx.
2. Scalar — full-page API reference viewer added as an alternative to the
existing Starlight plugin. Serves specs at runtime from docs/public/specs/.
Pages at /apis/scalar/{resource,auth,wallet-address}-server.
3. Redoc — pre-built self-contained HTML API reference added as a second
alternative. Pre-built files committed to docs/public/apis/redoc/. Thin
Astro wrapper pages at /apis/redoc/{resource,auth,wallet-address}-server.
✅ Deploy Preview for openpayments-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Added more specific links and titles to spec description
✅ Deploy Preview for openpayments ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Author
|
There are two Netlify bot comments on this PR. The first deploy preview broke, so the next commit triggered a new build. Use this link for the preview: https://deploy-preview-772--openpayments.netlify.app/ |
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.
This is an experimental branch — do not merge.
Explores potential improvements to how we publish the Open Payments API reference. Three things to look at:
Scalar includes a built-in API console where you can make live test calls directly from the browser. Redoc is a read-only reference with a more traditional three-panel layout. Both are worth comparing against each other and against the existing Starlight plugin.
Required
Conditional