logos-messaging/logos-messaging-nim
1
0
Fork 0
mirror of https://github.com/logos-messaging/logos-messaging-nim.git synced 2026-01-04 06:53:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(doc): update REST API docs (#2581)

Browse Source
This commit is contained in:
Vaclav Pavlin 2024-04-16 14:27:22 +03:00 committed by GitHub
parent a00f350cd1
commit 006d43aefc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/api/rest-api.md
View File

@ -17,16 +17,9 @@ This API is divided in different _namespaces_ which group a set of resources:
### API Specification ### API Specification
The HTTP REST API has been designed following the OpenAPI 3.0.3 standard specification format. 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 | You can also use [hosted OpenAPI UI](https://waku-org.github.io/waku-rest-api/) to explore and execute the calls locally.
------------|--------------
| `/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/)
Check the [OpenAPI Tools](https://openapi.tools/) site for the right tool for you (e.g. REST API client generator) Check the [OpenAPI Tools](https://openapi.tools/) site for the right tool for you (e.g. REST API client generator)