-
Notifications
You must be signed in to change notification settings - Fork 3
Add docs and API Reference for AI tooling #1763
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.
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
kennyderek
wants to merge
1
commit into
main
Choose a base branch
from
kenny/add-ai-tooling-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+233
−3
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| api: | ||
| specs: | ||
| - openapi: openapi.json |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,209 @@ | ||
| { | ||
| "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" | ||
| } | ||
| ], | ||
| "components": { | ||
| "securitySchemes": { | ||
| "FernApiKey": { | ||
| "type": "apiKey", | ||
| "in": "header", | ||
| "name": "FERN_API_KEY", | ||
| "description": "Fern API key, from `fern generate token`." | ||
| }, | ||
| "FernToken": { | ||
| "type": "apiKey", | ||
| "in": "header", | ||
| "name": "FERN_TOKEN", | ||
| "description": "JWT token for this user." | ||
| } | ||
| } | ||
| }, | ||
| "paths": { | ||
| "/api/fern-docs/get-jwt": { | ||
| "get": { | ||
| "summary": "JWT from Fern API key", | ||
| "description": "Get a JWT to access protected documentation endpoints, optionally scoped to specific roles.", | ||
| "operationId": "getJwt", | ||
| "security": [ | ||
| { | ||
| "FernApiKey": [] | ||
| } | ||
| ], | ||
| "parameters": [ | ||
| { | ||
| "name": "ROLES", | ||
| "in": "header", | ||
| "required": false, | ||
| "schema": { | ||
| "type": "string" | ||
| }, | ||
| "description": "Comma-separated list of roles (e.g., \"botanist,seedling\"). Sets roles for returned JWT if provided, otherwise, roles are empty." | ||
| }, | ||
| { | ||
| "name": "x-fern-host", | ||
| "in": "header", | ||
| "required": false, | ||
| "schema": { | ||
| "type": "string" | ||
| }, | ||
| "description": "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 this domain's Fern organization)", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "type": "object", | ||
| "properties": { | ||
| "error": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/api/fern-docs/search/v2/key": { | ||
| "get": { | ||
| "summary": "Algolia search credentials", | ||
| "description": "Get Algolia search credentials for querying documentation.", | ||
| "operationId": "getSearchKey", | ||
| "security": [ | ||
| { | ||
| "FernApiKey": [] | ||
| }, | ||
| { | ||
| "FernToken": [] | ||
| } | ||
| ], | ||
| "parameters": [ | ||
| { | ||
| "name": "ROLES", | ||
| "in": "header", | ||
| "required": false, | ||
| "schema": { | ||
| "type": "string" | ||
| }, | ||
| "description": "Comma-separated list of roles (only with FERN_API_KEY). Sets roles for returned search key if provided, otherwise, roles are empty." | ||
| }, | ||
| { | ||
| "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 Fern API key)" | ||
| }, | ||
| "403": { | ||
| "description": "Forbidden (API key does not belong to this domain's Fern organization)" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Additional AI Tooling' should use sentence-style capitalization.