Skip to content

Commit

Permalink
new structure
Browse files Browse the repository at this point in the history
  • Loading branch information
mfahampshire committed Dec 5, 2024
1 parent abf166b commit c3d8761
Show file tree
Hide file tree
Showing 22 changed files with 81 additions and 136 deletions.
6 changes: 4 additions & 2 deletions documentation/docs/pages/apis/_meta.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
{
"introduction": "Introduction",
"mainnet": "Mainnet",
"sandbox": "Sandbox",
"ns-api": "Node Status API",
"nym-api": "NymAPI Validator Sidecar",
"explorer-api": "Explorer API",
"cosmos-sdk-nyx": "Validator REST API",
"---": {
"type": "separator"
},
Expand Down
3 changes: 3 additions & 0 deletions documentation/docs/pages/apis/cosmos-sdk-nyx.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Validator REST API

Since the [Nyx validators](../../operators/nodes/validator-setup) are built with the Cosmos SDK, they by default expose a [REST API](https://docs.cosmos.network/api) which can be used to query the state of the chain.
9 changes: 9 additions & 0 deletions documentation/docs/pages/apis/cosmos-sdk-nyx/mainnet.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { RedocStandalone } from 'redoc';

The information below is generated with [Redoc](https://redocly.com/docs/redoc) consuming the OpenAPI spec found at [https://api.nymtech.net/swagger/swagger.yaml](https://api.nymtech.net/swagger/swagger.yaml) which is also used to generate the Swagger docs deployed at [https://api.nymtech.net/swagger/](https://api.nymtech.net/swagger/).

TODO where you can find the others - make component

<RedocStandalone
specUrl="https://api.nymtech.net/swagger/swagger.yaml"
/>
9 changes: 9 additions & 0 deletions documentation/docs/pages/apis/cosmos-sdk-nyx/sandbox.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
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 []().

TODO where you can find the others - make component

<RedocStandalone
specUrl=""
/>
8 changes: 8 additions & 0 deletions documentation/docs/pages/apis/explorer-api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

# Explorer API

The Explorer API is the backend for the [Mixnet Explorer](https://explorer.nymtech.net/).

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

The code for this service can be found [in our monorepo](https://github.com/nymtech/nym/tree/develop/explorer).
8 changes: 8 additions & 0 deletions documentation/docs/pages/apis/explorer-api/mainnet.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,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).

<RedocStandalone
specUrl="https://sandbox-explorer.nymtech.net/api/v1/openapi.json"
/>
7 changes: 7 additions & 0 deletions documentation/docs/pages/apis/explorer-api/sandbox.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
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).

<RedocStandalone
specUrl="https://sandbox-explorer.nymtech.net/api/v1/openapi.json"
/>
6 changes: 0 additions & 6 deletions documentation/docs/pages/apis/mainnet/_meta.json

This file was deleted.

14 changes: 0 additions & 14 deletions documentation/docs/pages/apis/mainnet/cosmos-sdk-nyx.mdx

This file was deleted.

20 changes: 0 additions & 20 deletions documentation/docs/pages/apis/mainnet/explorer-api.mdx

This file was deleted.

15 changes: 0 additions & 15 deletions documentation/docs/pages/apis/mainnet/ns-api.mdx

This file was deleted.

13 changes: 0 additions & 13 deletions documentation/docs/pages/apis/mainnet/nym-api.mdx

This file was deleted.

11 changes: 11 additions & 0 deletions documentation/docs/pages/apis/ns-api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Callout } from 'nextra/components'

# Node Status API

The Node Status API contains information about the network, its topology, and the routing scores of all nodes within it. It offers broadly similar information to the experimental [Habourmaster frontend](https://harbourmaster.nymtech.net/) but is stable where the Harbourmaster is subject to sudden changes as we modify and experiment with how we scrape and present data about the Mixnet infrastructure.

<Callout type="info">
People building applications or dashboards which requires information about nodes, their uptime, and their delegations should use this instead of Habourmaster.
</Callout>

The code for this service can be found [in our monorepo](https://github.com/nymtech/nym/tree/develop/nym-node-status-api). In the future we will encourage developers to run their own instance of this API in order to distribute endpoints and query load.
7 changes: 7 additions & 0 deletions documentation/docs/pages/apis/ns-api/mainnet.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
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/).

<RedocStandalone
specUrl="https://mainnet-node-status-api.nymtech.cc/api-docs/openapi.json"
/>
7 changes: 7 additions & 0 deletions documentation/docs/pages/apis/ns-api/sandbox.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
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/).

<RedocStandalone
specUrl="https://sandbox-node-status-api.nymte.ch/api-docs/openapi.json"
/>
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@


import { RedocStandalone } from 'redoc';

# NymAPI

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

> Redoc Component using `specUrl` goes here once spec is fixed
3 changes: 3 additions & 0 deletions documentation/docs/pages/apis/nym-api/mainnet.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
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).

> Redoc Component using `specUrl` goes here once spec is fixed
5 changes: 5 additions & 0 deletions documentation/docs/pages/apis/nym-api/sandbox.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
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 []().

> Redoc Component using `specUrl` goes here once spec is fixed
6 changes: 0 additions & 6 deletions documentation/docs/pages/apis/sandbox/_meta.json

This file was deleted.

11 changes: 0 additions & 11 deletions documentation/docs/pages/apis/sandbox/cosmos-sdk-nyx.mdx

This file was deleted.

20 changes: 0 additions & 20 deletions documentation/docs/pages/apis/sandbox/explorer-api.mdx

This file was deleted.

19 changes: 0 additions & 19 deletions documentation/docs/pages/apis/sandbox/ns-api.mdx

This file was deleted.

0 comments on commit c3d8761

Please sign in to comment.