Skip to content

Add JWT authentication flow documentation #1752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+563 −0
Open

Add JWT authentication flow documentation #1752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c8e2aed
docs: add JWT authentication flow for protected endpoints
devin-ai-integration[bot] Nov 4, 2025
cf33cb2
docs: add MCP server API reference with OpenAPI spec
devin-ai-integration[bot] Nov 4, 2025
b3c5a85
fix: resolve CI failures and Vale linting errors
devin-ai-integration[bot] Nov 4, 2025
68aa6c5
feat: add Fern API definition for MCP endpoints
devin-ai-integration[bot] Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions fern/apis/fern-docs-mcp/generators.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
api:
specs:
- openapi: openapi.json
231 changes: 231 additions & 0 deletions fern/apis/fern-docs-mcp/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,231 @@
{
"openapi": "3.1.0",
"info": {
"title": "Fern Docs MCP API",
"version": "1.0.0",
"description": "API endpoints for MCP agents to authenticate and search Fern documentation sites."
},
"servers": [
{
"url": "https://docs.example.com",
"description": "Your documentation domain"
}
],
"paths": {
"/api/fern-docs/get-jwt": {
"get": {
"summary": "Exchange an API key for a JWT",
"description": "Exchange a Fern API key for a JWT token that can be used to access protected documentation endpoints.",
"operationId": "getJwt",
"parameters": [
{
"name": "FERN_API_KEY",
"in": "header",
"required": true,
"schema": {
"type": "string"
},
"description": "Your Fern API key"
},
{
"name": "ROLES",
"in": "header",
"required": false,
"schema": {
"type": "string"
},
"description": "Comma-separated list of roles (e.g., \"botanist,seedling\")"
},
{
"name": "x-fern-host",
"in": "header",
"required": false,
"schema": {
"type": "string"
},
"description": "Documentation domain (required on preview URLs)"
}
],
"responses": {
"200": {
"description": "Successfully generated JWT",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fern_token": {
"type": "string",
"description": "JWT token for authenticating subsequent requests"
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Roles included in the JWT"
}
},
"required": ["fern_token", "roles"]
}
}
}
},
"400": {
"description": "Bad request (local preview, self-hosted, or SSO environment)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
}
}
},
"401": {
"description": "Unauthorized (missing or invalid API key)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
}
}
},
"403": {
"description": "Forbidden (API key does not belong to organization)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/api/fern-docs/search/v2/key": {
"get": {
"summary": "Get search credentials",
"description": "Retrieve Algolia search credentials for querying documentation. Supports API key or JWT authentication.",
"operationId": "getSearchKey",
"parameters": [
{
"name": "FERN_API_KEY",
"in": "header",
"required": false,
"schema": {
"type": "string"
},
"description": "Your Fern API key (Option 1)"
},
{
"name": "FERN_TOKEN",
"in": "header",
"required": false,
"schema": {
"type": "string"
},
"description": "JWT token from /api/fern-docs/get-jwt (Option 2)"
},
{
"name": "ROLES",
"in": "header",
"required": false,
"schema": {
"type": "string"
},
"description": "Comma-separated list of roles (only with FERN_API_KEY)"
},
{
"name": "X-User-Token",
"in": "header",
"required": false,
"schema": {
"type": "string"
},
"description": "Optional user identifier for analytics"
},
{
"name": "x-fern-host",
"in": "header",
"required": false,
"schema": {
"type": "string"
},
"description": "Documentation domain (required on preview URLs)"
}
],
"responses": {
"200": {
"description": "Successfully retrieved search credentials",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"appId": {
"type": "string",
"description": "Algolia application ID"
},
"apiKey": {
"type": "string",
"description": "Short-lived Algolia search API key"
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Roles included in the search key (only with FERN_API_KEY auth)"
}
},
"required": ["appId", "apiKey"]
}
}
}
},
"400": {
"description": "Bad request (local preview or unsupported preview URL)"
},
"401": {
"description": "Unauthorized (invalid API key)"
},
"403": {
"description": "Forbidden (API key does not belong to organization)"
}
}
}
}
}
}
2 changes: 2 additions & 0 deletions fern/products/ask-fern/ask-fern.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ navigation:
path: ./pages/features/insights.mdx
- page: Evaluation
path: ./pages/features/evals.mdx
- page: MCP server for your site
path: ./pages/features/mcp-server.mdx
- page: Role-based access control
path: ./pages/features/rbac.mdx
- page: Slack app
Expand Down
Loading
Loading