[qoc] group and indicatorset parameter no longer mandatory where sane defaults exist

EH/population-statistics-authorisation
Reinier Zwitserloot 2 years ago
parent 97f56e0545
commit a57f7f4c4e
No known key found for this signature in database
GPG Key ID: DADEDCAA42950296

@ -13,13 +13,14 @@ get:
- name: indicatorKey - name: indicatorKey
in: path in: path
description: The key as listed in the indicatorset. description: The key as listed in the indicatorset.
required: true
schema: schema:
type: string type: string
example: ZOO-dm2-hb-3 example: ZOO-dm2-hb-3
- name: group - name: group
in: path in: query
description: The key as listed in the `list-groups` endpoint. description: The key as listed in the `list-groups` endpoint. Defaults to the only allowed group if the authentication party only has one; otherwise required.
required: true required: false
schema: schema:
type: string type: string
example: hwf example: hwf

@ -3,20 +3,20 @@ get:
- Quality of Care - Quality of Care
summary: Show each participating GP practice as well as the status of their data for a given indicator report and a given group. summary: Show each participating GP practice as well as the status of their data for a given indicator report and a given group.
parameters: parameters:
- name: group
in: path
description: The key as listed in the `list-groups` endpoint.
required: true
schema:
type: string
example: hwf
- name: setKey - name: setKey
in: path in: query
description: The key as listed in the `CareProgram` schema. description: The key as listed in the `CareProgram` schema. If omitted, information about participating in a specific care program will not be provided.
required: true required: false
schema: schema:
type: string type: string
example: ZEL-dm example: ZEL-dm
- name: group
in: query
description: The key as listed in the `list-groups` endpoint. Defaults to the only allowed group if the authentication party only has one; otherwise required.
required: false
schema:
type: string
example: hwf
- name: refDate - name: refDate
in: query in: query
description: |- description: |-
@ -36,7 +36,7 @@ get:
type: object type: object
properties: properties:
group: group:
description: Repeats the `group` parameter. description: The chosen group (repeats `group` parameter if present, otherwise, the group defaulted to for authenticating user).
type: string type: string
example: hwf example: hwf
calculatedAt: calculatedAt:
@ -51,11 +51,11 @@ get:
format: date format: date
example: 2023-04-01 example: 2023-04-01
key: key:
description: Repeats the `setKey` parameter. description: Repeats the `setKey` parameter, if present.
type: string type: string
example: ZOO-dm example: ZOO-dm
title: title:
description: The title of the requested indicator set. description: The title of the requested indicator set, if `setKey` was present.
type: string type: string
example: Diabetes Mellitus type 2 example: Diabetes Mellitus type 2
participants: participants:
@ -101,8 +101,6 @@ get:
required: required:
- group - group
- refDate - refDate
- key
- title
- participants - participants
'401': '401':
$ref: '../zoo-api.yaml/#/components/responses/NoAuth' $ref: '../zoo-api.yaml/#/components/responses/NoAuth'

@ -3,7 +3,7 @@ description: |-
type: object type: object
properties: properties:
group: group:
description: Repeats the `group` parameter. description: The chosen group (repeats `group` parameter if present, otherwise, the group defaulted to for authenticating user).
type: string type: string
example: hwf example: hwf
key: key:

@ -52,12 +52,12 @@ paths:
$ref: 'paths/qoc_indicatorset_{setKey}.yaml' $ref: 'paths/qoc_indicatorset_{setKey}.yaml'
/qoc/indicator/{setKey}/{indicatorKey}/patients: /qoc/indicator/{setKey}/{indicatorKey}/patients:
$ref: 'paths/qoc_indicator_{setKey}_{indicatorKey}_patients.yaml' $ref: 'paths/qoc_indicator_{setKey}_{indicatorKey}_patients.yaml'
/qoc/indicator/{setKey}/{indicatorKey}/practices/{group}: /qoc/indicator/{setKey}/{indicatorKey}/practices:
$ref: 'paths/qoc_indicator_{setKey}_{indicatorKey}_practices_{group}.yaml' $ref: 'paths/qoc_indicator_{setKey}_{indicatorKey}_practices.yaml'
/qoc/list-groups: /qoc/list-groups:
$ref: 'paths/qoc_list-groups.yaml' $ref: 'paths/qoc_list-groups.yaml'
/qoc/participating-practices/{group}/{setKey}: /qoc/participating-practices:
$ref: 'paths/qoc_participating-practices_{group}_{setKey}.yaml' $ref: 'paths/qoc_participating-practices.yaml'
components: components:
parameters: parameters:
Authorization: Authorization:

Loading…
Cancel
Save