feat: add Admin API docs with remote OpenAPI spec#996
Draft
dslovinsky wants to merge 1 commit intomainfrom
Draft
feat: add Admin API docs with remote OpenAPI spec#996dslovinsky wants to merge 1 commit intomainfrom
dslovinsky wants to merge 1 commit intomainfrom
Conversation
Adds a hidden admin-api tab with overview/auth MDX pages and API reference from the remote spec at admin-api.alchemy.com. Extends generate-open-api.sh to fetch and bundle the remote YAML spec into the existing GH Pages pipeline. Adds repository_dispatch trigger for spec freshness and workflow_dispatch for manual re-indexing.
🌿 Documentation Preview
|
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.
Summary
admin-apitab with placeholder overview and authentication MDX pagesgenerate-open-api.shto fetch and bundle the remote spec athttps://admin-api.alchemy.com/openapi.yamlinto the existing GH Pages pipelinerepository_dispatchtrigger togh-pages-deploy.ymlso the API repo can trigger spec rebuildsworkflow_dispatchtoindex-main-content.ymlfor manual re-indexingHow it works
The remote YAML spec is fetched and dereferenced by
redocly bundleduring the existing build step, outputting JSON tofern/api-specs/alchemy/rest/admin-api.json. From there, the entire existing pipeline handles it automatically —metadata.jsongeneration, GH Pages deploy, content indexing, caching, and revalidation all treat it identically to local specs.The tab is "hidden" because it's defined in
docs.yml(pages are indexed and URL-accessible) but not added to the docs-site header navigation.Test plan
pnpm generatelocally and verifyfern/api-specs/alchemy/rest/admin-api.jsonis createdpnpm generate:metadataand verifymetadata.jsonincludes the admin-api URLpnpm index:mainand verify path index contains admin-api entries/docs/admin-api/overviewand/docs/admin-api/authentication