diff options
author | Austin S. Hemmelgarn <austin@netdata.cloud> | 2022-06-30 14:03:11 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-06-30 14:03:11 +0300 |
commit | ab58cc58863d9c060c928ff12c6834da50d229ae (patch) | |
tree | fa8c6c98f9ba0d4df17ec91d35385043b326f8d5 /web | |
parent | 8a67b955b493252c83b850671f5e499ab73fadeb (diff) |
Update documentation about our REST API documentation. (#13269)
Diffstat (limited to 'web')
-rw-r--r-- | web/api/README.md | 6 |
1 files changed, 2 insertions, 4 deletions
diff --git a/web/api/README.md b/web/api/README.md index 89a9530027..fc520a09af 100644 --- a/web/api/README.md +++ b/web/api/README.md @@ -7,8 +7,6 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/README.m ## Netdata REST API -The complete documentation of the Netdata API is available at the **[Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/netdata/netdata/master/web/api/netdata-swagger.yaml)**. - -If your prefer it over the Swagger Editor, you can also use **[Swagger UI](https://registry.my-netdata.io/swagger/#!/default/get_data)**. This however does not provide all the information available. - +The complete documentation of the Netdata API is available as a Swagger API document [in our GitHub repository](https://raw.githubusercontent.com/netdata/netdata/master/web/api/netdata-swagger.yaml). You can view it online using the **[Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/netdata/netdata/master/web/api/netdata-swagger.yaml)**. +If your prefer it over the Swagger Editor, you can also use [Swagger UI](https://github.com/swagger-api/swagger-ui) by pointing at `web/api/netdata-swagger.yaml` in the Netdata source tree (or at https://raw.githubusercontent.com/netdata/netdata/master/web/api/netdata-swagger.yaml if you want to use the Swagger API definitions directly from our GitHub repository). This however does not provide all the information available. |