From 6e64be9546e35a3c97ae390a9b86e4d19a484f56 Mon Sep 17 00:00:00 2001 From: Kenny Derek Date: Mon, 9 Mar 2026 12:47:55 -0400 Subject: [PATCH] test merge --- fern/apis/fai/ai_examples_override.yml | 487 ++++++++++++++++++ fern/apis/fai/openapi.json | 502 ++++++++++++++++--- fern/apis/mcp-tools/ai_examples_override.yml | 32 ++ fern/fern.config.json | 2 +- 4 files changed, 963 insertions(+), 60 deletions(-) create mode 100644 fern/apis/fai/ai_examples_override.yml create mode 100644 fern/apis/mcp-tools/ai_examples_override.yml diff --git a/fern/apis/fai/ai_examples_override.yml b/fern/apis/fai/ai_examples_override.yml new file mode 100644 index 000000000..37bbd779a --- /dev/null +++ b/fern/apis/fai/ai_examples_override.yml @@ -0,0 +1,487 @@ +paths: + /code/domain/create: + post: + x-fern-examples: + - path-parameters: + domain: domain + request: + document: |- + def calculate_area(radius): + """Calculate the area of a circle given its radius.""" + import math + return math.pi * radius ** 2 + response: + body: + - code_id: a1b2c3d4-e5f6-7890-ab12-cd34ef567890 + /chat/domain: + post: + x-fern-examples: + - path-parameters: + domain: domain + request: + messages: + - role: user + content: Can you explain the benefits of using the Claude-4.5-sonnet model for natural language processing tasks? + response: + body: + turns: + - role: user + content: Can you explain the benefits of using the Claude-4.5-sonnet model for natural language processing tasks? + - role: assistant + content: The Claude-4.5-sonnet model offers enhanced contextual understanding and poetic language generation, making it ideal for creative writing and nuanced conversational AI applications. + citations: + - https://docs.anthropic.com/claude/claude-4.5-sonnet + /code/domain/code_id: + get: + x-fern-examples: + - path-parameters: + domain: domain + code_id: code_id + response: + body: + document: + code_id: A12345 + domain: finance + chunk: 'Section 4.2: Interest Rate Calculations' + document: This section outlines the methodology for calculating interest rates on variable loans, including compounding periods and applicable fees. + title: Interest Rate Calculation Guidelines + url: https://fai.buildwithfern.com/docs/finance/interest-rate-calculation + version: v2.1.0 + product: Loan Management System + keywords: + - interest + - loan + - finance + - calculation + authed: true + created_at: '2024-01-15T09:30:00Z' + updated_at: '2024-01-15T09:30:00Z' + /conversation/domain/conversation_id: + get: + x-fern-examples: + - path-parameters: + domain: customer-support + conversation_id: a1b2c3d4-e5f6-7890-ab12-cd34ef567890 + response: + body: + conversation: + conversation_id: a1b2c3d4-e5f6-7890-ab12-cd34ef567890 + created_at: '2024-01-15T09:30:00Z' + turns: + - role: user + text: Hi, I need help with my recent order. + created_at: '2024-01-15T09:31:00Z' + feedback: + is_helpful: true + feedback_message: The response was clear and resolved my issue. + /guidance/domain: + get: + x-fern-examples: + - path-parameters: + domain: cybersecurity + query-parameters: + page: 1 + limit: 10 + response: + body: + guidances: + - domain: cybersecurity + context: + - network security + - data protection + document: Ensure all endpoints are secured with multi-factor authentication and encrypted communication channels. + guidance_id: guidance-12345 + created_at: '2024-01-15T09:30:00Z' + updated_at: '2024-04-10T14:45:00Z' + pagination: + total: 25 + page: 1 + limit: 10 + /code/domain/batch-create: + post: + x-fern-examples: + - path-parameters: + domain: domain + request: + - document: |- + def calculate_sum(a, b): + """Calculate the sum of two numbers.""" + return a + b + response: + body: + - code_id: cde12345-6789-4abc-def0-1234567890ab + /document/domain: + get: + x-fern-examples: + - path-parameters: + domain: domain + response: + body: + documents: + - document_id: d3f9a7b2-8c4e-4f1a-9b2e-5a7c3d9e8f12 + domain: example.com + chunk: Introduction to the product features and benefits. + document: This document provides an overview of the key features and benefits of our software product, including installation instructions and usage guidelines. + title: Product Overview + url: https://example.com/docs/product-overview + version: 1.2.0 + product: Example Software Suite + keywords: + - product + - overview + - features + - installation + authed: false + created_at: '2024-01-15T09:30:00Z' + updated_at: '2024-01-15T09:30:00Z' + pagination: + total: 1 + page: 1 + limit: 10 + /document/domain/batch-delete: + delete: + x-fern-examples: + - path-parameters: + domain: domain + request: + - document_id: d4f5e6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7g + - document_id: a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d + response: + body: + success: true + /document/domain/delete: + delete: + x-fern-examples: + - path-parameters: + domain: domain + request: + document_id: doc_9f8b7c6a-1234-4d56-8e90-abcdef123456 + response: + body: + success: true + /code/domain/delete-all: + delete: + x-fern-examples: + - path-parameters: + domain: domain + response: + body: + success: true + /document/domain/create: + post: + x-fern-examples: + - path-parameters: + domain: domain + request: + document: This document provides an overview of the new API integration guidelines for the FAI platform, including authentication, request formatting, and error handling. + response: + body: + - document_id: a1b2c3d4-e5f6-7890-ab12-cd34ef567890 + /document/domain/batch-create: + post: + x-fern-examples: + - path-parameters: + domain: domain + request: + - document: This document provides an overview of the new API integration guidelines for the FAI platform, including authentication, request formatting, and error handling. + response: + body: + - document_id: d4f8a9e2-3b7c-4f1a-9c2e-8a7b6d5f9e12 + /document/domain/delete-all: + delete: + x-fern-examples: + - path-parameters: + domain: domain + response: + body: + success: true + /code/domain: + get: + x-fern-examples: + - path-parameters: + domain: domain + response: + body: + documents: + - code_id: cde12345-6789-4abc-def0-1234567890ab + domain: finance + chunk: function calculateInterest(principal, rate, time) { return principal * rate * time / 100; } + document: Interest calculation module for financial applications + title: Interest Calculator + url: https://finance.example.com/docs/interest-calculator + version: 1.2.3 + product: FinanceAPI + keywords: + - interest + - finance + - calculation + authed: true + created_at: '2024-01-15T09:30:00Z' + updated_at: '2024-01-15T09:30:00Z' + pagination: + total: 1 + page: 1 + limit: 1 + /code/domain/delete: + delete: + x-fern-examples: + - path-parameters: + domain: domain + request: + code_id: abc123xyz789 + response: + body: + success: true + /document/domain/document_id: + get: + x-fern-examples: + - path-parameters: + domain: domain + document_id: document_id + response: + body: + document: + document_id: a1b2c3d4-e5f6-7890-ab12-cd34ef567890 + domain: finance + chunk: 'Section 1: Introduction to Financial Regulations' + document: This document outlines the key financial regulations applicable to investment firms in 2024. + title: Financial Regulations Overview 2024 + url: https://finance.example.com/docs/financial-regulations-2024 + version: 1.3.0 + product: Investment Compliance Suite + keywords: + - finance + - regulations + - investment + - compliance + authed: true + created_at: '2024-01-15T09:30:00Z' + updated_at: '2024-01-15T09:30:00Z' + patch: + x-fern-examples: + - path-parameters: + domain: domain + document_id: document_id + response: + body: + document: + document_id: a1b2c3d4-e5f6-7890-ab12-cd34ef567890 + domain: example.com + chunk: This is a sample chunk of text extracted from the document for indexing purposes. + document: This document provides detailed information about the API usage and integration guidelines. + title: API Integration Guide + url: https://example.com/api-integration-guide + version: v2.3.1 + product: ExampleAPI + keywords: + - API + - integration + - guide + - documentation + authed: true + created_at: '2024-01-15T09:30:00Z' + updated_at: '2024-01-15T09:30:00Z' + /queries/domain: + get: + x-fern-examples: + - path-parameters: + domain: example.com + query-parameters: + page: 1 + limit: 10 + cutoff_time: '2024-01-01T00:00:00Z' + include_assistant: true + start_date: '2023-12-01T00:00:00Z' + end_date: '2024-01-15T23:59:59Z' + response: + body: + queries: + - query_id: q1234567890abcdef + conversation_id: conv9876543210fedcba + domain: example.com + text: How do I reset my password? + role: user + source: web + created_at: '2024-01-15T09:30:00Z' + time_to_first_token: 1.1 + subqueries: + - password reset instructions + - account recovery options + pagination: + total: 25 + page: 1 + limit: 10 + /guidance/domain/guidance_id: + delete: + x-fern-examples: + - path-parameters: + domain: domain + guidance_id: guidance_id + response: + body: + success: true + get: + x-fern-examples: + - path-parameters: + domain: domain + guidance_id: guidance_id + response: + body: + guidance: + domain: cybersecurity + context: + - network security + - data protection + document: Ensure all endpoints use TLS 1.2 or higher to encrypt data in transit and prevent interception. + guidance_id: guidance-12345 + created_at: '2024-01-15T09:30:00Z' + updated_at: '2024-01-15T09:30:00Z' + patch: + x-fern-examples: + - path-parameters: + domain: domain + guidance_id: guidance_id + response: + body: + guidance: + domain: healthcare + context: + - patient safety + - clinical protocols + - emergency procedures + document: This guidance document outlines the updated clinical protocols for patient safety in emergency situations, including triage procedures and medication administration. + guidance_id: a1b2c3d4-e5f6-7890-ab12-cd34ef567890 + created_at: '2024-01-15T09:30:00Z' + updated_at: '2024-01-15T09:30:00Z' + /sources/website/domain/status: + get: + x-fern-examples: + - path-parameters: + domain: domain + query-parameters: + job_id: job_id + response: + body: + job_id: a1b2c3d4-e5f6-7890-ab12-cd34ef567890 + status: PROCESSING + base_url: https://example.com + pages_indexed: 42 + pages_failed: 3 + error: null + /discord/install: + post: + x-fern-examples: + - query-parameters: + domain: domain + response: + body: + integration_url: https://discord.com/api/oauth2/authorize?client_id=123456789012345678&permissions=2048&scope=bot + /sources/website/domain/index: + post: + x-fern-examples: + - path-parameters: + domain: domain + request: + base_url: https://docs.buildwithfern.com + response: + body: + job_id: a1b2c3d4-e5f6-7890-ab12-cd34ef567890 + base_url: https://docs.buildwithfern.com + /sources/website/domain/delete: + delete: + x-fern-examples: + - path-parameters: + domain: domain + request: + base_url: https://www.example.com + response: + body: + success: true + pages_deleted: 42 + /guidance/domain/create: + post: + x-fern-examples: + - path-parameters: + domain: domain + request: + context: + - Employee handbook policies + - Remote work guidelines + - Health and safety regulations + document: This guidance document outlines the company's policies on remote work, including eligibility, communication expectations, and cybersecurity best practices to ensure a secure and productive work environment. + response: + body: + guidance_id: a1b2c3d4-e5f6-7890-ab12-cd34ef567890 + /sources/website/domain: + get: + x-fern-examples: + - path-parameters: + domain: domain + response: + body: + websites: + - website_id: a1b2c3d4-e5f6-7890-ab12-cd34ef567890 + domain: example.com + base_url: https://example.com + page_url: https://example.com/products/widget + chunk: This is a sample chunk of text extracted from the webpage content for indexing purposes. + document: Widget Product PageDetails about the widget product. + title: Widget Product Page + version: 1.0.3 + product: Widget + keywords: + - widget + - product + - example + authed: false + created_at: '2024-01-15T09:30:00Z' + updated_at: '2024-01-15T09:30:00Z' + pagination: + total: 25 + page: 1 + limit: 10 + /sources/website/domain/reindex: + post: + x-fern-examples: + - path-parameters: + domain: domain + request: + base_url: https://www.example.com + response: + body: + job_id: a1b2c3d4-e5f6-7890-ab12-cd34ef567890 + base_url: https://www.example.com + /sources/website/domain/delete-all: + delete: + x-fern-examples: + - path-parameters: + domain: domain + response: + body: + success: true + pages_deleted: 42 + /sources/website/domain/website_id: + get: + x-fern-examples: + - path-parameters: + domain: domain + website_id: website_id + response: + body: + website: + website_id: a1b2c3d4-e5f6-7890-ab12-cd34ef567890 + domain: example.com + base_url: https://example.com + page_url: https://example.com/products/widget-123 + chunk:

