feat: add node schemas to swagger definitions for mdw (#1862)

Author: yaboiishere

.gitignore

@@ -51,3 +51,4 @@ data
 /node_sdk/output.json
 
 /priv/static/swagger/swagger_v3.*
+/docs/swagger_v3/node_oas3.yaml

Dockerfile

@@ -97,6 +97,7 @@ RUN mix compile
 COPY config/runtime.exs config/
 
 # Generate swagger V3 file
+RUN cp /home/aeternity/node/local/lib/aehttp-$NODE_VERSION/priv/oas3.yaml docs/swagger_v3/node_oas3.yaml
 RUN mix run --no-start -e 'IO.puts(Mix.Project.config[:version])' >AEMDW_VERSION
 ARG PATH_PREFIX
 RUN scripts/swagger-docs.py

docs/swagger_v3/transactions.spec.yaml

@@ -37,8 +37,7 @@ schemas:
           type: string
       tx:
         description: The transaction
-        # TODO: define properties
-        type: object
+        $ref: '#/components/schemas/Tx' 
     example:
       block_hash: mh_ufiYLdN8am8fBxMnb6xq2K4MQKo4eFSCF5bgixq4EzKMtDUXP
       block_height: 1

scripts/do.sh

@@ -48,4 +48,13 @@ case $1 in
 
   "docker-sdk")
     docker-compose -f docker-compose-dev.yml run --rm node_sdk /bin/bash
+    ;;
+
+  "generate-swagger")
+    docker compose -f docker-compose-dev.yml up ae_mdw -d
+    docker compose -f docker-compose-dev.yml exec ae_mdw bash -c "mkdir -p /app/swagger_v3; cp -f /home/aeternity/node/local/lib/aehttp-*/priv/oas3.yaml /app/swagger_v3/node_oas3.yaml"
+    docker compose -f docker-compose-dev.yml cp ae_mdw:/app/swagger_v3/ docs/
+    docker compose -f docker-compose-dev.yml down ae_mdw
+    scripts/swagger-docs.py
+    ;;
 esac

scripts/swagger-docs.py

@@ -5,6 +5,7 @@
 import json
 from glob import glob
 from pathlib import Path
+import re
 
 SWAGGER_DOCS_DIR = 'docs/swagger_v3/'
 MDW_VERSION_FILE = 'AEMDW_VERSION'
@@ -14,6 +15,7 @@
 # Read YAML file
 schemas = {}
 paths = {}
+node_schemas = None
 swagger = None
 mdw_version = None
 
@@ -23,6 +25,10 @@
 with open(MDW_VERSION_FILE) as mdw_version_file:
     mdw_version = mdw_version_file.read().strip()
 
+with open(os.path.join(SWAGGER_DOCS_DIR, 'node_oas3.yaml')) as node_stream:
+    node_oas3 = yaml.safe_load(node_stream)
+    node_schemas = node_oas3['components']['schemas']
+
 for filepath in Path(SWAGGER_DOCS_DIR).glob("*.spec.yaml"):
     with open(filepath, 'r') as stream:
         data_loaded = yaml.safe_load(stream)
@@ -36,6 +42,28 @@
 swagger['info']['version'] = mdw_version
 swagger['servers'][0]['url'] = PATH_PREFIX
 
+old_swagger_schema_len = len(swagger['components']['schemas'])
+
+while True:
+    swagger_str = json.dumps(swagger, indent=2)
+    cleaned_refs = re.findall(r'(?m)"\$ref": "#/components/schemas/(\w+)"', swagger_str)
+
+    missing_refs = []
+    for ref in cleaned_refs:
+        if ref not in swagger['components']['schemas']:
+            missing_refs.append(ref)
+
+    if missing_refs == []:
+        break
+
+    for missing_ref in missing_refs:
+        node_schema = node_schemas[missing_ref]
+        swagger['components']['schemas'][missing_ref] = node_schema
+
+swagger_schema_len = len(swagger['components']['schemas'])
+
+print(f"Added {swagger_schema_len - old_swagger_schema_len} missing schemas")
+
 with open(os.path.join(SWAGGER_OUTPUT_DIR, "swagger_v3.json"), 'w') as jsonfile:
   json.dump(swagger, jsonfile, indent=2)