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.

Sign up for GitHub

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

[ECO-798] Add quick fix for redocusaurus issue #561

Merged
merged 1 commit into from
Oct 24, 2023
Merged

[ECO-798] Add quick fix for redocusaurus issue #561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 9 additions & 2 deletions doc/doc-site/docs/off-chain/dss/rest-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,16 @@ title: REST API
hide_table_of_contents: true
---

import ApiDocMdx from '@theme/ApiDocMdx';
An Open API specification for the Econia DSS REST API is stored at [`/src/doc/doc-site/open-api.json`](https://github.com/econia-labs/econia/blob/main/doc/doc-site/openapi.json).

<ApiDocMdx id="dss-rest-api" />
If you would like to view the API in a graphical layout, copy and paste the contents into [swagger.io](https://editor.swagger.io/).

:::note
The API documentation used to be automatically embedded in this page via a Docusaurus plugin, but issues with the plugin broke the Econia docs site build.
Stand by for a resolution.

You can also generate the Open API specification yourself by following the instructions in the [docs site README](https://github.com/econia-labs/econia/tree/main/doc/doc-site).
:::

<!---
To update, see instructions in `/src/doc/doc-site/README.md`.
Expand Down
12 changes: 0 additions & 12 deletions doc/doc-site/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,6 @@ module.exports = {
},

presets: [
[
'redocusaurus',
{
specs: [
{
id: 'dss-rest-api',
spec: './openapi.json',
route: '/api/',
},
],
},
],
[
"classic",
({
Expand Down
1 change: 0 additions & 1 deletion doc/doc-site/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
"prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"redocusaurus": "^1.6.4",
"rehype-katex": "5",
"remark-math": "^3.0.1",
"trim": "^0.0.3"
Expand Down
Loading