feat(cli): add x-fern-playground-description for playground-only auth docs - #17665
Draft
adidavid014 wants to merge 1 commit into
Draft
feat(cli): add x-fern-playground-description for playground-only auth docs#17665adidavid014 wants to merge 1 commit into
adidavid014 wants to merge 1 commit into
Conversation
… docs Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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.
Description
Lets a customer author auth guidance that only shows in the API Playground (under the token input), without touching the API reference's Authorization description.
Fern definition equivalent:
auth-schemes.<name>.playground-docs.Flow:
x-fern-playground-description/playground-docs→ IRAuthScheme.playgroundDocs(optional) → FDRplaygroundDescriptiononbearerAuth/basicAuth/header.docs/descriptionare untouched, so the reference page and the collapsed playground auth header keep their existing text.Rendering side is fern-api/fern-platform#14486 (adds
playgroundDescriptionto the FDR zod schemas and renders it as a callout under the input). This PR's@fern-api/fern-platform-publishedfdr-sdktypes don't haveplaygroundDescriptionyet, so@fern-api/register#compilefails until that PR merges and the SDK is bumped — hence draft.Changes Made
BaseAuthScheme.playgroundDocs?: string, VERSION67.23.0→67.24.0, changelog entry, regenerated SDK. Additive/optional → no migration.WithPlaygroundDocsSchemamixed into header/basic/bearer/inferred/oauth schemes; bothconvertApiAuthconverters pass it through.ir-to-fdr-converter: mapsplaygroundDocs→playgroundDescription(bearer/basic/header + inferred and OAuth bearer fallbacks).changes/unreleased/.convertSecuritySchemepath, which already drops the security schemedescriptionentirely.Testing
auth-playground-descriptioninregister/src/ir-to-fdr-converter/__test__asserting IRplaygroundDocsand FDRplaygroundDescriptioncoexist withdescription; auth snapshots updated.Link to Devin session: https://app.devin.ai/sessions/6a812925d9ba495aa86d3cc6a6f3f7b0
Open in Devin Desktop: https://app.devin.ai/desktop/session/6a812925d9ba495aa86d3cc6a6f3f7b0?variant=devin
Requested by: @adidavid014