docs: generate public API reference from OpenAPI spec#8
Open
nbouliol wants to merge 2 commits into
Open
Conversation
Add reference/api/openapi.json and render activity-logs, admin-logs and notes from it via openapi frontmatter (keeps the auth warnings, drops the hand-written param/response tables). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
![macroscopeapp[bot]](https://avatars.githubusercontent.com/in/900172?s=60&v=4){kind=small}
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What
Renders the Public API reference from the OpenAPI spec instead of hand-written tables.
reference/api/openapi.json(generated bypackages/public-apiin forestadmin-server).activity-logs,admin-logsandnotesendpoint pages toopenapifrontmatter — params, schemas, responses and the "Try it" playground are now generated from the spec. The auth<Warning>blocks are kept.Notes
openapi.jsonis updated automatically via a PR from forestadmin-server (see forestadmin-server#8348).🤖 Generated with Claude Code
Note
Generate public API reference pages from OpenAPI spec
activity-logs.mdx,admin-logs.mdx, andnotes.mdxwithopenapi:front-matter references that render docs directly from the spec.openapi.json, a new OpenAPI 3.0 spec covering the public API with info, servers, security schemes, and schemas.Macroscope summarized 4c6d826.