Repository navigation
feat: accept Fern legacy availability and status messages - #3
Open
AsharibAli wants to merge 4 commits into
Open
AsharibAli wants to merge 4 commits into
AsharibAli wants to merge 4 commits into
Conversation
Parse Fern endpoint statuses, including legacy, and the { status, message } object. Keep the note on the command model and preserve it on overlaid operations.
Accept x-fern-availability objects, store the note beside the status, and pass it through alias projections so rendered operations keep it.
Share one label for every Fern status and give superseded endpoints a distinct badge.
feat: accept Fern legacy availability and status messages
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
@cloudflare/forgenow parses Fern's endpoint availability, includinglegacyand{ status, message }, and keeps the note on the command model.fern-forgeaccepts that object form, storesavailabilityMessage, and passes the note through alias projections so rendered operations keep it.Why
Fern's
x-fern-availabilityextension is the lifecycle contract for SDKs, CLIs, and API reference pages: https://buildwithfern.com/learn/api-definition/openapi/extensions/availabilityThe core engine rejected
legacyand the object form.fern-forgeacceptedlegacyas a string but rejected{ status, message }, so a spec written the way Fern documents it failed validation before the docs could show the note.legacystays supported, so it is not treated as deprecated. Pre-release statuses still map to the@betaJSDoc tag Fern's TypeScript generator emits, anddeprecatedmaps to@deprecated.Tests
@cloudflare/forge: 44 tests passed, including the availability parser, overlay round-trip, and direct OpenAPI ingestion.tsc --noEmitpassed.fern-forge: 18 tests passed, including primary and alias message preservation and rejection of unknown or blank messages.tsc --noEmitpassed.docs-site: availability label tests passed.