diff --git a/openapi/v2023.11.1/bundled.yaml b/openapi/v2023.11.1/bundled.yaml index f147c69..6c38057 100644 --- a/openapi/v2023.11.1/bundled.yaml +++ b/openapi/v2023.11.1/bundled.yaml @@ -2230,7 +2230,10 @@ paths: type: object properties: apiKeys: - $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/delete/responses/200/content/application~1json/schema' + items: + allOf: + - $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/delete/responses/200/content/application~1json/schema/allOf/0' + - $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/delete/responses/200/content/application~1json/schema/allOf/1' pagination: $ref: '#/components/schemas/Pagination' description: '' @@ -2256,7 +2259,7 @@ paths: schema: properties: apiKey: - $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/delete/responses/200/content/application~1json/schema' + $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/delete/responses/200/content/application~1json/schema/allOf/0' description: An object of type ApiKey required: - apiKey @@ -2266,10 +2269,14 @@ paths: content: application/json: schema: - type: object properties: apiKey: - $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/delete/responses/200/content/application~1json/schema' + allOf: + - $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/delete/responses/200/content/application~1json/schema/allOf/0' + - $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/delete/responses/200/content/application~1json/schema/allOf/1' + required: + - apiKey + type: object description: 'A set consisting of the new ApiKey object created, together with the initial Revision object.' '400': description: bad input parameter @@ -2299,7 +2306,7 @@ paths: schema: properties: apiKey: - $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/delete/responses/200/content/application~1json/schema' + $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/delete/responses/200/content/application~1json/schema/allOf/0' description: An object of type ApiKey required: - apiKey @@ -2309,10 +2316,11 @@ paths: content: application/json: schema: - type: object properties: apiKey: - $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/delete/responses/200/content/application~1json/schema' + allOf: + - $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/delete/responses/200/content/application~1json/schema/allOf/0' + - $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/delete/responses/200/content/application~1json/schema/allOf/1' description: '' '400': description: bad input parameter @@ -2335,38 +2343,51 @@ paths: content: application/json: schema: - type: object - title: ApiKey - description: Api key - x-not-in-database: false - required: - - scopes - properties: - id: - type: string - format: '' - example: '' - description: API key Id - scopes: - type: array - items: - type: string - enum: - - config - - audit - - service - - onboard - description: Scopes for API key - apiKey: - type: string - format: '' - example: '' - description: API key - expiryInDays: - type: integer - format: '' - default: 30 - description: 'Expiry in days. If expiry is 0, then default to 30 days' + allOf: + - type: object + title: ApiKey + description: Api key + x-not-in-database: false + required: + - scopes + properties: + id: + type: string + format: '' + example: '' + description: API key Id + name: + type: string + format: '' + example: '' + description: API key name + scopes: + type: array + items: + type: string + enum: + - config + - audit + - service + - onboard + description: Scopes for API key + apiKey: + type: string + format: '' + example: '' + description: API key + expiryInDays: + type: integer + format: '' + default: 30 + description: 'Expiry in days. If expiry is 0, then default to 30 days' + - type: object + title: ApiKeyExtras + properties: + expiryTimestamp: + type: string + timestamp: + type: string description: '' '400': description: bad input parameter @@ -2689,6 +2710,28 @@ paths: token: $ref: '#/paths/~1onboard~1admin~1login/post/responses/200/content/application~1json/schema' deprecated: false + /onboard/logout: + post: + tags: + - onboard + description: Logout + operationId: logout + parameters: [] + requestBody: + content: + application/json: + schema: + required: + - refreshToken + type: object + properties: + refreshToken: + type: string + required: true + responses: + '200': + description: OK + deprecated: false /onboard/organisation: get: deprecated: false @@ -3583,24 +3626,6 @@ paths: x-specification-pii-or-sensitive: 'True' x-specification-scenario: '1.2' x-specification-usecase: UC-C-PIC-I-002 - delete: - description: 'DELETE - Cascading delete operation for Right To Be Forgotten, deletes all data agreement records that shall not be retained and have a "forgettable" DataAgreement. May also delete an unsigned data agreement record, for instance in cases where the user exits the signing process.' - operationId: serviceDeleteAllRecords - parameters: [] - responses: - '200': - description: '' - '400': - description: bad input parameter - security: - - BearerAuth: [] - summary: DELETE - Delete all consent records for an individual - tags: - - service - x-specification-crudl-model: '' - x-specification-pii-or-sensitive: 'True' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-I-003 get: description: LIST - Fetch all current unambiguous data agreement records stored for individual operationId: serviceListIndividualConsentRecordList @@ -3632,6 +3657,25 @@ paths: x-specification-pii-or-sensitive: 'True' x-specification-scenario: '' x-specification-usecase: UC-C-PIC-I-001 + /service/individual/record: + delete: + description: 'DELETE - Cascading delete operation for Right To Be Forgotten, deletes all data agreement records that shall not be retained and have a "forgettable" DataAgreement. May also delete an unsigned data agreement record, for instance in cases where the user exits the signing process.' + operationId: serviceDeleteAllRecords + parameters: [] + responses: + '200': + description: '' + '400': + description: bad input parameter + security: + - BearerAuth: [] + summary: DELETE - Delete all consent records for an individual + tags: + - service + x-specification-crudl-model: '' + x-specification-pii-or-sensitive: 'True' + x-specification-scenario: '' + x-specification-usecase: UC-C-PIC-I-003 '/service/individual/record/consent-record/{consentRecordId}': put: description: UPDATE* - Update a data agreement record. Note that updating a signed data agreement record invalidates its signature. @@ -4115,6 +4159,9 @@ paths: dataAgreement: type: object properties: + version: + type: string + description: Version of data agreement purpose: type: string description: Name of purpose diff --git a/openapi/v2023.11.1/definitions/ApiKey.yaml b/openapi/v2023.11.1/definitions/ApiKey.yaml index e6ffe77..2525ab8 100644 --- a/openapi/v2023.11.1/definitions/ApiKey.yaml +++ b/openapi/v2023.11.1/definitions/ApiKey.yaml @@ -11,6 +11,11 @@ properties: format: "" example: "" description: "API key Id" + name: + type: string + format: "" + example: "" + description: "API key name" scopes: type: array diff --git a/openapi/v2023.11.1/definitions/ApiKeyExtras.yaml b/openapi/v2023.11.1/definitions/ApiKeyExtras.yaml new file mode 100644 index 0000000..79de639 --- /dev/null +++ b/openapi/v2023.11.1/definitions/ApiKeyExtras.yaml @@ -0,0 +1,7 @@ +type: object +title: ApiKeyExtras +properties: + expiryTimestamp: + type: string + timestamp: + type: string \ No newline at end of file diff --git a/openapi/v2023.11.1/definitions/ListDataAgreementRecordExtras.yaml b/openapi/v2023.11.1/definitions/ListDataAgreementRecordExtras.yaml index 30ec42a..d4e36e3 100644 --- a/openapi/v2023.11.1/definitions/ListDataAgreementRecordExtras.yaml +++ b/openapi/v2023.11.1/definitions/ListDataAgreementRecordExtras.yaml @@ -5,6 +5,9 @@ properties: dataAgreement: type: object properties: + version: + type: string + description: Version of data agreement purpose: type: string description: Name of purpose diff --git a/openapi/v2023.11.1/index.yaml b/openapi/v2023.11.1/index.yaml index dc55e5f..35af602 100644 --- a/openapi/v2023.11.1/index.yaml +++ b/openapi/v2023.11.1/index.yaml @@ -200,6 +200,9 @@ paths: /onboard/individual/login: post: $ref: ./paths/loginIndividual.yaml + /onboard/logout: + post: + $ref: ./paths/logout.yaml /onboard/organisation: get: $ref: ./paths/getOrganisation.yaml @@ -285,10 +288,11 @@ paths: /service/individual/record/consent-record: post: $ref: ./paths/serviceCreateIndividualConsentRecordAndSignature.yaml - delete: - $ref: ./paths/serviceDeleteAllRecords.yaml get: $ref: ./paths/serviceListIndividualConsentRecordList.yaml + /service/individual/record: + delete: + $ref: ./paths/serviceDeleteAllRecords.yaml /service/individual/record/consent-record/{consentRecordId}: put: diff --git a/openapi/v2023.11.1/paths/configCreateApikey.yaml b/openapi/v2023.11.1/paths/configCreateApikey.yaml index 8b12bd9..8fd30c1 100644 --- a/openapi/v2023.11.1/paths/configCreateApikey.yaml +++ b/openapi/v2023.11.1/paths/configCreateApikey.yaml @@ -17,10 +17,14 @@ responses: content: application/json: schema: - type: object properties: apiKey: - $ref: ../definitions/ApiKey.yaml + allOf: + - $ref: ../definitions/ApiKey.yaml + - $ref: "../definitions/ApiKeyExtras.yaml" + required: + - apiKey + type: object description: A set consisting of the new ApiKey object created, together with the initial Revision object. '400': diff --git a/openapi/v2023.11.1/paths/configDeleteApiKey.yaml b/openapi/v2023.11.1/paths/configDeleteApiKey.yaml index c2bed8f..6d5faff 100644 --- a/openapi/v2023.11.1/paths/configDeleteApiKey.yaml +++ b/openapi/v2023.11.1/paths/configDeleteApiKey.yaml @@ -8,7 +8,9 @@ responses: content: application/json: schema: - $ref: ../definitions/ApiKey.yaml + allOf: + - $ref: ../definitions/ApiKey.yaml + - $ref: "../definitions/ApiKeyExtras.yaml" description: "" "400": description: bad input parameter diff --git a/openapi/v2023.11.1/paths/configListApiKey.yaml b/openapi/v2023.11.1/paths/configListApiKey.yaml index f8524bc..dbf357a 100644 --- a/openapi/v2023.11.1/paths/configListApiKey.yaml +++ b/openapi/v2023.11.1/paths/configListApiKey.yaml @@ -11,7 +11,10 @@ responses: type: object properties: apiKeys: - $ref: ../definitions/ApiKey.yaml + items: + allOf: + - $ref: ../definitions/ApiKey.yaml + - $ref: "../definitions/ApiKeyExtras.yaml" pagination: $ref: "../definitions/Pagination.yaml" description: "" diff --git a/openapi/v2023.11.1/paths/configUpdateApiKey.yaml b/openapi/v2023.11.1/paths/configUpdateApiKey.yaml index 87f3507..81e72cf 100644 --- a/openapi/v2023.11.1/paths/configUpdateApiKey.yaml +++ b/openapi/v2023.11.1/paths/configUpdateApiKey.yaml @@ -18,10 +18,11 @@ responses: content: application/json: schema: - type: object properties: apiKey: - $ref: ../definitions/ApiKey.yaml + allOf: + - $ref: ../definitions/ApiKey.yaml + - $ref: "../definitions/ApiKeyExtras.yaml" description: "" "400": description: bad input parameter diff --git a/openapi/v2023.11.1/paths/logout.yaml b/openapi/v2023.11.1/paths/logout.yaml new file mode 100644 index 0000000..fd02c60 --- /dev/null +++ b/openapi/v2023.11.1/paths/logout.yaml @@ -0,0 +1,20 @@ +tags: + - onboard +description: Logout +operationId: logout +parameters: [] +requestBody: + content: + application/json: + schema: + required: + - refreshToken + type: object + properties: + refreshToken: + type: string + required: true +responses: + "200": + description: OK +deprecated: false