From 006d43aefc273706101097f393ce14e6c853032e Mon Sep 17 00:00:00 2001 From: Vaclav Pavlin Date: Tue, 16 Apr 2024 14:27:22 +0300 Subject: [PATCH] fix(doc): update REST API docs (#2581) --- docs/api/rest-api.md | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/docs/api/rest-api.md b/docs/api/rest-api.md index 6e8393b843..eeb90abfb4 100644 --- a/docs/api/rest-api.md +++ b/docs/api/rest-api.md @@ -17,16 +17,9 @@ This API is divided in different _namespaces_ which group a set of resources: ### API Specification The HTTP REST API has been designed following the OpenAPI 3.0.3 standard specification format. -The OpenAPI specification files can be found here: +The OpenAPI specification files can be found in the [Waku Node REST API Reference](https://waku-org.github.io/waku-rest-api/) repository. -| Namespace | OpenAPI file | -------------|-------------- -| `/debug` | [openapi.yaml](https://github.com/waku-org/nwaku/blob/master/waku/v2/node/rest/debug/openapi.yaml) | -| `/relay` | [openapi.yaml](https://github.com/waku-org/nwaku/blob/master/waku/v2/node/rest/relay/openapi.yaml) | -| `/store` | [openapi.yaml](https://github.com/waku-org/nwaku/blob/master/waku/v2/node/rest/store/openapi.yaml) | -| `/filter` | [openapi.yaml](https://github.com/waku-org/nwaku/blob/master/waku/v2/node/rest/filter/openapi.yaml) | - -The OpenAPI files can be analysed online with [Redocly](https://redocly.github.io/redoc/) +You can also use [hosted OpenAPI UI](https://waku-org.github.io/waku-rest-api/) to explore and execute the calls locally. Check the [OpenAPI Tools](https://openapi.tools/) site for the right tool for you (e.g. REST API client generator)