Automated commit 'Merge pull request #33 from sailpoint/NERRA-1445

NERRA-1445: document after_id usage for Profiles GET' by github action: 10352271020

nerm/parameters/_index.yaml

@@ -8,6 +8,8 @@ limit:
   $ref: './query/limit.yaml'
 offset:
   $ref: './query/offset.yaml'
+after_id:
+  $ref: './query/after_id.yaml'
 user_id:
   $ref: './query/user_id.yaml'
 manager_id:
@@ -57,4 +59,4 @@ workflow_session_id:
 result:
   $ref: './query/result.yaml'
 metadata:
-  $ref: './query/metadata.yaml'
+  $ref: './query/metadata.yaml'

nerm/parameters/query/after_id.yaml

@@ -0,0 +1,8 @@
+name: after_id
+in: metadata
+description: Represents the ID where the query should begin from. If blank, it represents the first ID. When used, forces sorting by ID ascending and does not allow use of `offset`.
+required: false
+schema:
+  type: string
+  format: uuid
+  example: 4eaa719f-4312-4c5b-9264-d0eb04d4a02a

nerm/paths/profiles.yaml

@@ -11,6 +11,7 @@ get:
     - $ref: "../parameters/query/profile_type_id.yaml"
     - $ref: "../parameters/query/status.yaml"
     - $ref: "../parameters/query/metadata.yaml"
+    - $ref: "../parameters/query/after_id.yaml"
   responses:
     '200':
       $ref: "../responses/Profiles_Meta.yaml"
@@ -62,4 +63,4 @@ delete:
     '400':
       $ref: "../responses/400.yaml"
     '500':
-      $ref: "../responses/500.yaml"
+      $ref: "../responses/500.yaml"

nerm/responses/Profiles_Meta.yaml

@@ -9,4 +9,4 @@ content:
           items:
             $ref: '../schemas/GET/Profile.yaml'
         _metadata:
-          $ref: '../schemas/Metadata.yaml'
+          $ref: '../schemas/Metadata-withAfterId.yaml'

nerm/schemas/MetaData-withAfterId.yaml

@@ -0,0 +1,18 @@
+type: object
+properties:
+  limit:
+    type: integer
+  offset:
+    type: integer
+  total:
+    type: integer
+  next:
+    type: string
+    example: /endpoint?limit=10&offset=60
+  previous:
+    type: string
+    example: /endpoint?limit=10&offset=40
+  after_id:
+    type: string
+    format: uuid
+    example: 4eaa719f-4312-4c5b-9264-d0eb04d4a02a

nerm/schemas/Metadata.yaml

@@ -11,4 +11,4 @@ properties:
     example: /endpoint?limit=10&offset=60
   previous:
     type: string
-    example: /endpoint?limit=10&offset=40
+    example: /endpoint?limit=10&offset=40