api: move string-only JSON examples to the spec. YAML

Workaround redocly rendering issue which omits the quotes, which makes it an invalid JSON string.
bbc · Nov 21, 2024 · f326e28 · f326e28
1 parent c3971b9
commit f326e28
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 12 deletions.
diff --git a/api/TimeAddressableMediaStore.yaml b/api/TimeAddressableMediaStore.yaml
@@ -1024,8 +1024,8 @@ paths:
           description: ""
           content:
             application/json:
-              example:
-                $ref: examples/flow-tag-get-200.json
+              example: |
+                "full"
               schema:
                 type: string
         "404":
@@ -1039,8 +1039,8 @@ paths:
       requestBody:
         content:
           application/json:
-            example:
-              $ref: examples/flow-tag-put.json
+            example: |
+              "proxy"
             schema:
               type: string
         required: true
@@ -1096,8 +1096,10 @@ paths:
           description: ""
           content:
             application/json:
-              example:
-                $ref: examples/flow-description-get-200.json
+              example: |
+                "video capture"
+              schema:
+                type: string
         "404":
           description: The requested flow does not exist.
     put:
@@ -1109,8 +1111,8 @@ paths:
       requestBody:
         content:
           application/json:
-            example:
-              $ref: examples/flow-description-put.json
+            example: |
+              "Big Buck Bunny video-only capture"
             schema:
               type: string
         required: true

diff --git a/api/examples/flow-description-get-200.json b/api/examples/flow-description-get-200.json
diff --git a/api/examples/flow-description-put.json b/api/examples/flow-description-put.json
diff --git a/api/examples/flow-tag-get-200.json b/api/examples/flow-tag-get-200.json
diff --git a/api/examples/flow-tag-put.json b/api/examples/flow-tag-put.json