HTTP documentation generation from OpenApi documentation (#1438)

* Generating rest doc from swagger json Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> * refactoring and adding doc Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> * refactoring Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> * Don't directly inject files in the executable jar since it brakes it Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> * using the attachArtifact configuration to generate secondary artifact Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> * Splitting the json documentation into mgmt and ddi. And some refactoring Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> * refactoring Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> * Split mgmt and DDI components from the json Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com> --------- Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com>
2023-09-27 11:44:30 +03:00
parent 7d76a5a97e
commit 3978454900
23 changed files with 308 additions and 208 deletions
--- a/docs/split-doc.sh
+++ b/docs/split-doc.sh
@@ -0,0 +1,52 @@
+#
+# Copyright (c) 2018 Bosch Software Innovations GmbH and others
+#
+# This program and the accompanying materials are made
+# available under the terms of the Eclipse Public License 2.0
+# which is available at https://www.eclipse.org/legal/epl-2.0/
+#
+# SPDX-License-Identifier: EPL-2.0
+#
+
+#!/bin/bash
+
+CURRENT_DIR=$(pwd)
+input_file=${CURRENT_DIR}/content/rest-api/openapi.json
+mgmt_file=${CURRENT_DIR}/content/rest-api/mgmt.json
+ddi_file=${CURRENT_DIR}/content/rest-api/ddi.json
+
+jq '
+  .paths |= with_entries(
+    select(
+      reduce .value[] as $item (
+        false;
+        . or ($item.tags? | index("DDI Root Controller")) == null
+      )
+    )
+  )
+  | .tags |= map(select(.name | contains("DDI") | not))
+  | .components.schemas = (.components.schemas | with_entries(select(.key | startswith("Ddi") | not)))
+' "$input_file" > "$mgmt_file"
+
+jq '
+  .paths |= with_entries(
+    select(
+      reduce .value[] as $item (
+        false;
+        . or ($item.tags? | index("DDI Root Controller")) != null
+      )
+    )
+  )
+  | .tags |= map(select(.name | contains("DDI")))
+  | .components.schemas = (
+        .components.schemas
+        | with_entries(
+            select(
+                (.key | startswith("Ddi"))
+                or (.key | . == "Link")
+                or (.key | . == "ExceptionInfo")
+            )
+        )
+    )
+' "$input_file" > "$ddi_file"
+