Introducing our latest widget, designed for efficiency and durability.

+ document: Widget 123 - Example.com

Widget 123

Details about widget 123.

+ title: Widget 123 - Example.com + version: 1.0.3 + product: Widget 123 + keywords: + - widget + - product + - example + authed: false + created_at: '2024-01-15T09:30:00Z' + updated_at: '2024-01-15T09:30:00Z' diff --git a/fern/apis/fai/openapi.json b/fern/apis/fai/openapi.json index 7b7df4a9f..835a41f67 100644 --- a/fern/apis/fai/openapi.json +++ b/fern/apis/fai/openapi.json @@ -379,7 +379,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "requestBody": { @@ -399,6 +400,21 @@ "application/json": { "schema": { "$ref": "#/components/schemas/PostChatCompletionResponse" + }, + "example": { + "turns": [ + { + "role": "user", + "content": "Can you explain the benefits of using the Claude-4.5-sonnet model for natural language processing tasks?" + }, + { + "role": "assistant", + "content": "The Claude-4.5-sonnet model offers enhanced contextual understanding and poetic language generation, making it ideal for creative writing and nuanced conversational AI applications." + } + ], + "citations": [ + "https://docs.anthropic.com/claude/claude-4.5-sonnet" + ] } } } @@ -439,7 +455,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "requestBody": { @@ -463,7 +480,12 @@ "$ref": "#/components/schemas/CreateCodeRecordResponse" }, "title": "Response Create Code Record Code Domain Create Post" - } + }, + "example": [ + { + "code_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890" + } + ] } } }, @@ -503,7 +525,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "requestBody": { @@ -531,7 +554,12 @@ "$ref": "#/components/schemas/CreateCodeRecordResponse" }, "title": "Response Batch Create Code Records Code Domain Batch Create Post" - } + }, + "example": [ + { + "code_id": "cde12345-6789-4abc-def0-1234567890ab" + } + ] } } }, @@ -571,7 +599,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" }, { "name": "code_id", @@ -580,7 +609,8 @@ "schema": { "type": "string", "title": "Code Id" - } + }, + "example": "code_id" } ], "responses": { @@ -590,6 +620,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GetCodeRecordResponse" + }, + "example": { + "document": { + "code_id": "A12345", + "domain": "finance", + "chunk": "Section 4.2: Interest Rate Calculations", + "document": "This section outlines the methodology for calculating interest rates on variable loans, including compounding periods and applicable fees.", + "title": "Interest Rate Calculation Guidelines", + "url": "https://fai.buildwithfern.com/docs/finance/interest-rate-calculation", + "version": "v2.1.0", + "product": "Loan Management System", + "keywords": [ + "interest", + "loan", + "finance", + "calculation" + ], + "authed": true, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } } } } @@ -630,7 +681,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" }, { "name": "page", @@ -676,6 +728,33 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GetCodeRecordsResponse" + }, + "example": { + "documents": [ + { + "code_id": "cde12345-6789-4abc-def0-1234567890ab", + "domain": "finance", + "chunk": "function calculateInterest(principal, rate, time) { return principal * rate * time / 100; }", + "document": "Interest calculation module for financial applications", + "title": "Interest Calculator", + "url": "https://finance.example.com/docs/interest-calculator", + "version": "1.2.3", + "product": "FinanceAPI", + "keywords": [ + "interest", + "finance", + "calculation" + ], + "authed": true, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ], + "pagination": { + "total": 1, + "page": 1, + "limit": 1 + } } } } @@ -716,7 +795,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "requestBody": { @@ -736,6 +816,9 @@ "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCodeRecordResponse" + }, + "example": { + "success": true } } } @@ -776,7 +859,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "responses": { @@ -786,6 +870,9 @@ "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCodeRecordResponse" + }, + "example": { + "success": true } } } @@ -1060,7 +1147,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "customer-support" }, { "name": "conversation_id", @@ -1069,7 +1157,8 @@ "schema": { "type": "string", "title": "Conversation Id" - } + }, + "example": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890" } ], "responses": { @@ -1079,6 +1168,23 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GetConversationResponse" + }, + "example": { + "conversation": { + "conversation_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", + "created_at": "2024-01-15T09:30:00Z", + "turns": [ + { + "role": "user", + "text": "Hi, I need help with my recent order.", + "created_at": "2024-01-15T09:31:00Z", + "feedback": { + "is_helpful": true, + "feedback_message": "The response was clear and resolved my issue." + } + } + ] + } } } } @@ -1119,7 +1225,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "responses": { @@ -1129,6 +1236,9 @@ "application/json": { "schema": { "$ref": "#/components/schemas/DiscordIntegrationResponse" + }, + "example": { + "integration_url": "https://discord.com/api/oauth2/authorize?client_id=123456789012345678&permissions=2048&scope=bot" } } } @@ -1191,7 +1301,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "requestBody": { @@ -1215,7 +1326,12 @@ "$ref": "#/components/schemas/CreateDocumentResponse" }, "title": "Response Create Document Document Domain Create Post" - } + }, + "example": [ + { + "document_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890" + } + ] } } }, @@ -1255,7 +1371,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "requestBody": { @@ -1283,7 +1400,12 @@ "$ref": "#/components/schemas/CreateDocumentResponse" }, "title": "Response Batch Create Document Document Domain Batch Create Post" - } + }, + "example": [ + { + "document_id": "d4f8a9e2-3b7c-4f1a-9c2e-8a7b6d5f9e12" + } + ] } } }, @@ -1323,7 +1445,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" }, { "name": "document_id", @@ -1332,7 +1455,8 @@ "schema": { "type": "string", "title": "Document Id" - } + }, + "example": "document_id" } ], "requestBody": { @@ -1352,6 +1476,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDocumentResponse" + }, + "example": { + "document": { + "document_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", + "domain": "example.com", + "chunk": "This is a sample chunk of text extracted from the document for indexing purposes.", + "document": "This document provides detailed information about the API usage and integration guidelines.", + "title": "API Integration Guide", + "url": "https://example.com/api-integration-guide", + "version": "v2.3.1", + "product": "ExampleAPI", + "keywords": [ + "API", + "integration", + "guide", + "documentation" + ], + "authed": true, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } } } } @@ -1390,7 +1535,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" }, { "name": "document_id", @@ -1399,7 +1545,8 @@ "schema": { "type": "string", "title": "Document Id" - } + }, + "example": "document_id" } ], "responses": { @@ -1409,6 +1556,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentResponse" + }, + "example": { + "document": { + "document_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", + "domain": "finance", + "chunk": "Section 1: Introduction to Financial Regulations", + "document": "This document outlines the key financial regulations applicable to investment firms in 2024.", + "title": "Financial Regulations Overview 2024", + "url": "https://finance.example.com/docs/financial-regulations-2024", + "version": "1.3.0", + "product": "Investment Compliance Suite", + "keywords": [ + "finance", + "regulations", + "investment", + "compliance" + ], + "authed": true, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } } } } @@ -1449,7 +1617,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "requestBody": { @@ -1469,6 +1638,9 @@ "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDocumentResponse" + }, + "example": { + "success": true } } } @@ -1509,7 +1681,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "requestBody": { @@ -1533,6 +1706,9 @@ "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDocumentResponse" + }, + "example": { + "success": true } } } @@ -1573,7 +1749,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" }, { "name": "page", @@ -1619,6 +1796,34 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentsResponse" + }, + "example": { + "documents": [ + { + "document_id": "d3f9a7b2-8c4e-4f1a-9b2e-5a7c3d9e8f12", + "domain": "example.com", + "chunk": "Introduction to the product features and benefits.", + "document": "This document provides an overview of the key features and benefits of our software product, including installation instructions and usage guidelines.", + "title": "Product Overview", + "url": "https://example.com/docs/product-overview", + "version": "1.2.0", + "product": "Example Software Suite", + "keywords": [ + "product", + "overview", + "features", + "installation" + ], + "authed": false, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ], + "pagination": { + "total": 1, + "page": 1, + "limit": 10 + } } } } @@ -1659,7 +1864,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "responses": { @@ -1669,6 +1875,9 @@ "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDocumentResponse" + }, + "example": { + "success": true } } } @@ -1823,7 +2032,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "requestBody": { @@ -1843,6 +2053,9 @@ "application/json": { "schema": { "$ref": "#/components/schemas/CreateGuidanceResponse" + }, + "example": { + "guidance_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890" } } } @@ -1883,7 +2096,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" }, { "name": "guidance_id", @@ -1892,7 +2106,8 @@ "schema": { "type": "string", "title": "Guidance Id" - } + }, + "example": "guidance_id" } ], "requestBody": { @@ -1912,6 +2127,20 @@ "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGuidanceResponse" + }, + "example": { + "guidance": { + "domain": "healthcare", + "context": [ + "patient safety", + "clinical protocols", + "emergency procedures" + ], + "document": "This guidance document outlines the updated clinical protocols for patient safety in emergency situations, including triage procedures and medication administration.", + "guidance_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } } } } @@ -1950,7 +2179,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" }, { "name": "guidance_id", @@ -1959,7 +2189,8 @@ "schema": { "type": "string", "title": "Guidance Id" - } + }, + "example": "guidance_id" } ], "responses": { @@ -1969,6 +2200,9 @@ "application/json": { "schema": { "$ref": "#/components/schemas/DeleteGuidanceResponse" + }, + "example": { + "success": true } } } @@ -2007,7 +2241,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" }, { "name": "guidance_id", @@ -2016,7 +2251,8 @@ "schema": { "type": "string", "title": "Guidance Id" - } + }, + "example": "guidance_id" } ], "responses": { @@ -2026,6 +2262,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GetGuidanceResponse" + }, + "example": { + "guidance": { + "domain": "cybersecurity", + "context": [ + "network security", + "data protection" + ], + "document": "Ensure all endpoints use TLS 1.2 or higher to encrypt data in transit and prevent interception.", + "guidance_id": "guidance-12345", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } } } } @@ -2066,7 +2315,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "cybersecurity" }, { "name": "page", @@ -2084,7 +2334,8 @@ "description": "The page number for pagination", "title": "Page" }, - "description": "The page number for pagination" + "description": "The page number for pagination", + "example": 1 }, { "name": "limit", @@ -2102,7 +2353,8 @@ "description": "The number of documents per page", "title": "Limit" }, - "description": "The number of documents per page" + "description": "The number of documents per page", + "example": 10 } ], "responses": { @@ -2112,6 +2364,26 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GetGuidancesResponse" + }, + "example": { + "guidances": [ + { + "domain": "cybersecurity", + "context": [ + "network security", + "data protection" + ], + "document": "Ensure all endpoints are secured with multi-factor authentication and encrypted communication channels.", + "guidance_id": "guidance-12345", + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-04-10T14:45:00Z" + } + ], + "pagination": { + "total": 25, + "page": 1, + "limit": 10 + } } } } @@ -2570,7 +2842,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "example.com" }, { "name": "page", @@ -2588,7 +2861,8 @@ "description": "The page number for pagination", "title": "Page" }, - "description": "The page number for pagination" + "description": "The page number for pagination", + "example": 1 }, { "name": "limit", @@ -2606,7 +2880,8 @@ "description": "The number of queries per page", "title": "Limit" }, - "description": "The number of queries per page" + "description": "The number of queries per page", + "example": 10 }, { "name": "cutoff_time", @@ -2625,7 +2900,8 @@ "description": "Only return queries after this time", "title": "Cutoff Time" }, - "description": "Only return queries after this time" + "description": "Only return queries after this time", + "example": "2024-01-01T00:00:00Z" }, { "name": "include_assistant", @@ -2643,7 +2919,8 @@ "description": "Whether to include assistant responses in the results", "title": "Include Assistant" }, - "description": "Whether to include assistant responses in the results" + "description": "Whether to include assistant responses in the results", + "example": true }, { "name": "start_date", @@ -2662,7 +2939,8 @@ "description": "The start date of the period to retrieve analytics for", "title": "Start Date" }, - "description": "The start date of the period to retrieve analytics for" + "description": "The start date of the period to retrieve analytics for", + "example": "2023-12-01T00:00:00Z" }, { "name": "end_date", @@ -2681,7 +2959,8 @@ "description": "The end date of the period to retrieve analytics for", "title": "End Date" }, - "description": "The end date of the period to retrieve analytics for" + "description": "The end date of the period to retrieve analytics for", + "example": "2024-01-15T23:59:59Z" } ], "responses": { @@ -2691,6 +2970,29 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GetQueriesResponse" + }, + "example": { + "queries": [ + { + "query_id": "q1234567890abcdef", + "conversation_id": "conv9876543210fedcba", + "domain": "example.com", + "text": "How do I reset my password?", + "role": "user", + "source": "web", + "created_at": "2024-01-15T09:30:00Z", + "time_to_first_token": 1.1, + "subqueries": [ + "password reset instructions", + "account recovery options" + ] + } + ], + "pagination": { + "total": 25, + "page": 1, + "limit": 10 + } } } } @@ -4089,7 +4391,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "requestBody": { @@ -4109,6 +4412,10 @@ "application/json": { "schema": { "$ref": "#/components/schemas/IndexWebsiteResponse" + }, + "example": { + "job_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", + "base_url": "https://docs.buildwithfern.com" } } } @@ -4150,7 +4457,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" }, { "name": "job_id", @@ -4161,7 +4469,8 @@ "description": "The job ID returned from the index endpoint", "title": "Job Id" }, - "description": "The job ID returned from the index endpoint" + "description": "The job ID returned from the index endpoint", + "example": "job_id" } ], "responses": { @@ -4171,6 +4480,14 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GetWebsiteStatusResponse" + }, + "example": { + "job_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", + "status": "PROCESSING", + "base_url": "https://example.com", + "pages_indexed": 42, + "pages_failed": 3, + "error": null } } } @@ -4212,7 +4529,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" }, { "name": "website_id", @@ -4221,7 +4539,8 @@ "schema": { "type": "string", "title": "Website Id" - } + }, + "example": "website_id" } ], "responses": { @@ -4231,6 +4550,27 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GetWebsiteResponse" + }, + "example": { + "website": { + "website_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", + "domain": "example.com", + "base_url": "https://example.com", + "page_url": "https://example.com/products/widget-123", + "chunk": "

