Repository navigation
feat(api-reference): add operation Markdown routes - #515
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Your trial has ended. Reactivate Greptile to resume code reviews.
24 tasks done
@farming-labs/astro
@farming-labs/astro-theme
@farming-labs/docs
@farming-labs/farmjs
@farming-labs/theme
@farming-labs/next
@farming-labs/nuxt
@farming-labs/nuxt-theme
@farming-labs/svelte
@farming-labs/svelte-theme
@farming-labs/tanstack-start
commit: |
This branch was successfully deployed
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.
Summary
.mdroutes for unversioned and versioned OpenAPI operationsLink,Content-Location,ETag, and matching Markdown frontmatter metadataPublic API
Adds the server-only
createApiReferenceOperationMarkdownResponsehelper and its options type from@farming-labs/docs/server. Existing APIs and renderer configuration are unchanged.Verification
@farming-labs/docssuite: 1,479 tests passedPart of #508
Summary by cubic
Adds stable per-operation Markdown routes for API references so search, Ask AI, and other consumers can fetch operation docs as
text/markdown.New Features
createApiReferenceOperationMarkdownResponsehelper from@farming-labs/docs/serverthat resolves unversioned and versioned operation paths and serves Markdown with canonicalLink,Content-Location, andETagheaders..mdpaths through the shared projection across Next.js, TanStack Start, Farm.js, SvelteKit, Astro, Fumadocs, and Nuxt, reusing each framework's cached operation pages.Refactors
.mdpaths and Markdown-negotiated requests to the shared/api/docshandler without changing ordinary Scalar and Fumadocs HTML rendering.Part of #508.
Written for commit b632393. Summary will update on new commits.