mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-10-29 23:19:12 +01:00
Provide openapi routes
This commit is contained in:
@@ -9,6 +9,8 @@ All routes in this guide require an API key. See [Integration API](/manage/integ
|
||||
This guide is a **minimal** walkthrough for creating core Pangolin components (sites, resources, targets) via the API. It is not exhaustive — some elements are omitted for simplicity — but everything shown here works and illustrates patterns used elsewhere in the API. For full coverage of endpoints (get, update, delete, list, etc.), use the [Swagger docs](https://api.pangolin.net/v1/docs).
|
||||
</Note>
|
||||
|
||||
OpenAPI-compliant documentation is available at https://api.pangolin.net/v1/openapi.json and https://api.pangolin.net/v1/openapi.yaml
|
||||
|
||||
## What is an identifier?
|
||||
|
||||
In the Pangolin app, sites, public resources, private resources, and clients have an **Identifier**. In the API, this value is called `niceId`.
|
||||
|
||||
@@ -86,9 +86,9 @@ Root API keys have elevated permissions and should be used carefully. Only creat
|
||||
|
||||
For a minimal walkthrough of common flows (sites, resources, targets, assigning roles and users), see [Common API Routes](/manage/common-api-routes).
|
||||
|
||||
View the full Swagger docs here: [https://api.pangolin.net/v1/docs](https://api.pangolin.net/v1/docs).
|
||||
OpenAPI-compliant documentation is available at https://api.pangolin.net/v1/openapi.json and https://api.pangolin.net/v1/openapi.yaml
|
||||
|
||||
Interactive API documentation is available through Swagger UI:
|
||||
View the full Swagger docs here: [https://api.pangolin.net/v1/docs](https://api.pangolin.net/v1/docs).
|
||||
|
||||
<Frame caption="Swagger UI showing API endpoints and interactive testing">
|
||||
<img src="/images/swagger.png" alt="Swagger Docs"/>
|
||||
|
||||
Reference in New Issue
Block a user