-
Notifications
You must be signed in to change notification settings - Fork 149
/
v1-openapi.json
201 lines (201 loc) · 6.69 KB
/
v1-openapi.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
{
"openapi": "3.0.1",
"info": {
"title": "Mintlify External API",
"description": "An API for Mintlify documentation management and resource access.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.mintlify.com/v1"
}
],
"security": [
{
"bearerAuth": []
}
],
"paths": {
"/project/update/{projectId}": {
"post": {
"summary": "Trigger an update",
"description": "Trigger an update after updating your OpenAPI document by calling this endpoint in a CI check.",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "The ID of the project to trigger an update on. Can be retrieved from your dashboard.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "A successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusId": {
"type": "string",
"description": "The status id of the triggered updated."
}
}
}
}
}
}
}
}
},
"/project/update-status/{statusId}": {
"get": {
"summary": "Get the status of an update",
"parameters": [
{
"name": "statusId",
"in": "path",
"description": "The status ID of a triggered update.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "A successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "The status id of the triggered updated."
},
"projectId": {
"type": "string",
"description": "The documentation project ID."
},
"createdAt": {
"type": "string",
"description": "An ISODate with the specified datetime in UTC"
},
"endedAt": {
"type": "string",
"description": "An ISODate with the specified datetime in UTC"
},
"status": {
"type": "string",
"enum": ["queued", "in_progress", "success", "failure"],
"description": "The status of the update."
},
"summary": {
"type": "string",
"description": "Summary of the status of the update"
},
"logs": {
"type": "array",
"description": "An array of logs.",
"items": {
"type": "string"
}
},
"subdomain": {
"type": "string",
"description": "The subdomain of the docs being updated."
},
"screenshot": {
"type": "string",
"description": "A screenshot of the docs."
},
"screenshotLight": {
"type": "string",
"description": "A screenshot of the docs."
},
"screenshotDark": {
"type": "string",
"description": "A screenshot of the docs in dark mode."
},
"author": {
"type": "string",
"description": "The author of the update."
},
"commit": {
"type": "object",
"description": "The commit details",
"properties": {
"sha": {
"type": "string",
"description": "The SHA of the commit."
},
"ref": {
"type": "string",
"description": "The ref of the commit."
},
"message": {
"type": "string",
"description": "The commit message."
},
"filesChanged": {
"type": "object",
"description": "Details on the changed files.",
"properties": {
"added": {
"type": "array",
"description": "New files added.",
"items": {
"type": "string"
}
},
"modified": {
"type": "array",
"description": "Existing files that were modified.",
"items": {
"type": "string"
}
},
"removed": {
"type": "array",
"description": "Files that were removed.",
"items": {
"type": "string"
}
}
}
}
}
},
"source": {
"type": "string",
"description": "The source of the update trigger.",
"enum": [
"internal",
"github-app-installation",
"api",
"github",
"dashboard"
]
}
}
}
}
}
}
}
}
}
},
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer"
}
}
}
}