Skip to content

API cleanup #1600

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

Merged
merged 11 commits into from
Oct 23, 2025
Merged

API cleanup #1600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
629e06a
remove deprecated endpoint pages
ethanpalm Oct 21, 2025
3f15ff5
sentence case group title
ethanpalm Oct 21, 2025
56678bb
consistent capitalization of ID
ethanpalm Oct 21, 2025
8dcd712
update placeholders
ethanpalm Oct 22, 2025
6a1ffe7
remove unused endpoints from admin-openapi.json
ethanpalm Oct 22, 2025
a92a22b
capitalization match paths
ethanpalm Oct 22, 2025
345051b
update how to find `{domain}`
ethanpalm Oct 22, 2025
cbb65da
update how to find `{projectId}`
ethanpalm Oct 22, 2025
1f707dc
how to find `{projectId}`
ethanpalm Oct 22, 2025
971e394
remove deprecated endpoints
ethanpalm Oct 22, 2025
55f3da8
match path capitalization
ethanpalm Oct 22, 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
50 changes: 3 additions & 47 deletions admin-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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": {
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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": {
Expand Down
3 changes: 0 additions & 3 deletions api/assistant/create-topic.mdx
View file
Open in desktop

This file was deleted.

3 changes: 0 additions & 3 deletions api/assistant/generate-message.mdx
View file
Open in desktop

This file was deleted.

79 changes: 2 additions & 77 deletions discovery-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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 `<response>||[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",
Expand All @@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@
"tab": "API Reference",
"groups": [
{
"group": "API Reference",
"group": "API reference",
"icon": "file-json",
"pages": [
"api/introduction"
Expand Down
6 changes: 3 additions & 3 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -44,7 +44,7 @@
"properties": {
"statusId": {
"type": "string",
"description": "The status id of the triggered updated."
"description": "The status ID of the triggered updated."
}
}
}
Expand Down Expand Up @@ -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",
Expand Down
Loading