From 577f36c3a6e4acfd255cc0fac87efa2062f9ae7e Mon Sep 17 00:00:00 2001
From: Aramis Sennyey <sennyeya@amazon.com>
Date: Wed, 15 Mar 2023 12:16:41 -0400
Subject: [PATCH] Update spec with better parameters and fix conflict in
 yarn.lock.

Signed-off-by: Aramis Sennyey <sennyeya@amazon.com>
---
 plugins/catalog-backend/openapi.yaml      | 73 ++++++++++-------------
 plugins/catalog-backend/schema/openapi.ts | 22 ++-----
 yarn.lock                                 |  2 +-
 3 files changed, 39 insertions(+), 58 deletions(-)

diff --git a/plugins/catalog-backend/openapi.yaml b/plugins/catalog-backend/openapi.yaml
index 72e04d0277..a52cc9235f 100644
--- a/plugins/catalog-backend/openapi.yaml
+++ b/plugins/catalog-backend/openapi.yaml
@@ -47,6 +47,15 @@ components:
       required: false
       schema:
         type: string
+        minLength: 1
+    after:
+      name: after
+      in: query
+      description: Pointer to the previous page of results.
+      required: false
+      schema:
+        type: string
+        minLength: 1
     fields:
       name: fields
       in: query
@@ -54,6 +63,21 @@ components:
       required: false
       schema:
         type: string
+    filter:
+      name: filter
+      in: query
+      description: Filter for just the entities defined by this filter.
+      required: false
+      schema:
+        type: string
+    offset:
+      name: offset
+      in: query
+      description: Number of records to skip in the query page.
+      required: false
+      schema:
+        type: integer
+        minimum: 1
     limit:
       name: limit
       in: query
@@ -74,7 +98,6 @@ components:
           items:
             type: string
           description: A two-item tuple of [field, order].
-
       explode: true
       style: form
   requestBodies: {}
@@ -620,31 +643,11 @@ paths:
         - {}
         - JWT: []
       parameters:
-        - in: query
-          name: filter
-          required: false
-          schema:
-            type: string
-        - in: query
-          name: fields
-          required: false
-          schema:
-            type: string
-        - in: query
-          name: offset
-          required: false
-          schema:
-            type: string
-        - in: query
-          name: limit
-          required: false
-          schema:
-            type: string
-        - in: query
-          name: after
-          required: false
-          schema:
-            type: string
+        - $ref: '#/components/parameters/fields'
+        - $ref: '#/components/parameters/limit'
+        - $ref: '#/components/parameters/filter'
+        - $ref: '#/components/parameters/offset'
+        - $ref: '#/components/parameters/after'
   /entities/by-uid/{uid}:
     get:
       operationId: GetEntityByUid
@@ -669,11 +672,7 @@ paths:
         - {}
         - JWT: []
       parameters:
-        - in: path
-          name: uid
-          required: true
-          schema:
-            type: string
+        - $ref: '#/components/parameters/uid'
   /entities/by-name/{kind}/{namespace}/{name}:
     get:
       operationId: GetEntityByName
@@ -722,11 +721,7 @@ paths:
         - {}
         - JWT: []
       parameters:
-        - in: query
-          name: fields
-          required: false
-          schema:
-            type: string
+        - $ref: '#/components/parameters/fields'
       requestBody:
         required: true
         content:
@@ -797,11 +792,7 @@ paths:
           required: true
           schema:
             type: string
-        - in: query
-          name: filter
-          required: false
-          schema:
-            type: string
+        - $ref: '#/components/parameters/filter'
   /locations:
     post:
       operationId: CreateLocation
diff --git a/plugins/catalog-backend/schema/openapi.ts b/plugins/catalog-backend/schema/openapi.ts
index 504b67c6de..b0078644f2 100644
--- a/plugins/catalog-backend/schema/openapi.ts
+++ b/plugins/catalog-backend/schema/openapi.ts
@@ -736,6 +736,12 @@ export default {
           },
         ],
         parameters: [
+          {
+            $ref: '#/components/parameters/fields',
+          },
+          {
+            $ref: '#/components/parameters/limit',
+          },
           {
             in: 'query',
             name: 'filter',
@@ -744,14 +750,6 @@ export default {
               type: 'string',
             },
           },
-          {
-            in: 'query',
-            name: 'fields',
-            required: false,
-            schema: {
-              type: 'string',
-            },
-          },
           {
             in: 'query',
             name: 'offset',
@@ -760,14 +758,6 @@ export default {
               type: 'string',
             },
           },
-          {
-            in: 'query',
-            name: 'limit',
-            required: false,
-            schema: {
-              type: 'string',
-            },
-          },
           {
             in: 'query',
             name: 'after',
diff --git a/yarn.lock b/yarn.lock
index d40dfd3ea3..61e2f01c05 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -40807,7 +40807,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"yaml@npm:^2.0.0, yaml@npm:^2.1.1, yaml@npm:^2.1.3, yaml@npm:^2.2.1":
+"yaml@npm:^2.0.0, yaml@npm:^2.1.1, yaml@npm:^2.2.1":
   version: 2.2.1
   resolution: "yaml@npm:2.2.1"
   checksum: 84f68cbe462d5da4e7ded4a8bded949ffa912bc264472e5a684c3d45b22d8f73a3019963a32164023bdf3d83cfb6f5b58ff7b2b10ef5b717c630f40bd6369a23