Skip to content
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.

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

Add openapi support #698

Draft
wants to merge 32 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
1cd23de
install `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openap…
Maschga Dec 25, 2024
246639b
update scripts
Maschga Dec 25, 2024
86972d1
Delete babel.config.js
Maschga Dec 25, 2024
8ff7f2d
Create _category_.json
Maschga Dec 25, 2024
689f83b
configure plugin
Maschga Dec 25, 2024
f47a40c
wip: rest-api.yaml
Maschga Dec 25, 2024
ec8261f
Update _category_.json
Maschga Dec 28, 2024
fd93826
Revert "configure plugin"
Maschga Jan 1, 2025
73e35b3
remove openapi-plugin
Maschga Jan 1, 2025
4586027
fix regex
Maschga Jan 1, 2025
ada02ff
setup swagger-ui
Maschga Jan 1, 2025
60d4e37
configure swagger ui
Maschga Jan 1, 2025
fa71e7a
remove title
Maschga Jan 1, 2025
f0fd1e1
wip: rest-api.yaml
Maschga Jan 1, 2025
2d3a581
swagger styles
naltatis Jan 1, 2025
09d7171
merge
naltatis Jan 1, 2025
7667bf8
wip: rest-api.yaml
Maschga Jan 2, 2025
68f2b1f
format and configure swagger ui
Maschga Jan 2, 2025
632dfd5
wip: rest-api.yaml
Maschga Jan 3, 2025
ffee2e2
wip: rest-api.yaml
Maschga Jan 3, 2025
ae4d20d
wip: rest-api.yaml
Maschga Jan 4, 2025
57b7b32
update docusaurus
Maschga Jan 6, 2025
440ac8f
add generateOpenApiFile.js
Maschga Jan 6, 2025
34cdb87
ignore generated files
Maschga Jan 6, 2025
cb3417d
add swagger ui to en docs
Maschga Jan 6, 2025
f085e3f
wip: rest-api.yaml
Maschga Jan 6, 2025
72da8e9
wip: rest-api.yaml
Maschga Jan 6, 2025
829a405
wip: rest-api.yaml
Maschga Jan 19, 2025
58318c5
remove documentation
Maschga Jan 19, 2025
ba1b37b
wip: rest-api.yaml
Maschga Jan 19, 2025
f1b1321
enable more request-snippets
Maschga Jan 19, 2025
5f9263c
wip: rest-api.yaml
Maschga Jan 19, 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
Prev Previous commit
Next Next commit
configure plugin
  • Loading branch information
Maschga committed Dec 25, 2024
commit 689f83b46b6562a37a59d0f6c09f4e4526d8aa25
18 changes: 18 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ import { themes as prismThemes } from "prism-react-renderer";
sidebarPath: require.resolve("./sidebars.js"),
editUrl: "https://github.com/evcc-io/docs/tree/main",
editLocalizedFiles: true,
docItemComponent: "@theme/ApiItem", // Derived from docusaurus-theme-openapi
},
blog: {
showReadingTime: true,
Expand Down Expand Up @@ -169,6 +170,23 @@ import { themes as prismThemes } from "prism-react-renderer";
],
},
],
[
"docusaurus-plugin-openapi-docs",
{
id: "rest-api",
docsPluginId: "classic",
config: {
petstore: {
specPath: "./docs/integrations/rest-api.yaml",
outputDir: "docs/integrations/rest-api",
sidebarOptions: {
groupPathsBy: "tag",
},
},
},
},
],
],
themes: ["docusaurus-theme-openapi-docs"],
}
);