From caa00247e58d24a547b9529e903ab96dfecded74 Mon Sep 17 00:00:00 2001 From: Owen Date: Wed, 28 Oct 2026 16:42:47 -0400 Subject: [PATCH] Provide openapi routes --- content/docs/manage/common-api-routes.mdx | 2 ++ content/docs/manage/integration-api.mdx | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/content/docs/manage/common-api-routes.mdx b/content/docs/manage/common-api-routes.mdx index e13836c..4615e77 100644 --- a/content/docs/manage/common-api-routes.mdx +++ b/content/docs/manage/common-api-routes.mdx @@ -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). +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`. diff --git a/content/docs/manage/integration-api.mdx b/content/docs/manage/integration-api.mdx index 0933fb2..32623a6 100644 --- a/content/docs/manage/integration-api.mdx +++ b/content/docs/manage/integration-api.mdx @@ -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). Swagger Docs