Skip to content

Commit

Permalink
Update api-specifications.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dhedey authored Dec 13, 2024
1 parent 8923604 commit 473afac
Showing 1 changed file with 3 additions and 13 deletions.
16 changes: 3 additions & 13 deletions docs/api-specifications.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,12 @@
# API Specifications

There are (at time of writing) three main Radix APIs:

* [Gateway API](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/radixdlt/radixdlt-network-gateway/main/gateway-api-schema.yaml) - The main public facing API, exposed by the Network Gateway
* [Core API](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/radixdlt/radixdlt/main/radixdlt-core/radixdlt/src/main/java/com/radixdlt/api/core/api.yaml) - An API exposed by radixdlt full nodes, intended to be exposed on private networks
* [System API](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/radixdlt/radixdlt/main/radixdlt-core/radixdlt/src/main/java/com/radixdlt/api/system/api.yaml) - An API exposed privately by radixdlt nodes to get information about the node health/status.

The links above link to the ReDocly docs, reading the schemas on the `main` branches of each repo. As such, they may include features that are not yet on the latest release.
The documentation site covers details about the various [Network APIs](https://docs.radixdlt.com/docs/network-apis) exposed in the Radix stack.

## Gateway API

As the Gateway API is exposed by the Gateway Service, the Gateway API specification source-of-truth lives in the [Open API Schema in the Network Gateway repository](../src/RadixDlt.NetworkGateway.GatewayApi/gateway-api-schema.yaml).

The Open API specification should be kept up to date with the interface that the Gateway API service exposes.

## Core and System APIs
The current [Gateway API schema](https://radix-babylon-gateway-api.redoc.ly/) of the foundation Gateway is available on Redocly.

The source of truth for the Core and System APIs lives on the full node - and the specs on the `main` branch are here: [Core Open API Spec](https://github.com/radixdlt/radixdlt/blob/main/radixdlt-core/radixdlt/src/main/java/com/radixdlt/api/core/api.yaml) | [System Open API Spec](https://github.com/radixdlt/radixdlt/blob/main/radixdlt-core/radixdlt/src/main/java/com/radixdlt/api/system/api.yaml).
The Gateway API schema source-of-truth lives in this repository as an Open API definition in [gateway-api-schema.yaml](../src/RadixDlt.NetworkGateway.GatewayApi/gateway-api-schema.yaml).

## Model and Client Generation

Expand Down

0 comments on commit 473afac

Please sign in to comment.