From 49f16965ebf2f4648f810b06d4207d6fbc65877a Mon Sep 17 00:00:00 2001 From: blade Date: Thu, 28 Mar 2024 11:15:24 -0500 Subject: [PATCH] update postman collection --- docs/api-endpoints.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/api-endpoints.md b/docs/api-endpoints.md index dbd7995..a9b965b 100644 --- a/docs/api-endpoints.md +++ b/docs/api-endpoints.md @@ -2,13 +2,15 @@ The Gateway Server currently exposes all its API endpoints in form of HTTP endpoints. Note, we can move this to Swagger in the future if our API endpoints become more complex. +Postman collection can be found [here](https://www.postman.com/dark-shadow-851601/workspace/os-gateway/collection/27302708-537f3ba3-3193-4290-98d0-0d5836988a2f) + `x-api-key` is an api key set by the gateway operator to transmit internal private data -| Endpoint | HTTP METHOD | Description | HEADERS | Request Parameters | -|---------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------------------------------------| -| `/relay/{chain_id}` | ANY | The main endpoint for your reverse proxy to send requests too | ANY | `{chain_id}` - Network identifier | -| `/metrics` | GET | Metadata on the gateway server performance for observability purposes | N/A | N/A | -| `/poktapps` | POST | Adds an existing app stake to the appstake database (not recommended due to security) | `x-api-key` | `private_key` - private key of app stake | -| `/poktapps` | DELETE | Removes an existing app stake from the appstake database (not recommended due to security) | `x-api-key` | `app_id` - id of the appstake | -| `/poktapps` | GET | A list of all the available app stakes | `x-api-key` | N/A | -| `/qosnodes` | GET | A list of nodes and public QoS state such as healthiness and last known error. This can be used to expose to node operators to improve visibility. | `x-api-key` | N/A | \ No newline at end of file +| Endpoint | HTTP METHOD | Description | HEADERS | Request Parameters | +|----------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------------------------------------------| +| `/relay/{chain_id}` | ANY | The main endpoint for your reverse proxy to send requests too | ANY | `{chain_id}` - Network identifier | +| `/metrics` | GET | Metadata on the gateway server performance for observability purposes | N/A | N/A | +| `/poktapps` | GET | A list of all the available app stakes | `x-api-key` | N/A | +| `/poktapps` | POST | Adds an existing app stake to the appstake database (not recommended due to security) | `x-api-key` | `private_key` - private key of app stake | +| `/poktapps/{app_id}` | DELETE | Removes an existing app stake from the appstake database (not recommended due to security) | `x-api-key` | `app_id` - id of the appstake | +| `/qosnodes` | GET | A list of nodes and public QoS state such as healthiness and last known error. This can be used to expose to node operators to improve visibility. | `x-api-key` | N/A | \ No newline at end of file