Skip to content

Commit

Permalink
fix(orchestrator): add open api documentation to orchestrator readme (j…
Browse files Browse the repository at this point in the history
…anus-idp#2079)

fix(orchestrator): add open api documentation to orchestrator documentation
FLPATH-1407
https://issues.redhat.com/browse/FLPATH-1407

Signed-off-by: Yaron Dayagi <ydayagi@redhat.com>
  • Loading branch information
ydayagi authored Aug 26, 2024
1 parent d126dd3 commit e25a018
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion plugins/orchestrator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. \
Expand Down

0 comments on commit e25a018

Please sign in to comment.