Skip to content

Commit

Permalink
Automated commit by github action: 10688269014
Browse files Browse the repository at this point in the history
  • Loading branch information
developer-relations-sp committed Sep 3, 2024
1 parent f5ebbbd commit abefa89
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 2 deletions.
4 changes: 3 additions & 1 deletion static/api-specs/nerm/parameters/_index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,6 @@ workflow_session_id:
result:
$ref: './query/result.yaml'
metadata:
$ref: './query/metadata.yaml'
$ref: './query/metadata.yaml'
after_id:
$ref: './query/after_id.yaml'
8 changes: 8 additions & 0 deletions static/api-specs/nerm/parameters/query/after_id.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
name: after_id
in: query
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`. When after_id is specified it changes the mode of the API such that any filter parameters other than profile_type_id, limit, and offset are not supported and will be either silently ignored or result in an HTTP 400 error. For example you can not include and after_id along with an archived=false in the same request.
required: false
schema:
type: string
format: uuid
example: 4eaa719f-4312-4c5b-9264-d0eb04d4a02a
1 change: 1 addition & 0 deletions static/api-specs/nerm/paths/profiles.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion static/api-specs/nerm/responses/Profiles_Meta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ content:
items:
$ref: '../schemas/GET/Profile.yaml'
_metadata:
$ref: '../schemas/Metadata.yaml'
$ref: '../schemas/MetadataWithAfterId.yaml'
30 changes: 30 additions & 0 deletions static/api-specs/nerm/schemas/MetadataWithAfterId.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
type: object
properties:
limit:
type: integer
description: The maximum number of records to return in the search
example: /endpoint?limit=10
format: int32
offset:
type: integer
description: The number of records to skip before starting to return results.
example: /endpoint?offset=60
format: int32
total:
type: integer
description: The total number of records available matching the search criteria.
example: /endpoint?total=10
format: int32
next:
type: string
description: The ID of the first record in the next set of results
example: /endpoint?limit=10&offset=60
previous:
type: string
description: The ID of the last record in the previous set of results
example: /endpoint?limit=10&offset=40
after_id:
type: string
format: uuid
example: 4eaa719f-4312-4c5b-9264-d0eb04d4a02a
description: The ID from which the search will start, ignoring all records before it.

0 comments on commit abefa89

Please sign in to comment.