Introducing our latest widget, designed for efficiency and durability.

", + "document": "Widget 123 - Example.com

Widget 123

Details about widget 123.

", + "title": "Widget 123 - Example.com", + "version": "1.0.3", + "product": "Widget 123", + "keywords": [ + "widget", + "product", + "example" + ], + "authed": false, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } } } } @@ -4272,7 +4612,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" }, { "name": "page", @@ -4306,6 +4647,34 @@ "application/json": { "schema": { "$ref": "#/components/schemas/GetWebsitesResponse" + }, + "example": { + "websites": [ + { + "website_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", + "domain": "example.com", + "base_url": "https://example.com", + "page_url": "https://example.com/products/widget", + "chunk": "This is a sample chunk of text extracted from the webpage content for indexing purposes.", + "document": "Widget Product PageDetails about the widget product.", + "title": "Widget Product Page", + "version": "1.0.3", + "product": "Widget", + "keywords": [ + "widget", + "product", + "example" + ], + "authed": false, + "created_at": "2024-01-15T09:30:00Z", + "updated_at": "2024-01-15T09:30:00Z" + } + ], + "pagination": { + "total": 25, + "page": 1, + "limit": 10 + } } } } @@ -4347,7 +4716,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "requestBody": { @@ -4367,6 +4737,10 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ReindexWebsiteResponse" + }, + "example": { + "job_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", + "base_url": "https://www.example.com" } } } @@ -4408,7 +4782,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "requestBody": { @@ -4428,6 +4803,10 @@ "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWebsiteResponse" + }, + "example": { + "success": true, + "pages_deleted": 42 } } } @@ -4469,7 +4848,8 @@ "schema": { "type": "string", "title": "Domain" - } + }, + "example": "domain" } ], "responses": { @@ -4479,6 +4859,10 @@ "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAllWebsitesResponse" + }, + "example": { + "success": true, + "pages_deleted": 42 } } } @@ -4537,7 +4921,7 @@ } ], "title": "Previous Version", - "description": "The current published version before this change, e.g. '1.2.3'. Provided for context only \u2014 not included in the commit message.", + "description": "The current published version before this change, e.g. '1.2.3'. Provided for context only — not included in the commit message.", "default": null }, "prior_changelog": { @@ -4610,15 +4994,15 @@ }, "limit": { "type": "integer", - "maximum": 1000.0, - "minimum": 1.0, + "maximum": 1000, + "minimum": 1, "title": "Limit", "description": "The number of content hashes to return", "default": 1000 }, "offset": { "type": "integer", - "minimum": 0.0, + "minimum": 0, "title": "Offset", "description": "The offset to start from", "default": 0 @@ -6391,7 +6775,7 @@ ], "title": "Delay", "description": "Delay in seconds between requests", - "default": 1.0 + "default": 1 }, "version": { "anyOf": [ @@ -6674,8 +7058,8 @@ "anyOf": [ { "type": "integer", - "maximum": 3500.0, - "minimum": 100.0 + "maximum": 3500, + "minimum": 100 }, { "type": "null" @@ -7699,4 +8083,4 @@ "x-fern-server-name": "Local" } ] -} +} \ No newline at end of file diff --git a/fern/apis/mcp-tools/ai_examples_override.yml b/fern/apis/mcp-tools/ai_examples_override.yml new file mode 100644 index 000000000..b0df3e932 --- /dev/null +++ b/fern/apis/mcp-tools/ai_examples_override.yml @@ -0,0 +1,32 @@ +paths: + /api/fern-docs/get-jwt: + get: + x-fern-examples: + - response: + body: + fern_token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlcyI6WyJib3RhbmlzdCIsInNlZWRsaW5nIl0sImlhdCI6MTY4NjQ3MjAwMCwiZXhwIjoxNjg2NDc1NjAwfQ.4X9v7Q9Xq3v7X9v7Q9Xq3v7X9v7Q9Xq3v7X9v7Q9Xq3v7 + roles: + - botanist + - seedling + /api/fern-docs/whoami: + get: + x-fern-examples: + - response: + body: + fern_token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Njc4OSIsIm5hbWUiOiJKYW5lIERvZSIsImVtYWlsIjoiamFuZS5kb2VAZXhhbXBsZS5jb20iLCJyb2xlcyI6WyJhZG1pbiIsInVzZXIiXX0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c + user_info: + name: Jane Doe + email: jane.doe@example.com + roles: + - admin + - user + /api/fern-docs/search/v2/key: + get: + x-fern-examples: + - response: + body: + appId: ALG123XYZ + apiKey: search-only-api-key-abcdef1234567890 + roles: + - reader + - editor diff --git a/fern/fern.config.json b/fern/fern.config.json index 3b3bd9bcb..b328fe7dc 100644 --- a/fern/fern.config.json +++ b/fern/fern.config.json @@ -1,4 +1,4 @@ { "organization": "fern", - "version": "3.55.5" + "version": "4.17.0" }