Max/openapi docs update (#5292)

* spacing + working openapi local for nymapi * sandbox nyx rest api * add now working nym-api openapi json url to component
nymtech · Feb 5, 2025 · 0fc7cc6 · 0fc7cc6
1 parent 23a7f01
commit 0fc7cc6
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 3 deletions.
diff --git a/documentation/docs/pages/apis/cosmos-sdk-nyx/mainnet.mdx b/documentation/docs/pages/apis/cosmos-sdk-nyx/mainnet.mdx
@@ -4,6 +4,8 @@ The information below is generated with [Redoc](https://redocly.com/docs/redoc)
 
 There is also an overview of other Validator endpoints at [https://cosmos.directory/nyx](https://cosmos.directory/nyx).
 
+<br /><br />
+
 <RedocStandalone
   specUrl="https://api.nymtech.net/swagger/swagger.yaml"
   options={{

diff --git a/documentation/docs/pages/apis/cosmos-sdk-nyx/sandbox.mdx b/documentation/docs/pages/apis/cosmos-sdk-nyx/sandbox.mdx
@@ -1,9 +1,11 @@
 import { RedocStandalone } from 'redoc';
 
-The information below is generated with [Redoc](https://redocly.com/docs/redoc) consuming the OpenAPI spec found at []() which is also used to generate the Swagger docs deployed at []().
+The information below is generated with [Redoc](https://redocly.com/docs/redoc) consuming the OpenAPI spec found at [https://api.sandbox.nymtech.net/swagger/swagger.yaml](https://api.sandbox.nymtech.net/swagger/swagger.yaml).
+
+<br /><br />
 
 <RedocStandalone
-  specUrl=""
+  specUrl="https://api.sandbox.nymtech.net/swagger/swagger.yaml"
   options={{
     nativeScrollbars: true,
     theme: {

diff --git a/documentation/docs/pages/apis/explorer-api/mainnet.mdx b/documentation/docs/pages/apis/explorer-api/mainnet.mdx
@@ -3,6 +3,8 @@ import { RedocStandalone } from 'redoc';
 
 The information below is generated with [Redoc](https://redocly.com/docs/redoc) consuming the OpenAPI spec found at [https://explorer.nymtech.net/api/v1/openapi.json](https://explorer.nymtech.net/api/v1/openapi.json) which is also used to generate the Swagger docs deployed at [https://explorer.nymtech.net/api/swagger/index.html](https://explorer.nymtech.net/api/swagger/index.html).
 
+<br /><br />
+
 <RedocStandalone
   specUrl="https://sandbox-explorer.nymtech.net/api/v1/openapi.json"
   options={{

diff --git a/documentation/docs/pages/apis/explorer-api/sandbox.mdx b/documentation/docs/pages/apis/explorer-api/sandbox.mdx
@@ -2,6 +2,8 @@ import { RedocStandalone } from 'redoc';
 
 The information below is generated with [Redoc](https://redocly.com/docs/redoc) consuming the OpenAPI spec found at [https://sandbox-explorer.nymtech.net/api/v1/openapi.json](https://sandbox-explorer.nymtech.net/api/v1/openapi.json) which is also used to generate the Swagger docs deployed at [https://sandbox-explorer.nymtech.net/api/swagger/index.html](https://sandbox-explorer.nymtech.net/api/swagger/index.html).
 
+<br /><br />
+
 <RedocStandalone
   specUrl="https://sandbox-explorer.nymtech.net/api/v1/openapi.json"
   options={{

diff --git a/documentation/docs/pages/apis/ns-api/mainnet.mdx b/documentation/docs/pages/apis/ns-api/mainnet.mdx
@@ -2,6 +2,8 @@ import { RedocStandalone } from 'redoc';
 
 The information below is generated with [Redoc](https://redocly.com/docs/redoc) consuming the OpenAPI spec found at [https://mainnet-node-status-api.nymtech.cc/api-docs/openapi.json](https://mainnet-node-status-api.nymtech.cc/api-docs/openapi.json) which is also used to generate the Swagger docs deployed at [https://mainnet-node-status-api.nymtech.cc/swagger/](https://mainnet-node-status-api.nymtech.cc/swagger/).
 
+<br /><br />
+
 <RedocStandalone
   specUrl="https://mainnet-node-status-api.nymtech.cc/api-docs/openapi.json"
   options={{

diff --git a/documentation/docs/pages/apis/ns-api/sandbox.mdx b/documentation/docs/pages/apis/ns-api/sandbox.mdx
@@ -2,6 +2,8 @@ import { RedocStandalone } from 'redoc';
 
 The information below is generated with [Redoc](https://redocly.com/docs/redoc) consuming the OpenAPI spec found at [https://sandbox-node-status-api.nymte.ch/api-docs/openapi.json](https://sandbox-node-status-api.nymte.ch/api-docs/openapi.json) which is also used to generate the Swagger docs deployed at [https://sandbox-node-status-api.nymte.ch/swagger/](https://sandbox-node-status-api.nymte.ch/swagger/).
 
+<br /><br />
+
 <RedocStandalone
   specUrl="https://sandbox-node-status-api.nymte.ch/api-docs/openapi.json"
   options={{

diff --git a/documentation/docs/pages/apis/nym-api/mainnet.mdx b/documentation/docs/pages/apis/nym-api/mainnet.mdx
@@ -1,10 +1,27 @@
 import APITable from 'components/api-table.tsx';
+import { RedocStandalone } from 'redoc';
+import { Callout } from 'nextra/components'
 
 You can find the OpenAPI spec found at [https://validator.nymtech.net/api-docs/openapi.json](https://validator.nymtech.net/api-docs/openapi.json) which is also used to generate the Swagger docs deployed at [https://validator.nymtech.net/api/swagger/index.html](https://validator.nymtech.net/api/swagger/index.html).
 
+<Callout type="info" emoji="ℹ️">
 You can find the Swagger endpoints of other NymAPI instances at the following endpoints:
 <APITable endpoint="https://api.nymtech.net/cosmwasm/wasm/v1/contract/n19604yflqggs9mk2z26mqygq43q2kr3n932egxx630svywd5mpxjsztfpvx/smart/eyJnZXRfY3VycmVudF9kZWFsZXJzIjogeyJsaW1pdCI6IDMwfX0=" />
 
 There is also an overview of endpoints at [https://cosmos.directory/nyx](https://cosmos.directory/nyx).
+</Callout>
 
-> Interactive Redoc component coming soon
+<br /><br />
+
+<RedocStandalone
+  specUrl="https://validator.nymtech.net/api-docs/openapi.json"
+  options={{
+    nativeScrollbars: true,
+    theme: {
+      sidebar: {
+        backgroundColor: '#273239',
+        textColor: '#FCFDFE'
+      }
+    }
+  }}
+/>