From 5dc7e7f55cfff03d2f17051aacb0067c838b2d61 Mon Sep 17 00:00:00 2001 From: Johan Brandhorst-Satzkorn Date: Fri, 16 Sep 2022 09:02:15 -0700 Subject: [PATCH] doc: Add link to generated API docs on API page (#2460) * doc: Add link to generated API docs on API page This makes it easier to find the generated API docs from the API description page. * Update website/content/docs/api-clients/api.mdx Co-authored-by: Yoko Hyakuna Co-authored-by: Yoko Hyakuna --- website/content/docs/api-clients/api.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/content/docs/api-clients/api.mdx b/website/content/docs/api-clients/api.mdx index 2311ae0968..3c1660e8a6 100644 --- a/website/content/docs/api-clients/api.mdx +++ b/website/content/docs/api-clients/api.mdx @@ -13,6 +13,8 @@ Before reading this page, it is useful to understand Boundary's [domain model](/ Boundary's API is also described via OpenAPI v2; the version corresponding to any tag of Boundary's source code can be found in Boundary's [GitHub repository](https://github.com/hashicorp/boundary/blob/main/internal/gen/controller.swagger.json). +-> **NOTE:** A rendered version of this generated API definition can be found on the [API page](/api-docs). + Boundary's current API version is 1; all API paths begin with `/v1/`. ## Status Codes