Skip to content

Commit

Permalink
temp commit before changing structure
Browse files Browse the repository at this point in the history
  • Loading branch information
mfahampshire committed Dec 5, 2024
1 parent 7492b1c commit abf166b
Show file tree
Hide file tree
Showing 10 changed files with 78 additions and 5 deletions.
4 changes: 2 additions & 2 deletions documentation/docs/components/landing-page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ export const LandingPage = () => {
},
{
text: "APIs",
description: "Redoc API references",
description: "Redoc APIs",

href: "/apis",
href: "/apis/introduction",
icon: sdkDocs, // TODO NEW IMAGE
},
];
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Wednesday, December 4th 2024, 22:35:02 UTC
Thursday, December 5th 2024, 10:36:14 UTC
4 changes: 3 additions & 1 deletion documentation/docs/pages/apis/mainnet/_meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
{
"ns-api": "Node Status API",
"nym-api": "NymAPI"
"nym-api": "NymAPI",
"explorer-api": "Explorer API",
"cosmos-sdk-nyx": "Validator REST API"
}
14 changes: 14 additions & 0 deletions documentation/docs/pages/apis/mainnet/cosmos-sdk-nyx.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { RedocStandalone } from 'redoc';

- what this is
- where you can find the others - link to chain registry

<RedocStandalone
specUrl="https://api.nymtech.net/swagger/swagger.yaml"
options={{
suppressWarnings: true,
disableSidebar: true,
}}
/>

TODO CHANGE EVERYTHING TO TYPE->DROPDOWN(MAINNET/SANDBOX)
20 changes: 20 additions & 0 deletions documentation/docs/pages/apis/mainnet/explorer-api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@

import { RedocStandalone } from 'redoc';

# Explorer API

The Explorer API is the backend for the [Mixnet Explorer]().

**This will soon be deprecated in favour of the [Node Status API]().**

The code for this service can be found [in our monorepo]().

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 []().

<RedocStandalone
specUrl="https://sandbox-explorer.nymtech.net/api/v1/openapi.json"
options={{
suppressWarnings: true,
disableSidebar: true,
}}
/>
2 changes: 2 additions & 0 deletions documentation/docs/pages/apis/mainnet/nym-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import { RedocStandalone } from 'redoc';

The [NymAPI](../../operators/nodes/validator-setup/nym-api) is a sidecar binary operated by members of the Nym Validator set. Amongst other things, the API offers endpoints to query regarding circulating `NYM` supply, and global and ticketbook-specific [zk-nym](../../network/cryptography/zk-nym) data. This is all information contained in various smart contracts on the Nyx blockchain; the NymAPI caches this information periodically to make queries faster and more scalable.

TODO ADD COMPONENT TO GRAB AND PARSE LIST OF THEM FROM COMMENT

The code for this service can be found [in our monorepo](https://github.com/nymtech/nym/tree/develop/nym-api).

The information below is generated with [Redoc](https://redocly.com/docs/redoc) consuming 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).
Expand Down
4 changes: 3 additions & 1 deletion documentation/docs/pages/apis/sandbox/_meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
{
"ns-api": "Node Status API",
"nym-api": "NymAPI"
"nym-api": "NymAPI",
"explorer-api": "Explorer API",
"cosmos-sdk-nyx": "Validator REST API"
}
11 changes: 11 additions & 0 deletions documentation/docs/pages/apis/sandbox/cosmos-sdk-nyx.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

- what this is
- where you can find the others - link to chain registry

<RedocStandalone
specUrl="https://api.nymtech.net/swagger/swagger.yaml"
options={{
suppressWarnings: true,
disableSidebar: true,
}}
/>
20 changes: 20 additions & 0 deletions documentation/docs/pages/apis/sandbox/explorer-api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@

import { RedocStandalone } from 'redoc';

# Explorer API

The Explorer API is the backend for the [Mixnet Explorer]().

**This will soon be deprecated in favour of the [Node Status API]().**

The code for this service can be found [in our monorepo]().

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 []().

<RedocStandalone
specUrl="https://explorer.nymtech.net/api/v1/openapi.json"
options={{
suppressWarnings: true,
disableSidebar: true,
}}
/>
2 changes: 2 additions & 0 deletions documentation/docs/pages/apis/sandbox/nym-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ import { RedocStandalone } from 'redoc';

The [NymAPI](../../operators/nodes/validator-setup/nym-api) is a sidecar binary operated by members of the Nym Validator set. Amongst other things, the API offers endpoints to query regarding circulating `NYM` supply, and global and ticketbook-specific [zk-nym](../../network/cryptography/zk-nym) data. This is all information contained in various smart contracts on the Nyx blockchain; the NymAPI caches this information periodically to make queries faster and more scalable.

TODO ADD COMPONENT TO GRAB AND PARSE LIST OF THEM FROM COMMENT

The code for this service can be found [in our monorepo](https://github.com/nymtech/nym/tree/develop/nym-api).

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 []().
Expand Down

0 comments on commit abf166b

Please sign in to comment.