Add x-gitbook-prefix and x-gitbook-token-placeholder for OpenAPI security scheme
#3820
Conversation
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
🦋 Changeset detectedLatest commit: 675d8da The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
nolannbiron
force-pushed
the
nolann/add-x-prefix-to-securities
branch
from
3fb7422 to
bac630b
Compare
Contributor
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
nolannbiron
force-pushed
the
nolann/add-x-prefix-to-securities
branch
from
bac630b to
e3a829d
Compare
nolannbiron
requested review from
Copilot,
gregberge and
spastorelli
and removed request for
Copilot and
spastorelli
Copilot finished reviewing on behalf of
nolannbiron
November 19, 2025 15:18
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for two new OpenAPI extension properties (x-prefix and x-placeholder) to customize security scheme behavior in code samples. The changes allow API documentation authors to override default prefix values (like "Bearer", "Basic") and placeholder text for authentication tokens.
Key Changes
- Added
x-placeholderproperty to override default placeholder values in security schemes - Added
x-prefixproperty to customize authentication prefixes (e.g., custom alternatives to "Bearer" or "Basic") - Updated security header generation logic to check for and apply these custom properties across HTTP, apiKey, and OAuth2 security schemes
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/openapi-parser/src/types.ts | Defines TypeScript interfaces for the new x-placeholder and x-prefix extension properties |
| packages/react-openapi/src/util/tryit-prefill.ts | Adds fallback logic to use x-placeholder when x-gitbook-prefill is not present |
| packages/react-openapi/src/util/tryit-prefill.test.ts | Tests prioritization of x-gitbook-prefill over x-placeholder and validates x-placeholder for apiKey schemes |
| packages/react-openapi/src/OpenAPICodeSample.tsx | Implements x-prefix support across HTTP, apiKey, and OAuth2 security types; exports getSecurityHeaders for testing |
| packages/react-openapi/src/OpenAPICodeSample.test.ts | New test file covering x-prefix functionality with apiKey schemes and combined x-prefix/x-placeholder usage |
| .changeset/five-worlds-kneel.md | Documents the changes for both affected packages |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
spastorelli
approved these changes
Nov 21, 2025
nolannbiron
force-pushed
the
nolann/add-x-prefix-to-securities
branch
from
eb05e7c to
8747382
Compare
nolannbiron
changed the title
x-prefix and x-placeholder for OpenAPI security schemex-gitbook-prefix and x-gitbook-token-placeholder for OpenAPI security scheme
nolannbiron
force-pushed
the
nolann/add-x-prefix-to-securities
branch
from
da84310 to
d24d597
Compare
nolannbiron
force-pushed
the
nolann/add-x-prefix-to-securities
branch
from
d24d597 to
675d8da
Compare
clairechabas
added a commit
that referenced
this pull request
Dec 3, 2025
…ption * main: (45 commits) Remove corner radius of hint block with heading (#3839) Make semantic text colors more vibrant (#3838) Fix hidden section not found (#3836) Update AIChat context card open delay (#3834) Support for hidden sections (#3831) Make annotations visible on hover, fix accessibility and outro animations (#3822) Replace AI Chat generated content in e2e (#3833) Remove sticky prop on Updates block (#3832) Stop filtering by language when site space language is unspecified (#3825) Fix flaky tests in AI Chat greeting (#3828) Add RSS feed for pages with update blocks (#3824) Prevent flaky tests in AI Chat followup suggestions (#3827) Update wranglerVersion to 4.43.0 (#3826) Update Assistant e2e tests (#3814) Update Assistant styling (#3797) Add `x-gitbook-prefix` and `x-gitbook-token-placeholder` for OpenAPI security scheme (#3820) Add 'use server' directive to markdown renderer (#3815) Improve OpenAPI circular references (#3821) Fix links to other spaces in embeddable view (#3819) Optimise page outline (#3813) ...
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.
No description provided.