generate openapi spec api-doc

FLPATH-1774 https://issues.redhat.com/browse/FLPATH-1774 Signed-off-by: Yaron Dayagi <[email protected]>
redhat-developer · Dec 2, 2024 · 7435548 · 7435548
1 parent 0703b6a
commit 7435548
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 2 deletions.
diff --git a/workspaces/orchestrator/plugins/orchestrator-common/scripts/openapi.sh b/workspaces/orchestrator/plugins/orchestrator-common/scripts/openapi.sh
@@ -8,16 +8,22 @@ API_FOLDER="${GENERATED_FOLDER}/api"
 DEFINITION_FILE="${API_FOLDER}/definition.ts"
 METADATA_FILE="${GENERATED_FOLDER}/.METADATA.sha1"
 CLIENT_FOLDER="${GENERATED_FOLDER}/client"
+APIDOC_TEMPLATE_FILE="./src/openapi/api-doc-template.yaml"
+APIDOC_GENERATED_FILE=${GENERATED_FOLDER}/docs/api-doc/orchestrator-api.yaml
 
 openapi_generate() {
     # TypeScript Client generation
     rm -rf ${CLIENT_FOLDER}
     openapi-generator-cli generate -g typescript-axios -i ${OPENAPI_SPEC_FILE} -o ${CLIENT_FOLDER}
 
     # Docs generation
-    rm -rf ./src/generated/docs/markdown ./src/generated/docs/html
+    rm -rf ./src/generated/docs/markdown ./src/generated/docs/html ./src/generated/docs/api-doc
     openapi-generator-cli generate -g markdown -i ${OPENAPI_SPEC_FILE} -o ./src/generated/docs/markdown/
     openapi-generator-cli generate -g html2 -i ${OPENAPI_SPEC_FILE} -o ./src/generated/docs/html
+    mkdir ./src/generated/docs/api-doc
+    cp $APIDOC_TEMPLATE_FILE $APIDOC_GENERATED_FILE
+    cat $OPENAPI_SPEC_FILE | sed 's/^/    /g' >> $APIDOC_GENERATED_FILE
+
 
     yaml2json -f ${OPENAPI_SPEC_FILE}
 

diff --git a/workspaces/orchestrator/plugins/orchestrator-common/src/openapi/api-doc-template.yaml b/workspaces/orchestrator/plugins/orchestrator-common/src/openapi/api-doc-template.yaml
@@ -0,0 +1,12 @@
+apiVersion: backstage.io/v1alpha1
+kind: API
+metadata:
+  name: orchestrator-backend
+  description: The Orchestrator backend plugin API
+  tags:
+    - orchestrator
+spec:
+  type: openapi
+  lifecycle: experimental
+  owner: development
+  definition: |
diff --git a/workspaces/orchestrator/plugins/orchestrator-common/src/openapi/openapi.yaml b/workspaces/orchestrator/plugins/orchestrator-common/src/openapi/openapi.yaml
@@ -357,7 +357,7 @@ components:
         workflowId:
           type: string
           description: Workflow unique identifier
-          minLength: 1
+          minLength: 2
         name:
           type: string
           description: Workflow name

diff --git a/workspaces/orchestrator/scripts/postinstall b/workspaces/orchestrator/scripts/postinstall
@@ -0,0 +1,6 @@
+#!/bin/bash
+mydir=`pwd`
+cd ../../ && yarn install
+cd $mydir
+cd plugins/orchestrator-common
+yarn openapi:check