From 22f0397ff8ae48df61089da598af7914219814df Mon Sep 17 00:00:00 2001 From: tomcdonnell Date: Tue, 25 Feb 2025 18:38:29 +1100 Subject: [PATCH 1/5] Show two options for items in folder array [SA-18729] --- openapi/paths/assessment.yaml | 41 ++++++++++++++++++++--------------- 1 file changed, 24 insertions(+), 17 deletions(-) diff --git a/openapi/paths/assessment.yaml b/openapi/paths/assessment.yaml index 1f30b0c4..0168f4b3 100644 --- a/openapi/paths/assessment.yaml +++ b/openapi/paths/assessment.yaml @@ -52,29 +52,36 @@ parameters: example: dueWork folder: oneOf: - - type: array - description: Array for folders to filter assessments on. - items: - type: object + - type: array + description: Array for folders to filter assessments on. + items: + oneOf: + - type: object + properties: + id: + description: ID of the folder containing the assessment. + type: integer + example: 80 + required: + - id + - type: object + properties: + code: + description: Code of the folder containing the assessment. + type: string + example: 9ENGA + required: + - code + - type: object description: | - Select either one of the following fields to filter on: + Select a folder ID to filter on: properties: id: type: integer description: ID of the folder containing the assessment. example: 80 - code: - type: string - description: Code of the folder containing the assessment. - example: 9ENGA - - type: object - description: | - Select a folder ID to filter on: - properties: - id: - type: integer - description: ID of the folder containing the assessment. - example: 80 + required: + - id subjectCode: type: array items: From 21ca77452d2a00002195b6f1f812b91b0e48ed76 Mon Sep 17 00:00:00 2001 From: tomcdonnell Date: Tue, 25 Feb 2025 18:38:57 +1100 Subject: [PATCH 2/5] Deprecate the non-array folder option [SA-18729] --- openapi/paths/assessment.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/openapi/paths/assessment.yaml b/openapi/paths/assessment.yaml index 0168f4b3..94afe915 100644 --- a/openapi/paths/assessment.yaml +++ b/openapi/paths/assessment.yaml @@ -73,6 +73,7 @@ parameters: required: - code - type: object + deprecated: true description: | Select a folder ID to filter on: properties: From 34ad0908e0bdd79aaa2d60b05eb2e96dab460227 Mon Sep 17 00:00:00 2001 From: tomcdonnell Date: Tue, 25 Feb 2025 19:01:27 +1100 Subject: [PATCH 3/5] Replace deprecated option description with (Deprecated) [SA-18729] --- openapi/paths/assessment.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi/paths/assessment.yaml b/openapi/paths/assessment.yaml index 94afe915..2f37b403 100644 --- a/openapi/paths/assessment.yaml +++ b/openapi/paths/assessment.yaml @@ -75,7 +75,7 @@ parameters: - type: object deprecated: true description: | - Select a folder ID to filter on: + (Deprecated) properties: id: type: integer From d0356c60f7ab0758f91dd1c281c3c385edc13079 Mon Sep 17 00:00:00 2001 From: tomcdonnell Date: Tue, 25 Feb 2025 19:41:34 +1100 Subject: [PATCH 4/5] Fix JSON object filter example [SA-18729] --- openapi/paths/assessment.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openapi/paths/assessment.yaml b/openapi/paths/assessment.yaml index 2f37b403..cac5b82a 100644 --- a/openapi/paths/assessment.yaml +++ b/openapi/paths/assessment.yaml @@ -21,12 +21,12 @@ parameters: in: query required: true description: | - Json encoded object of fields and values to filter assessments on. \ + JSON encoded object of fields and values to filter assessments on. \ For example, to get assessment with ID 676: \ `filter=%7b%22assessmentId%22%3a676%7d` Filter string to filter on all the fields would look like: \ - `{"assessmentId": 256,"title": "English 3/4 [Final]","assessmentType": "dueWork","folder": {id: 80},"weighted": false,"workType": {"id": 1,"name": "Formative Assessment"},"dueDate": {"from": "2017-10-12T14:20:50+10:00","to": "2019-10-12T14:20:50+10:00"},"yearLevel": {"id": 6,"name": "Year 6"}}` + `{"assessmentId": 256,"title": "English 3/4 [Final]","assessmentType": "dueWork","folder": [{id: 80}],"weighted": false,"workType": {"id": 1,"name": "Formative Assessment"},"dueDate": {"from": "2017-10-12T14:20:50+10:00","to": "2019-10-12T14:20:50+10:00"},"yearLevel": {"id": 6,"name": "Year 6"}}` schema: type: object properties: From a5eadc6639b81dd27b40e09095e556c9680782d3 Mon Sep 17 00:00:00 2001 From: tomcdonnell Date: Wed, 26 Feb 2025 12:02:50 +1100 Subject: [PATCH 5/5] Add description of folder array [SA-18729] --- openapi/paths/assessment.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openapi/paths/assessment.yaml b/openapi/paths/assessment.yaml index cac5b82a..54b170fa 100644 --- a/openapi/paths/assessment.yaml +++ b/openapi/paths/assessment.yaml @@ -53,7 +53,8 @@ parameters: folder: oneOf: - type: array - description: Array for folders to filter assessments on. + description: | + An array of objects, each of which specifies either an "id" or a "code". items: oneOf: - type: object