Skip to content

Commit ab3ffb9

Browse files
committed
refactor: update openapi docs
1 parent e11e459 commit ab3ffb9

File tree

3 files changed

+41
-1
lines changed

3 files changed

+41
-1
lines changed

docusaurus.config.js

+1
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ const config = {
141141
groupPathsBy: "tag",
142142
categoryLinkSource: "tag",
143143
},
144+
template: "openapi.mustache", // Customize API MDX with mustache template
144145
}
145146
}
146147
}

openapi.mustache

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
id: {{{id}}}
3+
title: "{{{frontMatter.description}}}"
4+
description: "{{{frontMatter.description}}}"
5+
{{^api}}
6+
sidebar_label: Introduction
7+
{{/api}}
8+
{{#api}}
9+
sidebar_label: "{{{frontMatter.description}}}"
10+
{{/api}}
11+
{{^api}}
12+
sidebar_position: 0
13+
{{/api}}
14+
hide_title: false
15+
{{#api}}
16+
hide_table_of_contents: true
17+
{{/api}}
18+
{{#json}}
19+
api: {{{json}}}
20+
{{/json}}
21+
{{#api.method}}
22+
sidebar_class_name: "{{{api.method}}} api-method"
23+
{{/api.method}}
24+
{{#infoPath}}
25+
info_path: {{{infoPath}}}
26+
{{/infoPath}}
27+
custom_edit_url: null
28+
{{#frontMatter.proxy}}
29+
proxy: {{{frontMatter.proxy}}}
30+
{{/frontMatter.proxy}}
31+
{{#frontMatter.hide_send_button}}
32+
hide_send_button: true
33+
{{/frontMatter.hide_send_button}}
34+
{{#frontMatter.show_extensions}}
35+
show_extensions: true
36+
{{/frontMatter.show_extensions}}
37+
---
38+
39+
{{{markdown}}}

openapi/v1.json

+1-1
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)