Skip to content

Commit 8f3b5ea

Browse files
ethanpalmethanpalm
authored
API cleanup (#1600)
1 parent 1fe138a commit 8f3b5ea

File tree

6 files changed

+9
-134
lines changed

6 files changed

+9
-134
lines changed

‎admin-openapi.json‎

Lines changed: 3 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -16,50 +16,6 @@
1616
}
1717
],
1818
"paths": {
19-
"/admin/update/{domain}": {
20-
"post": {
21-
"summary": "Trigger update",
22-
"description": "Triggers an update of your documentation site.",
23-
"parameters": [
24-
{
25-
"name": "domain",
26-
"in": "path",
27-
"required": true,
28-
"schema": {
29-
"type": "string"
30-
},
31-
"description": "The domain identifier from your `domain.mintlify.app` URL. Can be found in the top left of your dashboard."
32-
}
33-
],
34-
"responses": {
35-
"200": {
36-
"description": "Update triggered successfully"
37-
}
38-
}
39-
}
40-
},
41-
"/admin/update/{domain}/status": {
42-
"get": {
43-
"summary": "Get update status",
44-
"description": "Retrieves the status of documentation updates and other details about your docs.",
45-
"parameters": [
46-
{
47-
"name": "domain",
48-
"in": "path",
49-
"required": true,
50-
"schema": {
51-
"type": "string"
52-
},
53-
"description": "The domain identifier from your `domain.mintlify.app` URL. Can be found in the top left of your dashboard."
54-
}
55-
],
56-
"responses": {
57-
"200": {
58-
"description": "Update status retrieved successfully"
59-
}
60-
}
61-
}
62-
},
6319
"/agent/{projectId}/job": {
6420
"post": {
6521
"summary": "Create agent job",
@@ -72,7 +28,7 @@
7228
"schema": {
7329
"type": "string"
7430
},
75-
"description": "The ID of your project. Can be retrieved from your dashboard."
31+
"description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard."
7632
}
7733
],
7834
"requestBody": {
@@ -152,7 +108,7 @@
152108
"schema": {
153109
"type": "string"
154110
},
155-
"description": "The ID of your project. Can be retrieved from your dashboard."
111+
"description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard."
156112
},
157113
{
158114
"name": "id",
@@ -254,7 +210,7 @@
254210
"schema": {
255211
"type": "string"
256212
},
257-
"description": "The ID of your project. Can be retrieved from your dashboard."
213+
"description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard."
258214
}
259215
],
260216
"responses": {

‎api/assistant/create-topic.mdx‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎api/assistant/generate-message.mdx‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎discovery-openapi.json‎

Lines changed: 2 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
"schema": {
3232
"type": "string"
3333
},
34-
"description": "The domain identifier from your `domain.mintlify.app` URL. Can be found in the top left of your dashboard."
34+
"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`."
3535
}
3636
],
3737
"requestBody": {
@@ -418,81 +418,6 @@
418418
}
419419
}
420420
},
421-
"/chat/topic": {
422-
"post": {
423-
"summary": "Create Assistant Chat Topic",
424-
"description": "Creates a topic to manage message history for a given AI assistant conversation",
425-
"responses": {
426-
"200": {
427-
"description": "Topic created successfully",
428-
"content": {
429-
"application/json": {
430-
"schema": {
431-
"type": "object",
432-
"properties": {
433-
"topicId": {
434-
"type": "string",
435-
"description": "The id of the created topic."
436-
}
437-
}
438-
}
439-
}
440-
}
441-
}
442-
}
443-
}
444-
},
445-
"/chat/message": {
446-
"post": {
447-
"summary": "Create Assistant Chat Message",
448-
"description": "Generate a completion in response to a user query",
449-
"requestBody": {
450-
"required": true,
451-
"content": {
452-
"application/json": {
453-
"schema": {
454-
"type": "object",
455-
"required": [
456-
"topicId",
457-
"message"
458-
],
459-
"properties": {
460-
"topicId": {
461-
"type": "string",
462-
"description": "The topic ID to associate this message with"
463-
},
464-
"message": {
465-
"type": "string",
466-
"description": "The user message to generate a completion for"
467-
}
468-
}
469-
}
470-
}
471-
}
472-
},
473-
"responses": {
474-
"200": {
475-
"description": "Topic created successfully",
476-
"headers": {
477-
"X-Mintlify-Base-Url": {
478-
"schema": {
479-
"type": "string"
480-
},
481-
"description": "The base URL for the Mintlify documentation"
482-
}
483-
},
484-
"content": {
485-
"text/plain": {
486-
"schema": {
487-
"type": "string",
488-
"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."
489-
}
490-
}
491-
}
492-
}
493-
}
494-
}
495-
},
496421
"/search/{domain}": {
497422
"post": {
498423
"summary": "Search documentation",
@@ -505,7 +430,7 @@
505430
"schema": {
506431
"type": "string"
507432
},
508-
"description": "The domain identifier from your `domain.mintlify.app` URL. Can be found in the top left of your dashboard."
433+
"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`."
509434
}
510435
],
511436
"requestBody": {

‎docs.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@
276276
"tab": "API Reference",
277277
"groups": [
278278
{
279-
"group": "API Reference",
279+
"group": "API reference",
280280
"icon": "file-json",
281281
"pages": [
282282
"api/introduction"

‎openapi.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
{
2828
"name": "projectId",
2929
"in": "path",
30-
"description": "The ID of the project to trigger an update on. Can be retrieved from your dashboard.",
30+
"description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard.",
3131
"required": true,
3232
"schema": {
3333
"type": "string"
@@ -44,7 +44,7 @@
4444
"properties": {
4545
"statusId": {
4646
"type": "string",
47-
"description": "The status id of the triggered updated."
47+
"description": "The status ID of the triggered updated."
4848
}
4949
}
5050
}
@@ -79,7 +79,7 @@
7979
"properties": {
8080
"_id": {
8181
"type": "string",
82-
"description": "The status id of the triggered updated."
82+
"description": "The status ID of the triggered updated."
8383
},
8484
"projectId": {
8585
"type": "string",

0 commit comments

Comments
 (0)