Merge pull request #83 from Asana/johnvu-change-add-step-to-convert-yaml-to-json-for-readme

Convert YAML to JSON for readme docs

Author: jv-asana

.github/workflows/push_openapi_spec_to_readme.yml

@@ -30,8 +30,18 @@ jobs:
           parse-json-secrets: true
       - name: Check out repo 📚
         uses: actions/checkout@v5
+      - name: Set up Python 🐍
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      - name: Install Python dependencies 📦
+        run: |
+          python -m pip install --upgrade pip
+          pip install pyyaml
+      - name: Convert YAML to JSON 🔄
+        run: python convert_yaml_to_json.py
       - name: Run `openapi` command 🚀
         uses: readmeio/rdme@v10
         with:
           # id is the id of the API definition
-          rdme: openapi upload defs/asana_oas.yaml --key=${{ env.README_API_KEY }} --slug=asana
+          rdme: openapi upload defs/asana_oas.json --key=${{ env.README_API_KEY }} --slug=asana

convert_yaml_to_json.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python3
+"""
+Convert YAML OpenAPI specification to JSON format.
+"""
+
+import json
+import yaml
+import os
+from pathlib import Path
+
+
+def convert_yaml_to_json():
+    """Convert YAML OpenAPI specifications to JSON format."""
+    script_dir = Path(__file__).parent
+
+    # Files to convert
+    yaml_files = [
+        "asana_oas.yaml",
+        "app_components_oas.yaml"
+    ]
+
+    for yaml_filename in yaml_files:
+        yaml_file = script_dir / "defs" / yaml_filename
+        json_filename = yaml_filename.replace('.yaml', '.json')
+        json_file = script_dir / "defs" / json_filename
+
+        if not yaml_file.exists():
+            print(f"Warning: YAML file not found: {yaml_file}")
+            continue
+
+        # Load YAML file
+        with open(yaml_file, 'r', encoding='utf-8') as f:
+            yaml_data = yaml.safe_load(f)
+
+        # Write JSON file
+        with open(json_file, 'w', encoding='utf-8') as f:
+            json.dump(yaml_data, f, indent=2, ensure_ascii=False)
+
+        print(f"Successfully converted {yaml_file} to {json_file}")
+
+
+if __name__ == "__main__":
+    convert_yaml_to_json()