diff --git a/fern/apis/fai/openapi.json b/fern/apis/fai/openapi.json index 0843753f1..eea90114c 100644 --- a/fern/apis/fai/openapi.json +++ b/fern/apis/fai/openapi.json @@ -97,6 +97,11 @@ }, "x-fern-audiences": [ "internal" + ], + "security": [ + { + "bearerAuth": [] + } ] } }, @@ -178,6 +183,130 @@ } } }, + "x-fern-audiences": [ + "internal" + ], + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/analytics/insights/generate_all": { + "post": { + "tags": [ + "Analytics" + ], + "summary": "Generate All Insights", + "description": "Generate insights for all domains with queries in the specified period.", + "operationId": "generate_all_insights", + "parameters": [ + { + "name": "start_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "The start date of the period to generate insights for", + "title": "Start Date" + }, + "description": "The start date of the period to generate insights for" + }, + { + "name": "end_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "The end date of the period to generate insights for", + "title": "End Date" + }, + "description": "The end date of the period to generate insights for" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "x-fern-audiences": [ + "internal" + ] + } + }, + "/analytics/insights/trigger_scheduled": { + "post": { + "tags": [ + "Analytics" + ], + "summary": "Trigger Scheduled Insights Generation", + "description": "Manually trigger the scheduled weekly insights generation job.", + "operationId": "trigger_scheduled_insights_generation", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-fern-audiences": [ + "internal" + ] + } + }, + "/analytics/scheduler/status": { + "get": { + "tags": [ + "Analytics" + ], + "summary": "Get Scheduler Status", + "description": "Get the status of the scheduler and its jobs.", + "operationId": "get_scheduler_status", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, "x-fern-audiences": [ "internal" ] @@ -235,6 +364,11 @@ }, "x-fern-audiences": [ "customers" + ], + "security": [ + { + "bearerAuth": [] + } ] } }, @@ -286,7 +420,15 @@ } } } - } + }, + "x-fern-audiences": [ + "internal" + ], + "security": [ + { + "bearerAuth": [] + } + ] } }, "/document/{domain}/create": { @@ -323,7 +465,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateDocumentResponse" + "type": "array", + "items": { + "$ref": "#/components/schemas/CreateDocumentResponse" + }, + "title": "Response Create Document Document Domain Create Post" } } } @@ -341,16 +487,21 @@ }, "x-fern-audiences": [ "customers" + ], + "security": [ + { + "bearerAuth": [] + } ] } }, - "/document/{domain}/{document_id}": { - "patch": { + "/document/{domain}/batch-create": { + "post": { "tags": [ "Document" ], - "summary": "Update Document", - "operationId": "update_document", + "summary": "Batch Create Document", + "operationId": "batch_create_document", "parameters": [ { "name": "domain", @@ -360,15 +511,6 @@ "type": "string", "title": "Domain" } - }, - { - "name": "document_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Document Id" - } } ], "requestBody": { @@ -376,7 +518,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateDocumentRequest" + "type": "array", + "items": { + "$ref": "#/components/schemas/CreateDocumentRequest" + }, + "title": "Body" } } } @@ -387,7 +533,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateDocumentResponse" + "type": "array", + "items": { + "$ref": "#/components/schemas/CreateDocumentResponse" + }, + "title": "Response Batch Create Document Document Domain Batch Create Post" } } } @@ -405,14 +555,21 @@ }, "x-fern-audiences": [ "customers" + ], + "security": [ + { + "bearerAuth": [] + } ] - }, - "delete": { + } + }, + "/document/{domain}/{document_id}": { + "patch": { "tags": [ "Document" ], - "summary": "Delete Document By Id", - "operationId": "delete_document_by_id", + "summary": "Update Document", + "operationId": "update_document", "parameters": [ { "name": "domain", @@ -433,13 +590,23 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateDocumentRequest" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteDocumentResponse" + "$ref": "#/components/schemas/UpdateDocumentResponse" } } } @@ -457,6 +624,11 @@ }, "x-fern-audiences": [ "customers" + ], + "security": [ + { + "bearerAuth": [] + } ] }, "get": { @@ -509,16 +681,21 @@ }, "x-fern-audiences": [ "customers" + ], + "security": [ + { + "bearerAuth": [] + } ] } }, - "/document/{domain}": { - "get": { + "/document/{domain}/delete": { + "delete": { "tags": [ "Document" ], - "summary": "Get Documents", - "operationId": "get_documents", + "summary": "Delete Document By Id", + "operationId": "delete_document_by_id", "parameters": [ { "name": "domain", @@ -528,51 +705,25 @@ "type": "string", "title": "Domain" } - }, - { - "name": "page", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "description": "The page number for pagination", - "title": "Page" - }, - "description": "The page number for pagination" - }, - { - "name": "limit", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "description": "The number of documents per page", - "title": "Limit" - }, - "description": "The number of documents per page" } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteDocumentRequest" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetDocumentsResponse" + "$ref": "#/components/schemas/DeleteDocumentResponse" } } } @@ -590,16 +741,21 @@ }, "x-fern-audiences": [ "customers" + ], + "security": [ + { + "bearerAuth": [] + } ] } }, - "/feedback/{domain}": { - "post": { + "/document/{domain}/batch-delete": { + "delete": { "tags": [ - "Feedback" + "Document" ], - "summary": "Create Feedback", - "operationId": "create_feedback", + "summary": "Batch Delete Document", + "operationId": "batch_delete_document", "parameters": [ { "name": "domain", @@ -616,7 +772,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateFeedbackRequest" + "type": "array", + "items": { + "$ref": "#/components/schemas/DeleteDocumentRequest" + }, + "title": "Body" } } } @@ -627,7 +787,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateFeedbackResponse" + "$ref": "#/components/schemas/DeleteDocumentResponse" } } } @@ -644,16 +804,212 @@ } }, "x-fern-audiences": [ - "internal" + "customers" + ], + "security": [ + { + "bearerAuth": [] + } ] } }, - "/feedback/{domain}/{conversation_id}": { + "/document/{domain}": { "get": { "tags": [ - "Feedback" + "Document" ], - "summary": "Get Feedback By Id", + "summary": "Get Documents", + "operationId": "get_documents", + "parameters": [ + { + "name": "domain", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Domain" + } + }, + { + "name": "page", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The page number for pagination", + "title": "Page" + }, + "description": "The page number for pagination" + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The number of documents per page", + "title": "Limit" + }, + "description": "The number of documents per page" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetDocumentsResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "x-fern-audiences": [ + "customers" + ], + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/document/{domain}/delete-all": { + "delete": { + "tags": [ + "Document" + ], + "summary": "Delete All Documents", + "operationId": "delete_all_documents", + "parameters": [ + { + "name": "domain", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Domain" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteDocumentResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "x-fern-audiences": [ + "customers" + ], + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/feedback/{domain}": { + "post": { + "tags": [ + "Feedback" + ], + "summary": "Create Feedback", + "operationId": "create_feedback", + "parameters": [ + { + "name": "domain", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Domain" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateFeedbackRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateFeedbackResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "x-fern-audiences": [ + "internal" + ] + } + }, + "/feedback/{domain}/{conversation_id}": { + "get": { + "tags": [ + "Feedback" + ], + "summary": "Get Feedback By Id", "operationId": "get_feedback_by_id", "parameters": [ { @@ -699,6 +1055,11 @@ }, "x-fern-audiences": [ "internal" + ], + "security": [ + { + "bearerAuth": [] + } ] } }, @@ -737,11 +1098,7 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ReferenceSnippet" - }, - "title": "Response Index Reference Md Github Domain Reference Md Index Post" + "$ref": "#/components/schemas/IndexResponse" } } } @@ -758,7 +1115,63 @@ } }, "x-fern-audiences": [ - "customers" + "internal" + ], + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/github/{domain}/indexed": { + "get": { + "tags": [ + "Github" + ], + "summary": "Check Code Index Status", + "description": "Check if the domain has a non-empty code index in both database and turbopuffer.", + "operationId": "check_code_index_status", + "parameters": [ + { + "name": "domain", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Domain" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CodeIndexStatusResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "x-fern-audiences": [ + "internal" + ], + "security": [ + { + "bearerAuth": [] + } ] } }, @@ -814,6 +1227,11 @@ }, "x-fern-audiences": [ "customers" + ], + "security": [ + { + "bearerAuth": [] + } ] } }, @@ -878,6 +1296,11 @@ }, "x-fern-audiences": [ "customers" + ], + "security": [ + { + "bearerAuth": [] + } ] }, "delete": { @@ -930,6 +1353,11 @@ }, "x-fern-audiences": [ "customers" + ], + "security": [ + { + "bearerAuth": [] + } ] }, "get": { @@ -982,6 +1410,11 @@ }, "x-fern-audiences": [ "customers" + ], + "security": [ + { + "bearerAuth": [] + } ] } }, @@ -1063,6 +1496,11 @@ }, "x-fern-audiences": [ "customers" + ], + "security": [ + { + "bearerAuth": [] + } ] } }, @@ -1131,7 +1569,12 @@ }, "x-fern-audiences": [ "internal" - ] + ], + "security": [ + { + "bearerAuth": [] + } + ] } }, "/index/{domain}/sync": { @@ -1186,6 +1629,11 @@ }, "x-fern-audiences": [ "internal" + ], + "security": [ + { + "bearerAuth": [] + } ] } }, @@ -1286,6 +1734,11 @@ }, "x-fern-audiences": [ "internal" + ], + "security": [ + { + "bearerAuth": [] + } ] } }, @@ -1341,6 +1794,11 @@ }, "x-fern-audiences": [ "internal" + ], + "security": [ + { + "bearerAuth": [] + } ] } }, @@ -1351,15 +1809,26 @@ ], "summary": "Create Query", "operationId": "create_query", + "parameters": [ + { + "name": "domain", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Domain" + } + } + ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Query" } } - }, - "required": true + } }, "responses": { "200": { @@ -1385,6 +1854,11 @@ }, "x-fern-audiences": [ "internal" + ], + "security": [ + { + "bearerAuth": [] + } ] } }, @@ -1442,79 +1916,515 @@ "description": "The number of queries per page" }, { - "name": "cutoff_time", + "name": "cutoff_time", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "description": "Only return queries after this time", + "title": "Cutoff Time" + }, + "description": "Only return queries after this time" + }, + { + "name": "include_assistant", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Whether to include assistant responses in the results", + "title": "Include Assistant" + }, + "description": "Whether to include assistant responses in the results" + }, + { + "name": "start_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "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" + }, + { + "name": "end_date", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "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" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetQueriesResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "x-fern-audiences": [ + "internal" + ], + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/settings/ask-ai": { + "get": { + "tags": [ + "Settings" + ], + "summary": "Get Settings", + "description": "Get settings for a domain and organization.", + "operationId": "get_settings", + "parameters": [ + { + "name": "domain", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Domain" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetSettingsResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "x-fern-audiences": [ + "internal" + ] + } + }, + "/settings/ask-ai/toggle": { + "post": { + "tags": [ + "Settings" + ], + "summary": "Toggle Ask Ai", + "description": "Toggle Ask AI setting and return job_id for tracking.", + "operationId": "toggle_ask_ai", + "parameters": [ + { + "name": "domain", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Domain" + } + }, + { + "name": "org_name", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Org Name" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ToggleAskAiResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "x-fern-audiences": [ + "internal" + ], + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/settings/ask-ai/reindex": { + "post": { + "tags": [ + "Settings" + ], + "summary": "Reindex Ask Ai", + "description": "Manually trigger reindex for an already enabled Ask AI setup.", + "operationId": "reindex_ask_ai", + "parameters": [ + { + "name": "domain", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Domain" + } + }, + { + "name": "org_name", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Org Name" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ToggleAskAiResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "x-fern-audiences": [ + "internal" + ], + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/settings/ask-ai/toggle/status": { + "get": { + "tags": [ + "Settings" + ], + "summary": "Get Toggle Status", + "description": "Get the status of Ask AI toggle operation.", + "operationId": "get_toggle_status", + "parameters": [ + { + "name": "domain", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Domain" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ToggleStatusResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "x-fern-audiences": [ + "internal" + ], + "security": [ + { + "bearerAuth": [] + } + ] + } + }, + "/slack/integrations": { + "post": { + "tags": [ + "Slack" + ], + "summary": "Create Slack Integration", + "operationId": "create_slack_integration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateSlackIntegration" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SlackIntegrationResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "x-fern-audiences": [ + "internal" + ] + } + }, + "/slack/events": { + "post": { + "tags": [ + "Slack" + ], + "summary": "Handle Slack Events", + "operationId": "handle_slack_events", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-fern-audiences": [ + "internal" + ] + } + }, + "/slack/slash-commands": { + "post": { + "tags": [ + "Slack" + ], + "summary": "Handle Slack Slash Commands", + "operationId": "handle_slack_slash_commands", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-fern-audiences": [ + "internal" + ] + } + }, + "/slack/interactions": { + "post": { + "tags": [ + "Slack" + ], + "summary": "Handle Slack Interactions", + "operationId": "handle_slack_interactions", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-fern-audiences": [ + "internal" + ] + } + }, + "/slack/oauth/callback": { + "get": { + "tags": [ + "Slack" + ], + "summary": "Handle Slack Oauth Callback", + "operationId": "handle_slack_oauth_callback", + "parameters": [ + { + "name": "code", "in": "query", - "required": false, + "required": true, "schema": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "description": "Only return queries after this time", - "title": "Cutoff Time" - }, - "description": "Only return queries after this time" + "type": "string", + "title": "Code" + } }, { - "name": "include_assistant", + "name": "state", "in": "query", "required": false, "schema": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "description": "Whether to include assistant responses in the results", - "title": "Include Assistant" - }, - "description": "Whether to include assistant responses in the results" + "title": "State" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } }, - { - "name": "start_date", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" } - ], - "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" - }, + } + } + } + }, + "x-fern-audiences": [ + "internal" + ] + } + }, + "/slack/get-install": { + "get": { + "tags": [ + "Slack" + ], + "summary": "Get Slack Install Link", + "operationId": "get_slack_install_link", + "parameters": [ { - "name": "end_date", + "name": "domain", "in": "query", - "required": false, + "required": true, "schema": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "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" + "type": "string", + "title": "Domain" + } } ], "responses": { @@ -1522,9 +2432,7 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/GetQueriesResponse" - } + "schema": {} } } }, @@ -1569,6 +2477,20 @@ ], "title": "ChatMessage" }, + "CodeIndexStatusResponse": { + "properties": { + "exists": { + "type": "boolean", + "title": "Exists", + "description": "Whether the domain has a non-empty code index" + } + }, + "type": "object", + "required": [ + "exists" + ], + "title": "CodeIndexStatusResponse" + }, "Conversation": { "properties": { "conversation_id": { @@ -1892,12 +2814,39 @@ ], "title": "CreateQueryResponse" }, + "CreateSlackIntegration": { + "properties": { + "domain": { + "type": "string", + "title": "Domain" + } + }, + "type": "object", + "required": [ + "domain" + ], + "title": "CreateSlackIntegration" + }, + "DeleteDocumentRequest": { + "properties": { + "document_id": { + "type": "string", + "title": "Document Id", + "description": "The unique identifier of the document to delete" + } + }, + "type": "object", + "required": [ + "document_id" + ], + "title": "DeleteDocumentRequest" + }, "DeleteDocumentResponse": { "properties": { "success": { "type": "boolean", "title": "Success", - "description": "Whether the document was successfully deleted" + "description": "Whether the documents was successfully deleted" } }, "type": "object", @@ -2202,7 +3151,7 @@ "properties": { "insights": { "items": { - "$ref": "#/components/schemas/InsightWithCount" + "$ref": "#/components/schemas/InsightWithMetadata" }, "type": "array", "title": "Insights", @@ -2299,6 +3248,32 @@ ], "title": "GetQueriesResponse" }, + "GetSettingsResponse": { + "properties": { + "ask_ai_enabled": { + "type": "boolean", + "title": "Ask Ai Enabled", + "description": "Whether Ask AI is enabled" + }, + "job_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Job Id", + "description": "Active job ID if reindexing is in progress" + } + }, + "type": "object", + "required": [ + "ask_ai_enabled" + ], + "title": "GetSettingsResponse" + }, "GitHubFileInfoRequest": { "properties": { "url": { @@ -2414,31 +3389,63 @@ ], "title": "HistogramAnalyticsBar" }, - "InsightWithCount": { + "IndexResponse": { + "properties": { + "success": { + "type": "boolean", + "title": "Success", + "description": "Whether the index operation was successful" + } + }, + "type": "object", + "required": [ + "success" + ], + "title": "IndexResponse" + }, + "InsightExample": { + "properties": { + "query": { + "type": "string", + "title": "Query" + }, + "conversationId": { + "type": "string", + "title": "Conversationid" + } + }, + "type": "object", + "required": [ + "query", + "conversationId" + ], + "title": "InsightExample" + }, + "InsightWithMetadata": { "properties": { "insightText": { "type": "string", "title": "Insighttext" }, + "numberOfQueries": { + "type": "integer", + "title": "Numberofqueries" + }, "examples": { "items": { - "type": "string" + "$ref": "#/components/schemas/InsightExample" }, "type": "array", "title": "Examples" - }, - "numberOfQueries": { - "type": "integer", - "title": "Numberofqueries" } }, "type": "object", "required": [ "insightText", - "examples", - "numberOfQueries" + "numberOfQueries", + "examples" ], - "title": "InsightWithCount" + "title": "InsightWithMetadata" }, "JobStatusResponse": { "properties": { @@ -2683,26 +3690,17 @@ ], "title": "ReconstructIndexResponse" }, - "ReferenceSnippet": { + "SlackIntegrationResponse": { "properties": { - "method_header": { + "integration_id": { "type": "string", - "title": "Method Header", - "description": "The header of the method or function, e.g., 'def foo(bar):'" + "title": "Integration Id" }, - "language": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Language", - "description": "The language of the code snippet" + "domain": { + "type": "string", + "title": "Domain" }, - "description": { + "slack_team_id": { "anyOf": [ { "type": "string" @@ -2711,10 +3709,9 @@ "type": "null" } ], - "title": "Description", - "description": "A description of what the method does" + "title": "Slack Team Id" }, - "usage": { + "slack_team_name": { "anyOf": [ { "type": "string" @@ -2723,30 +3720,33 @@ "type": "null" } ], - "title": "Usage", - "description": "A code snippet showing how to use the method" + "title": "Slack Team Name" + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At" }, - "parameters": { + "installed_at": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Parameters", - "description": "A list of parameter names for the method" + "title": "Installed At" } }, "type": "object", "required": [ - "method_header" + "integration_id", + "domain", + "created_at" ], - "title": "ReferenceSnippet" + "title": "SlackIntegrationResponse" }, "SyncIndexRequest": { "properties": { @@ -2776,6 +3776,70 @@ ], "title": "SyncIndexResponse" }, + "ToggleAskAiResponse": { + "properties": { + "success": { + "type": "boolean", + "title": "Success", + "description": "Whether the toggle operation was successful" + }, + "job_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Job Id", + "description": "Job ID for tracking reindex progress (only when enabling Ask AI)" + }, + "ask_ai_enabled": { + "type": "boolean", + "title": "Ask Ai Enabled", + "description": "Current state of Ask AI (true if enabled, false if disabled)" + } + }, + "type": "object", + "required": [ + "success", + "ask_ai_enabled" + ], + "title": "ToggleAskAiResponse" + }, + "ToggleStatusResponse": { + "properties": { + "status": { + "type": "string", + "title": "Status", + "description": "Current job status (running, completed, failed, etc.)" + }, + "ask_ai_enabled": { + "type": "boolean", + "title": "Ask Ai Enabled", + "description": "Current state of Ask AI" + }, + "last_reindex_time": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Last Reindex Time", + "description": "ISO timestamp of last reindex" + } + }, + "type": "object", + "required": [ + "status", + "ask_ai_enabled" + ], + "title": "ToggleStatusResponse" + }, "UpdateDocumentRequest": { "properties": { "document": { @@ -2973,6 +4037,13 @@ ], "title": "ValidationError" } + }, + "securitySchemes": { + "bearerAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT" + } } }, "servers": [ diff --git a/fern/products/cli-api-reference/cli-changelog/2025-09-22.mdx b/fern/products/cli-api-reference/cli-changelog/2025-09-22.mdx index 614e22d32..57a099503 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-09-22.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-09-22.mdx @@ -7,7 +7,7 @@ ## 0.78.4 -**`(fix):`** Collapse any combination of optional and nullable to optional>. +**`(fix):`** Collapse any combination of optional and nullable to `optional>`. ## 0.78.3 **`(chore):`** Support IR v59 in the Rust SDK generator.