Skip to content

Commit

Permalink
Merge pull request #561 from econia-labs/ECO-798
Browse files Browse the repository at this point in the history
[ECO-798] Add quick fix for redocusaurus issue
  • Loading branch information
CRBl69 authored Oct 24, 2023
2 parents 7920f8f + b3760f0 commit 538f8ef
Show file tree
Hide file tree
Showing 4 changed files with 1,819 additions and 2,580 deletions.
11 changes: 9 additions & 2 deletions doc/doc-site/docs/off-chain/dss/rest-api.md
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
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
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

0 comments on commit 538f8ef

Please sign in to comment.