diff --git a/admin-openapi.json b/admin-openapi.json index bd6b8922b..29415b346 100644 --- a/admin-openapi.json +++ b/admin-openapi.json @@ -16,50 +16,6 @@ } ], "paths": { - "/admin/update/{domain}": { - "post": { - "summary": "Trigger update", - "description": "Triggers an update of your documentation site.", - "parameters": [ - { - "name": "domain", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The domain identifier from your `domain.mintlify.app` URL. Can be found in the top left of your dashboard." - } - ], - "responses": { - "200": { - "description": "Update triggered successfully" - } - } - } - }, - "/admin/update/{domain}/status": { - "get": { - "summary": "Get update status", - "description": "Retrieves the status of documentation updates and other details about your docs.", - "parameters": [ - { - "name": "domain", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The domain identifier from your `domain.mintlify.app` URL. Can be found in the top left of your dashboard." - } - ], - "responses": { - "200": { - "description": "Update status retrieved successfully" - } - } - } - }, "/agent/{projectId}/job": { "post": { "summary": "Create agent job", @@ -72,7 +28,7 @@ "schema": { "type": "string" }, - "description": "The ID of your project. Can be retrieved from your dashboard." + "description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard." } ], "requestBody": { @@ -152,7 +108,7 @@ "schema": { "type": "string" }, - "description": "The ID of your project. Can be retrieved from your dashboard." + "description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard." }, { "name": "id", @@ -254,7 +210,7 @@ "schema": { "type": "string" }, - "description": "The ID of your project. Can be retrieved from your dashboard." + "description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard." } ], "responses": { diff --git a/api/assistant/create-topic.mdx b/api/assistant/create-topic.mdx deleted file mode 100644 index dc00663e3..000000000 --- a/api/assistant/create-topic.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: POST /chat/topic ---- diff --git a/api/assistant/generate-message.mdx b/api/assistant/generate-message.mdx deleted file mode 100644 index b1cdbbb37..000000000 --- a/api/assistant/generate-message.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: POST /chat/message ---- diff --git a/discovery-openapi.json b/discovery-openapi.json index 1dfe87c04..4bb9e8d3a 100644 --- a/discovery-openapi.json +++ b/discovery-openapi.json @@ -31,7 +31,7 @@ "schema": { "type": "string" }, - "description": "The domain identifier from your `domain.mintlify.app` URL. Can be found in the top left of your dashboard." + "description": "The domain identifier from your `domain.mintlify.app` URL. Can be found at the end of your dashboard URL. For example, `dashboard.mintlify.com/organization/domain` has a domain identifier of `domain`." } ], "requestBody": { @@ -418,81 +418,6 @@ } } }, - "/chat/topic": { - "post": { - "summary": "Create Assistant Chat Topic", - "description": "Creates a topic to manage message history for a given AI assistant conversation", - "responses": { - "200": { - "description": "Topic created successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "topicId": { - "type": "string", - "description": "The id of the created topic." - } - } - } - } - } - } - } - } - }, - "/chat/message": { - "post": { - "summary": "Create Assistant Chat Message", - "description": "Generate a completion in response to a user query", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "topicId", - "message" - ], - "properties": { - "topicId": { - "type": "string", - "description": "The topic ID to associate this message with" - }, - "message": { - "type": "string", - "description": "The user message to generate a completion for" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Topic created successfully", - "headers": { - "X-Mintlify-Base-Url": { - "schema": { - "type": "string" - }, - "description": "The base URL for the Mintlify documentation" - } - }, - "content": { - "text/plain": { - "schema": { - "type": "string", - "description": "A text stream in the form `||[chunks]`. The chunks are parts of your docs that most closely matched the user query. Each has the following format: \\n ```\\n { \\n \\tid: string;\\n \\tlink: string;\\n \\tchunk_html: string;\\n \\tmetadata: {\\n \\t\\ttitle?: string\\n \\t}\\n} \\n``` \\n The links are relative links with your docs URL intended as the host. To get an absolute link to your docs, you can use the `X-Mintlify-Base-Url` header as the host and construct a fully-qualified URL." - } - } - } - } - } - } - }, "/search/{domain}": { "post": { "summary": "Search documentation", @@ -505,7 +430,7 @@ "schema": { "type": "string" }, - "description": "The domain identifier from your `domain.mintlify.app` URL. Can be found in the top left of your dashboard." + "description": "The domain identifier from your `domain.mintlify.app` URL. Can be found at the end of your dashboard URL. For example, `dashboard.mintlify.com/organization/domain` has a domain identifier of `domain`." } ], "requestBody": { diff --git a/docs.json b/docs.json index 8688ba60e..58094eb0f 100644 --- a/docs.json +++ b/docs.json @@ -276,7 +276,7 @@ "tab": "API Reference", "groups": [ { - "group": "API Reference", + "group": "API reference", "icon": "file-json", "pages": [ "api/introduction" diff --git a/openapi.json b/openapi.json index 463bdb225..33bc4d8a6 100644 --- a/openapi.json +++ b/openapi.json @@ -27,7 +27,7 @@ { "name": "projectId", "in": "path", - "description": "The ID of the project to trigger an update on. Can be retrieved from your dashboard.", + "description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard.", "required": true, "schema": { "type": "string" @@ -44,7 +44,7 @@ "properties": { "statusId": { "type": "string", - "description": "The status id of the triggered updated." + "description": "The status ID of the triggered updated." } } } @@ -79,7 +79,7 @@ "properties": { "_id": { "type": "string", - "description": "The status id of the triggered updated." + "description": "The status ID of the triggered updated." }, "projectId": { "type": "string",