From e25a018583a3636ca41cc452842ecaefa702a4d8 Mon Sep 17 00:00:00 2001 From: Yaron Dayagi Date: Mon, 26 Aug 2024 12:00:01 +0300 Subject: [PATCH] fix(orchestrator): add open api documentation to orchestrator readme (#2079) fix(orchestrator): add open api documentation to orchestrator documentation FLPATH-1407 https://issues.redhat.com/browse/FLPATH-1407 Signed-off-by: Yaron Dayagi --- plugins/orchestrator/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/plugins/orchestrator/README.md b/plugins/orchestrator/README.md index 0764341980..6eed006bfa 100644 --- a/plugins/orchestrator/README.md +++ b/plugins/orchestrator/README.md @@ -224,7 +224,8 @@ The plugin provides OpenAPI `v2` endpoints definition to facilitate communicatio In addition, by leveraging on OpenAPI spec, it is possible to generate clients and create CI steps. -OpenAPI specification [file](https://github.com/janus-idp/backstage-plugins/blob/main/plugins/orchestrator-common/src/openapi/openapi.yaml) is available in [orchestrator-common](https://github.com/janus-idp/backstage-plugins/blob/main/plugins/orchestrator-common). +OpenAPI specification [file](https://github.com/janus-idp/backstage-plugins/blob/main/plugins/orchestrator-common/src/openapi/openapi.yaml) is available in [orchestrator-common](https://github.com/janus-idp/backstage-plugins/blob/main/plugins/orchestrator-common). +OpenAPI specification documentation is available [here](https://github.com/janus-idp/backstage-plugins/blob/main/plugins/orchestrator-common/src/generated/docs/index.adoc/index.adoc) > **NOTE:**\ > While the OpenAPI specification is available in the Orchestrator plugin, the UI currently does not rely on this spec. \