From 9d1fb776235c314d12015dcef8bf9e2868b06b01 Mon Sep 17 00:00:00 2001 From: kievitsp Date: Wed, 6 Dec 2023 09:08:04 +0000 Subject: [PATCH 1/2] Update Open-API docs with authentication info The Open-API documentation is updated to include important information regarding the requirement of authentication to access the rest endpoints. This information is crucial for developers and users integrating and interfacing with the API, helping them understand and ensure proper authentication to avoid potential access issues. --- docs/03_server/10_integration/12_open-api.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/03_server/10_integration/12_open-api.md b/docs/03_server/10_integration/12_open-api.md index 6a524f9251..59c22d591e 100644 --- a/docs/03_server/10_integration/12_open-api.md +++ b/docs/03_server/10_integration/12_open-api.md @@ -38,6 +38,13 @@ Genesis Open API supports Open API version 3.1. ::: +:::important + +Please note that all requests to the rest endpoints below need to be authenticated, for details please refer +to [Authentication](../../integration/rest-endpoints/basics/). + +::: + The Open API specification is generated at runtime and is available at the following endpoints: Full specification: From cfed0833cc642640df391f3daccb5471ce55a9d8 Mon Sep 17 00:00:00 2001 From: wjhendry <90383531+wjhendry@users.noreply.github.com> Date: Wed, 6 Dec 2023 09:39:34 +0000 Subject: [PATCH 2/2] Update 12_open-api.md --- docs/03_server/10_integration/12_open-api.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/03_server/10_integration/12_open-api.md b/docs/03_server/10_integration/12_open-api.md index 59c22d591e..d4a57c081d 100644 --- a/docs/03_server/10_integration/12_open-api.md +++ b/docs/03_server/10_integration/12_open-api.md @@ -16,7 +16,7 @@ Open API support was introduced in version 7.0 of the Genesis platform. ::: -The Genesis low-code platform supports the use of [Open API](https://swagger.io/specification/) in order to integrate with external systems. +The Genesis low-code platform uses [Open API](https://swagger.io/specification/) to integrate with external systems. Genesis makes this easy to configure and set up, and an Open API specification is generated for the following resources: @@ -40,8 +40,7 @@ Genesis Open API supports Open API version 3.1. :::important -Please note that all requests to the rest endpoints below need to be authenticated, for details please refer -to [Authentication](../../integration/rest-endpoints/basics/). +All requests to the rest endpoints below need to be [authenticated](../../integration/rest-endpoints/basics/). :::