Update JSON examples

and adjust workflow to use same formatter
OAI · Aug 21, 2024 · 8d257cb · 8d257cb
1 parent a548294
commit 8d257cb
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 1 deletion.
diff --git a/.github/workflows/convert-examples-to-json.yaml b/.github/workflows/convert-examples-to-json.yaml
@@ -36,6 +36,9 @@ jobs:
     - name: convert YAML examples to JSON
       run: find examples/v3* -type f -name "*.yaml" | xargs node scripts/yaml2json/yaml2json.js
 
+    - name: pretty-print JSON examples
+      run: npx prettier --write examples/**/*.json
+
     - name: git diff
       run: |
         git add examples/**/*.json

diff --git a/examples/v3.0/api-with-examples.json b/examples/v3.0/api-with-examples.json
@@ -53,7 +53,32 @@
               "application/json": {
                 "examples": {
                   "foo": {
-                    "value": "{\n \"versions\": [\n       {\n         \"status\": \"CURRENT\",\n         \"updated\": \"2011-01-21T11:33:21Z\",\n         \"id\": \"v2.0\",\n         \"links\": [\n             {\n                 \"href\": \"http://127.0.0.1:8774/v2/\",\n                 \"rel\": \"self\"\n             }\n         ]\n     },\n     {\n         \"status\": \"EXPERIMENTAL\",\n         \"updated\": \"2013-07-23T11:33:21Z\",\n         \"id\": \"v3.0\",\n         \"links\": [\n             {\n                 \"href\": \"http://127.0.0.1:8774/v3/\",\n                 \"rel\": \"self\"\n             }\n         ]\n     }\n ]\n}\n"
+                    "value": {
+                      "versions": [
+                        {
+                          "status": "CURRENT",
+                          "updated": "2011-01-21T11:33:21Z",
+                          "id": "v2.0",
+                          "links": [
+                            {
+                              "href": "http://127.0.0.1:8774/v2/",
+                              "rel": "self"
+                            }
+                          ]
+                        },
+                        {
+                          "status": "EXPERIMENTAL",
+                          "updated": "2013-07-23T11:33:21Z",
+                          "id": "v3.0",
+                          "links": [
+                            {
+                              "href": "http://127.0.0.1:8774/v3/",
+                              "rel": "self"
+                            }
+                          ]
+                        }
+                      ]
+                    }
                   }
                 }
               }

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -30,6 +30,7 @@
   "homepage": "https://learn.openapis.org",
   "dependencies": {
     "@hyperjump/json-schema": "^1.9.2",
+    "prettier": "^3.3.3",
     "vitest": "^1.6.0",
     "yaml": "^2.4.3"
   }