Repository navigation
docs(frontlit): api reference, plans and a v0 migration note - #884
Merged
Merged
Conversation
Every operation in /openapi.json and the committed apps/api/openapi.json now has an operationId equal to its contract key (listSections and so on), matching the MCP tool names. The docs API reference uses it for stable page URLs.
Adds Plans and limits and Cloud or self-hosted to Getting started, a Migrate to CourseLit section with a placeholder for moving from v0, and links the developer docs to the API reference at /docs/api.
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
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.
Phase 1 docs for the closed beta: an API reference, plan docs, and a placeholder for moving from v0. Merging publishes to the hidden QA beta.
API reference
The spec is already committed (
apps/api/openapi.json), and CI'scheck:driftkeeps it in sync with the code. It just had nooperationIds, so FrontLit would have made page URLs from operation summaries.apps/api/src/openapi.ts: sets each operation'soperationIdto its contract key (listSections,createProductand so on). These match the MCP tool names.apps/api/openapi.json: regenerated. 281 operations, all with unique ids, about 3 MB (FrontLit's limits are 5 MiB and 500 operations).apps/api/src/openapi.test.ts: checks that every operation's id is unique and equal to its contract key.After merging, one dashboard step turns it on, because the QA MCP has no API-reference tools. Set it in FrontLit QA under Settings → Integrations → GitHub → API reference:
apps/api/openapi.jsonapiThe reference then appears at
/docs/api, one page per operation (/docs/api/listSections). The whole spec becomes public there. The API already serves the same document at/openapi.json. "Try it" callshttps://api.courselit.appfrom the docs origin, so it needs a CORS change on the API. That's left for a separate PR.Docs
/docs/getting-started/cloud-vs-self-hosted/docs/getting-started/plans-and-limits/docs/migrate/from-courselit-v0getting-started/index,developers/index/docs/apiThe checker passes:
check.mjs frontlit/docs --api-mount=apireports 163 routes. Moving legacy screenshots offdocs.courselit.appis deferred.