From b2b35ad795301b8b67dd7f7c4032578e9f742b4e Mon Sep 17 00:00:00 2001 From: Yoofi Quansah Date: Mon, 4 Apr 2022 12:20:59 -0700 Subject: [PATCH 1/2] feat: add query parameters to tasks contract that fulfill the pagination, filtering, and sorting epic --- contracts/cloud-diff.yml | 14 ++++++++++++++ contracts/cloud.json | 21 +++++++++++++++++++++ contracts/cloud.yml | 14 ++++++++++++++ contracts/ref/cloud.yml | 14 ++++++++++++++ src/cloud/paths/tasks.yml | 14 ++++++++++++++ 5 files changed, 77 insertions(+) diff --git a/contracts/cloud-diff.yml b/contracts/cloud-diff.yml index 0d7df8cc3..d9c2b0501 100644 --- a/contracts/cloud-diff.yml +++ b/contracts/cloud-diff.yml @@ -2764,6 +2764,20 @@ paths: maximum: 500 default: 100 description: The non-zero number of tasks to return + - in: query + name: offset + schema: + type: integer + minimum: 0 + default: 0 + description: The number of records to skip + - in: query + name: sortBy + description: Field that records should be sorted by + schema: + type: string + enum: + - name - in: query name: type description: 'Type of task, unset by default.' diff --git a/contracts/cloud.json b/contracts/cloud.json index 7debde2bb..ea7a3cbc5 100644 --- a/contracts/cloud.json +++ b/contracts/cloud.json @@ -9726,6 +9726,27 @@ }, "description": "The non-zero number of tasks to return" }, + { + "in": "query", + "name": "offset", + "schema": { + "type": "integer", + "minimum": 0, + "default": 0 + }, + "description": "The number of records to skip" + }, + { + "in": "query", + "name": "sortBy", + "description": "Field that records should be sorted by", + "schema": { + "type": "string", + "enum": [ + "name" + ] + } + }, { "in": "query", "name": "type", diff --git a/contracts/cloud.yml b/contracts/cloud.yml index 58cb459f8..ddd6b7cc2 100644 --- a/contracts/cloud.yml +++ b/contracts/cloud.yml @@ -6115,6 +6115,20 @@ paths: maximum: 500 default: 100 description: The non-zero number of tasks to return + - in: query + name: offset + schema: + type: integer + minimum: 0 + default: 0 + description: The number of records to skip + - in: query + name: sortBy + description: Field that records should be sorted by + schema: + type: string + enum: + - name - in: query name: type description: 'Type of task, unset by default.' diff --git a/contracts/ref/cloud.yml b/contracts/ref/cloud.yml index 2f6b7ef14..0940b4740 100644 --- a/contracts/ref/cloud.yml +++ b/contracts/ref/cloud.yml @@ -10268,6 +10268,20 @@ paths: maximum: 500 minimum: -1 type: integer + - description: The number of records to skip + in: query + name: offset + schema: + default: 0 + minimum: 0 + type: integer + - description: Field that records should be sorted by + in: query + name: sortBy + schema: + enum: + - name + type: string - description: Type of task, unset by default. in: query name: type diff --git a/src/cloud/paths/tasks.yml b/src/cloud/paths/tasks.yml index fd3f05913..fba64d1d0 100644 --- a/src/cloud/paths/tasks.yml +++ b/src/cloud/paths/tasks.yml @@ -46,6 +46,20 @@ get: maximum: 500 default: 100 description: The non-zero number of tasks to return + - in: query + name: offset + schema: + type: integer + minimum: 0 + default: 0 + description: The number of records to skip + - in: query + name: sortBy + description: Field that records should be sorted by + schema: + type: string + enum: + - name - in: query name: type description: Type of task, unset by default. From 5abd9866c4eb00d11ed99bb990e3f5a5a706772c Mon Sep 17 00:00:00 2001 From: Yoofi Quansah Date: Mon, 4 Apr 2022 12:59:02 -0700 Subject: [PATCH 2/2] chore: mark the added parameters as not required --- contracts/cloud-diff.yml | 2 ++ contracts/cloud.json | 2 ++ contracts/cloud.yml | 2 ++ contracts/ref/cloud.yml | 2 ++ src/cloud/paths/tasks.yml | 2 ++ 5 files changed, 10 insertions(+) diff --git a/contracts/cloud-diff.yml b/contracts/cloud-diff.yml index d9c2b0501..0dd0ef8d2 100644 --- a/contracts/cloud-diff.yml +++ b/contracts/cloud-diff.yml @@ -2766,6 +2766,7 @@ paths: description: The non-zero number of tasks to return - in: query name: offset + required: false schema: type: integer minimum: 0 @@ -2774,6 +2775,7 @@ paths: - in: query name: sortBy description: Field that records should be sorted by + required: false schema: type: string enum: diff --git a/contracts/cloud.json b/contracts/cloud.json index ea7a3cbc5..1b5476163 100644 --- a/contracts/cloud.json +++ b/contracts/cloud.json @@ -9729,6 +9729,7 @@ { "in": "query", "name": "offset", + "required": false, "schema": { "type": "integer", "minimum": 0, @@ -9740,6 +9741,7 @@ "in": "query", "name": "sortBy", "description": "Field that records should be sorted by", + "required": false, "schema": { "type": "string", "enum": [ diff --git a/contracts/cloud.yml b/contracts/cloud.yml index ddd6b7cc2..856468445 100644 --- a/contracts/cloud.yml +++ b/contracts/cloud.yml @@ -6117,6 +6117,7 @@ paths: description: The non-zero number of tasks to return - in: query name: offset + required: false schema: type: integer minimum: 0 @@ -6125,6 +6126,7 @@ paths: - in: query name: sortBy description: Field that records should be sorted by + required: false schema: type: string enum: diff --git a/contracts/ref/cloud.yml b/contracts/ref/cloud.yml index 0940b4740..4b1e0ae7e 100644 --- a/contracts/ref/cloud.yml +++ b/contracts/ref/cloud.yml @@ -10271,6 +10271,7 @@ paths: - description: The number of records to skip in: query name: offset + required: false schema: default: 0 minimum: 0 @@ -10278,6 +10279,7 @@ paths: - description: Field that records should be sorted by in: query name: sortBy + required: false schema: enum: - name diff --git a/src/cloud/paths/tasks.yml b/src/cloud/paths/tasks.yml index fba64d1d0..005355985 100644 --- a/src/cloud/paths/tasks.yml +++ b/src/cloud/paths/tasks.yml @@ -48,6 +48,7 @@ get: description: The non-zero number of tasks to return - in: query name: offset + required: false schema: type: integer minimum: 0 @@ -56,6 +57,7 @@ get: - in: query name: sortBy description: Field that records should be sorted by + required: false schema: type: string enum: