Merge pull request #105 from ralfhandl/add-examples

Add pages for OAD examples
OAI · Aug 21, 2024 · 87c005c · 87c005c
2 parents 0b247d8 + 8d257cb
commit 87c005c
Show file tree

Hide file tree

Showing 34 changed files with 517 additions and 381 deletions.
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/.github/workflows/examples-tests.yaml b/.github/workflows/examples-tests.yaml
@@ -1,4 +1,4 @@
-name: schema-test
+name: examples-test
 
 # Author: @MikeRalphson / runs @jdesrosiers tests
 # Issue: https://github.com/OAI/OpenAPI-Specification/pull/2489

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -77,6 +77,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-23
   x86_64-darwin-23
   x86_64-linux
 

diff --git a/_includes/example-api-description.md b/_includes/example-api-description.md
@@ -0,0 +1,15 @@
+# {{ include.name }}
+
+{{ include.description }}
+
+## JSON
+
+```json
+{% include_relative {{ include.name | append: ".json" }} %}
+```
+
+## YAML
+
+```yaml
+{% include_relative {{ include.name | append: ".yaml" }} %}
+```
diff --git a/_sass/custom/custom.scss b/_sass/custom/custom.scss
@@ -2,7 +2,11 @@ object {
     width: 100%;
 }
 
-
 .nav-list .nav-list-item .nav-list-expander {
     color: #1d781d !important;
-}
+}
+
+.highlight .err {
+    color: inherit;
+    background-color: inherit;
+}
diff --git a/examples/index.md b/examples/index.md
@@ -0,0 +1,9 @@
+---
+layout: default
+title: Example API Descriptions
+nav_order: 6
+has_children: true
+has_toc: true
+---
+
+# Example API Descriptions
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"
+                            }
+                          ]
+                        }
+                      ]
+                    }
                   }
                 }
               }
@@ -164,4 +189,4 @@
       }
     }
   }
-}
+}
diff --git a/examples/v3.0/api-with-examples.md b/examples/v3.0/api-with-examples.md
@@ -0,0 +1,13 @@
+---
+layout: default
+title: api-with-examples
+parent: Example API Descriptions
+---
+
+{% comment %}
+{% capture description %}
+Insert description here, then remove comment tag above and endcomment tag below
+{% endcapture %}
+{% endcomment %}
+
+{% include example-api-description.md name=page.title description=description %}