Fixes OAS specs for Flows & Operations (#13776)

* add `meta` to list flows & list operations * fix list flows & operations return type array * use 'an' instead of 'a' operation
directus · Jun 8, 2022 · 9f10d1d · 9f10d1d
1 parent 6c1b43b
commit 9f10d1d
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 6 deletions.
diff --git a/packages/specs/src/paths/flows/flows.yaml b/packages/specs/src/paths/flows/flows.yaml
@@ -11,7 +11,11 @@ get:
             type: object
             properties:
               data:
-                $ref: '../../openapi.yaml#/components/schemas/Flows'
+                type: array
+                items:
+                  $ref: '../../openapi.yaml#/components/schemas/Flows'
+              meta:
+                $ref: '../../openapi.yaml#/components/x-metadata'
     '401':
       $ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
     '404':

diff --git a/packages/specs/src/paths/operations/operation.yaml b/packages/specs/src/paths/operations/operation.yaml
@@ -1,5 +1,5 @@
 get:
-  summary: Retrieve a Operation
+  summary: Retrieve an Operation
   description: Retrieve a single operation by unique identifier.
   operationId: getOperation
   responses:
@@ -20,7 +20,7 @@ get:
     - Operations
 
 patch:
-  summary: Update a Operation
+  summary: Update an Operation
   description: Update an existing operation
   operationId: updateOperation
   parameters:
@@ -50,7 +50,7 @@ patch:
     - Operations
 
 delete:
-  summary: Delete a Operation
+  summary: Delete an Operation
   description: Delete an existing operation
   operationId: deleteOperation
   responses:

diff --git a/packages/specs/src/paths/operations/operations.yaml b/packages/specs/src/paths/operations/operations.yaml
@@ -11,7 +11,11 @@ get:
             type: object
             properties:
               data:
-                $ref: '../../openapi.yaml#/components/schemas/Operations'
+                type: array
+                items:
+                  $ref: '../../openapi.yaml#/components/schemas/Operations'
+              meta:
+                $ref: '../../openapi.yaml#/components/x-metadata'
     '401':
       $ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
     '404':
@@ -20,7 +24,7 @@ get:
     - Operations
 
 post:
-  summary: Create a Operation
+  summary: Create an Operation
   description: Create a new operation.
   operationId: createOperation
   parameters: