cleans up examples

workloads · Sep 3, 2024 · 5adc2a3 · 5adc2a3
1 parent 178df95
commit 5adc2a3
Showing 1 changed file with 26 additions and 10 deletions.
diff --git a/mobility-platform/openapi.yml b/mobility-platform/openapi.yml
@@ -295,10 +295,12 @@ components:
           properties:
             title:
               type: string
-              example: Bad Request
+              examples:
+                - Bad Request
             type:
               type: number
-              example: 400
+              examples:
+                - 400
       examples:
         - title: Bad Request
           type: 400
@@ -310,10 +312,12 @@ components:
           properties:
             title:
               type: string
-              example: Forbidden
+              examples:
+                - Forbidden
             type:
               type: number
-              example: 403
+              examples:
+                - 403
       examples:
         - title: Forbidden
           type: 403
@@ -325,10 +329,12 @@ components:
           properties:
             title:
               type: string
-              example: Internal Server Error
+              examples:
+                - Internal Server Error
             type:
               type: number
-              example: 500
+              examples:
+                - 500
       examples:
         - title: Internal Server Error
           type: 500
@@ -355,10 +361,12 @@ components:
           properties:
             title:
               type: string
-              example: Unauthorized
+              examples:
+                - Unauthorized
             type:
               type: number
-              example: 401
+              examples:
+                - 401
       examples:
           - title: Unauthorized
             type: 401
@@ -395,6 +403,12 @@ components:
           examples:
             - movement-1ab2
           type: string
+        name:
+          description: "Name of the movement plan"
+          examples:
+            - Movement Plan
+            - movement-plan
+          type: string
       required:
         - id
         - name
@@ -607,15 +621,17 @@ components:
         text/html:
           schema:
             type: string
-            example: "<html><body>Index</body></html>"
+            examples:
+              - "<html><body>Index</body></html>"
       description: "Response containing HTML"
 
     InterfaceApiRoot:
       content:
         text/html:
           schema:
             type: string
-            example: "<html><body>API Index</body></html>"
+            examples:
+              - "<html><body>API Index</body></html>"
       description: "Response containing HTML"
 
     Movement: