1import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
2
3const sidebar: SidebarsConfig = {
4 apisidebar: [
5 {
6 type: "doc",
7 id: "api/HTTP/runtime",
8 },
9 {
10 type: "category",
11 label: "Catalogs",
12 items: [
13 {
14 type: "doc",
15 id: "api/HTTP/get-catalogs",
16 label: "List Catalogs",
17 className: "api-method get",
18 },
19 ],
20 },
21 {
22 type: "category",
23 label: "AI",
24 items: [
25 {
26 type: "doc",
27 id: "api/HTTP/post-chat-completions",
28 label: "Create Chat Completion",
29 className: "api-method post",
30 },
31 {
32 type: "doc",
33 id: "api/HTTP/post-embeddings",
34 label: "Create Embeddings",
35 className: "api-method post",
36 },
37 {
38 type: "doc",
39 id: "api/HTTP/get-models",
40 label: "List Models",
41 className: "api-method get",
42 },
43 {
44 type: "doc",
45 id: "api/HTTP/post-responses",
46 label: "post_responses",
47 className: "api-method post",
48 },
49 ],
50 },
51 {
52 type: "category",
53 label: "Datasets",
54 items: [
55 {
56 type: "doc",
57 id: "api/HTTP/get-datasets",
58 label: "List Datasets",
59 className: "api-method get",
60 },
61 {
62 type: "doc",
63 id: "api/HTTP/patch-dataset-acceleration",
64 label: "Update Refresh SQL",
65 className: "api-method patch",
66 },
67 {
68 type: "doc",
69 id: "api/HTTP/post-dataset-refresh",
70 label: "Refresh Dataset",
71 className: "api-method post",
72 },
73 ],
74 },
75 {
76 type: "category",
77 label: "Iceberg",
78 items: [
79 {
80 type: "doc",
81 id: "api/HTTP/get-config",
82 label: "Get Iceberg API config",
83 className: "api-method get",
84 },
85 {
86 type: "doc",
87 id: "api/HTTP/get-iceberg-namespaces",
88 label: "List Iceberg namespaces",
89 className: "api-method get",
90 },
91 {
92 type: "doc",
93 id: "api/HTTP/get-namespace",
94 label: "Check if a namespace exists.",
95 className: "api-method get",
96 },
97 {
98 type: "doc",
99 id: "api/HTTP/head-namespace",
100 label: "Check Namespace exists",
101 className: "api-method head",
102 },
103 {
104 type: "doc",
105 id: "api/HTTP/list-tables",
106 label: "list_tables",
107 className: "api-method get",
108 },
109 {
110 type: "doc",
111 id: "api/HTTP/get-table",
112 label: "Get a table.",
113 className: "api-method get",
114 },
115 {
116 type: "doc",
117 id: "api/HTTP/head-table",
118 label: "Check if a table exists.",
119 className: "api-method head",
120 },
121 ],
122 },
123 {
124 type: "category",
125 label: "mcp",
126 items: [
127 {
128 type: "doc",
129 id: "api/HTTP/mcp-stream",
130 label: "Open an MCP server-to-client SSE stream",
131 className: "api-method get",
132 },
133 {
134 type: "doc",
135 id: "api/HTTP/mcp-message",
136 label: "Send a Model Context Protocol message",
137 className: "api-method post",
138 },
139 {
140 type: "doc",
141 id: "api/HTTP/mcp-terminate-session",
142 label: "Terminate an MCP Streamable HTTP session",
143 className: "api-method delete",
144 },
145 ],
146 },
147 {
148 type: "category",
149 label: "SQL",
150 items: [
151 {
152 type: "doc",
153 id: "api/HTTP/post-nsql",
154 label: "Text-to-SQL (NSQL)",
155 className: "api-method post",
156 },
157 {
158 type: "doc",
159 id: "api/HTTP/post-sql",
160 label: "SQL Query",
161 className: "api-method post",
162 },
163 ],
164 },
165 {
166 type: "category",
167 label: "General",
168 items: [
169 {
170 type: "doc",
171 id: "api/HTTP/generate-package",
172 label: "Generate Package",
173 className: "api-method post",
174 },
175 {
176 type: "doc",
177 id: "api/HTTP/get-spicepods",
178 label: "List Spicepods",
179 className: "api-method get",
180 },
181 {
182 type: "doc",
183 id: "api/HTTP/get-status",
184 label: "Check Runtime Status",
185 className: "api-method get",
186 },
187 ],
188 },
189 {
190 type: "category",
191 label: "Ready",
192 items: [
193 {
194 type: "doc",
195 id: "api/HTTP/ready",
196 label: "Check Readiness",
197 className: "api-method get",
198 },
199 ],
200 },
201 {
202 type: "category",
203 label: "Search",
204 items: [
205 {
206 type: "doc",
207 id: "api/HTTP/post-search",
208 label: "Search",
209 className: "api-method post",
210 },
211 ],
212 },
213 {
214 type: "category",
215 label: "Tools",
216 items: [
217 {
218 type: "doc",
219 id: "api/HTTP/list-tools",
220 label: "List Tools",
221 className: "api-method get",
222 },
223 {
224 type: "doc",
225 id: "api/HTTP/run-tool",
226 label: "Run Tool",
227 className: "api-method post",
228 },
229 ],
230 },
231 {
232 type: "category",
233 label: "Workers",
234 items: [
235 {
236 type: "doc",
237 id: "api/HTTP/get-workers",
238 label: "List Workers",
239 className: "api-method get",
240 },
241 ],
242 },
243 ],
244};
245
246export default sidebar.apisidebar;
247
1import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
2
3const sidebar: SidebarsConfig = {
4 apisidebar: [
5 {
6 type: "doc",
7 id: "api/HTTP/runtime",
8 },
9 {
10 type: "category",
11 label: "Catalogs",
12 items: [
13 {
14 type: "doc",
15 id: "api/HTTP/get-catalogs",
16 label: "List Catalogs",
17 className: "api-method get",
18 },
19 ],
20 },
21 {
22 type: "category",
23 label: "AI",
24 items: [
25 {
26 type: "doc",
27 id: "api/HTTP/post-chat-completions",
28 label: "Create Chat Completion",
29 className: "api-method post",
30 },
31 {
32 type: "doc",
33 id: "api/HTTP/post-embeddings",
34 label: "Create Embeddings",
35 className: "api-method post",
36 },
37 {
38 type: "doc",
39 id: "api/HTTP/get-models",
40 label: "List Models",
41 className: "api-method get",
42 },
43 {
44 type: "doc",
45 id: "api/HTTP/post-responses",
46 label: "post_responses",
47 className: "api-method post",
48 },
49 ],
50 },
51 {
52 type: "category",
53 label: "Datasets",
54 items: [
55 {
56 type: "doc",
57 id: "api/HTTP/get-datasets",
58 label: "List Datasets",
59 className: "api-method get",
60 },
61 {
62 type: "doc",
63 id: "api/HTTP/patch-dataset-acceleration",
64 label: "Update Refresh SQL",
65 className: "api-method patch",
66 },
67 {
68 type: "doc",
69 id: "api/HTTP/post-dataset-refresh",
70 label: "Refresh Dataset",
71 className: "api-method post",
72 },
73 ],
74 },
75 {
76 type: "category",
77 label: "Iceberg",
78 items: [
79 {
80 type: "doc",
81 id: "api/HTTP/get-config",
82 label: "Get Iceberg API config",
83 className: "api-method get",
84 },
85 {
86 type: "doc",
87 id: "api/HTTP/get-iceberg-namespaces",
88 label: "List Iceberg namespaces",
89 className: "api-method get",
90 },
91 {
92 type: "doc",
93 id: "api/HTTP/get-namespace",
94 label: "Check if a namespace exists.",
95 className: "api-method get",
96 },
97 {
98 type: "doc",
99 id: "api/HTTP/head-namespace",
100 label: "Check Namespace exists",
101 className: "api-method head",
102 },
103 {
104 type: "doc",
105 id: "api/HTTP/list-tables",
106 label: "list_tables",
107 className: "api-method get",
108 },
109 {
110 type: "doc",
111 id: "api/HTTP/get-table",
112 label: "Get a table.",
113 className: "api-method get",
114 },
115 {
116 type: "doc",
117 id: "api/HTTP/head-table",
118 label: "Check if a table exists.",
119 className: "api-method head",
120 },
121 ],
122 },
123 {
124 type: "category",
125 label: "mcp",
126 items: [
127 {
128 type: "doc",
129 id: "api/HTTP/mcp-stream",
130 label: "Open an MCP server-to-client SSE stream",
131 className: "api-method get",
132 },
133 {
134 type: "doc",
135 id: "api/HTTP/mcp-message",
136 label: "Send a Model Context Protocol message",
137 className: "api-method post",
138 },
139 {
140 type: "doc",
141 id: "api/HTTP/mcp-terminate-session",
142 label: "Terminate an MCP Streamable HTTP session",
143 className: "api-method delete",
144 },
145 ],
146 },
147 {
148 type: "category",
149 label: "SQL",
150 items: [
151 {
152 type: "doc",
153 id: "api/HTTP/post-nsql",
154 label: "Text-to-SQL (NSQL)",
155 className: "api-method post",
156 },
157 {
158 type: "doc",
159 id: "api/HTTP/post-sql",
160 label: "SQL Query",
161 className: "api-method post",
162 },
163 ],
164 },
165 {
166 type: "category",
167 label: "General",
168 items: [
169 {
170 type: "doc",
171 id: "api/HTTP/generate-package",
172 label: "Generate Package",
173 className: "api-method post",
174 },
175 {
176 type: "doc",
177 id: "api/HTTP/get-spicepods",
178 label: "List Spicepods",
179 className: "api-method get",
180 },
181 {
182 type: "doc",
183 id: "api/HTTP/get-status",
184 label: "Check Runtime Status",
185 className: "api-method get",
186 },
187 ],
188 },
189 {
190 type: "category",
191 label: "Ready",
192 items: [
193 {
194 type: "doc",
195 id: "api/HTTP/ready",
196 label: "Check Readiness",
197 className: "api-method get",
198 },
199 ],
200 },
201 {
202 type: "category",
203 label: "Search",
204 items: [
205 {
206 type: "doc",
207 id: "api/HTTP/post-search",
208 label: "Search",
209 className: "api-method post",
210 },
211 ],
212 },
213 {
214 type: "category",
215 label: "Tools",
216 items: [
217 {
218 type: "doc",
219 id: "api/HTTP/list-tools",
220 label: "List Tools",
221 className: "api-method get",
222 },
223 {
224 type: "doc",
225 id: "api/HTTP/run-tool",
226 label: "Run Tool",
227 className: "api-method post",
228 },
229 ],
230 },
231 {
232 type: "category",
233 label: "Workers",
234 items: [
235 {
236 type: "doc",
237 id: "api/HTTP/get-workers",
238 label: "List Workers",
239 className: "api-method get",
240 },
241 ],
242 },
243 ],
244};
245
246export default sidebar.apisidebar;
247
