From 02cd52e07054eb9f750275d011b9974477aa7448 Mon Sep 17 00:00:00 2001 From: George J Padayatti Date: Tue, 21 Nov 2023 21:31:53 +0530 Subject: [PATCH] Upd: Summary and styling Signed-off-by: George J Padayatti --- openapi/v2023.11.1/bundled.yaml | 230 +++++++----------- openapi/v2023.11.1/index.html | 41 +++- openapi/v2023.11.1/index.yaml | 2 +- openapi/v2023.11.1/paths/configUpdateIdp.yaml | 2 +- .../paths/serviceAgreementList.yaml | 7 +- .../paths/serviceAgreementRead.yaml | 7 +- .../paths/serviceCreateIndividual.yaml | 42 ++-- .../serviceCreateIndividualConsentRecord.yaml | 2 +- ...teIndividualConsentRecordAndSignature.yaml | 2 +- ...iceCreateIndividualConsentRecordDraft.yaml | 4 +- ...reateIndividualConsentRecordSignature.yaml | 2 +- .../paths/serviceDeleteAllRecords.yaml | 2 +- ...serviceListDataAgreementRecordHistory.yaml | 4 +- ...iceListDataAttributesForDataAgreement.yaml | 9 +- ...tIndividualAgreementConsentRecordList.yaml | 4 +- ...erviceListIndividualConsentRecordList.yaml | 4 +- .../paths/serviceListIndividuals.yaml | 15 +- .../v2023.11.1/paths/servicePolicyRead.yaml | 3 +- .../paths/serviceReadDataSharingUi.yaml | 4 +- openapi/v2023.11.1/paths/serviceReadIdp.yaml | 9 +- .../paths/serviceReadIndividual.yaml | 14 +- .../serviceReadIndividualRecordRead.yaml | 2 +- .../paths/serviceReadOrganisation.yaml | 7 +- .../serviceReadOrganisationCoverImage.yaml | 5 +- .../paths/serviceReadOrganisationImage.yaml | 13 +- .../serviceReadOrganisationLogoImage.yaml | 7 +- .../paths/serviceUpdateIndividual.yaml | 21 +- .../serviceUpdateIndividualConsentRecord.yaml | 4 +- ...pdateIndividualConsentRecordSignature.yaml | 13 +- ...erificationAgreementConsentRecordRead.yaml | 5 +- .../serviceVerificationAgreementList.yaml | 5 +- .../serviceVerificationConsentRecordList.yaml | 5 +- 32 files changed, 210 insertions(+), 286 deletions(-) diff --git a/openapi/v2023.11.1/bundled.yaml b/openapi/v2023.11.1/bundled.yaml index dece0ab..9c81c28 100644 --- a/openapi/v2023.11.1/bundled.yaml +++ b/openapi/v2023.11.1/bundled.yaml @@ -2003,6 +2003,7 @@ paths: tags: - config put: + summary: UPDATE - Update IDP description: UPDATE - Update an IDP operationId: configUpdatePolicy parameters: @@ -2032,7 +2033,6 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: UPDATE - Update an IDP tags: - config x-specification-crudl-model: IDP @@ -2900,25 +2900,23 @@ paths: - onboard /service/organisation/coverimage: get: - deprecated: false + summary: READ - Read organization cover image description: Read organization cover image operationId: serviceReadOrganisationCoverImage - parameters: - - $ref: '#/paths/~1service~1individuals/get/parameters/2' responses: '200': headers: {} security: - BearerAuth: [] + deprecated: false tags: - service /service/organisation/logoimage: get: - deprecated: false - description: Read organization logo image + summary: READ - Read organisation logo image + description: Read organisation logo image operationId: serviceReadOrganisationLogoImage - parameters: - - $ref: '#/paths/~1service~1individuals/get/parameters/2' + deprecated: false responses: '200': headers: {} @@ -2928,7 +2926,8 @@ paths: - service /service/idp/open-id: get: - description: READ - Read an IDP + summary: READ - Read IdP + description: READ - Read IdP operationId: serviceReadIdp parameters: - description: Unique ID of an object @@ -2937,7 +2936,6 @@ paths: required: true schema: type: string - - $ref: '#/paths/~1service~1individuals/get/parameters/2' responses: '200': content: @@ -2969,20 +2967,14 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: READ - Read an IDP tags: - service - x-specification-crudl-model: IDP - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-003 /service/organisation: get: - deprecated: false - description: Read organization + description: READ - Read organisation + summary: Read organisation operationId: serviceReadOrganisation - parameters: - - $ref: '#/paths/~1service~1individuals/get/parameters/2' + deprecated: false responses: '200': content: @@ -3018,13 +3010,13 @@ paths: - service /service/data-agreements: get: + summary: LIST - List all active data agreements description: LIST - List active data agreements operationId: serviceAgreementList parameters: - $ref: '#/paths/~1config~1data-agreements/get/parameters/0' - $ref: '#/paths/~1config~1policies/get/parameters/1' - $ref: '#/paths/~1config~1policies/get/parameters/2' - - $ref: '#/paths/~1service~1individuals/get/parameters/2' responses: '200': content: @@ -3043,15 +3035,11 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: LIST - List active data agreements tags: - service - x-specification-crudl-model: DataAgreement - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-003 '/service/data-agreement/{dataAgreementId}': get: + summary: READ - Read data agreement description: READ - Read data agreement operationId: serviceAgreementRead parameters: @@ -3061,7 +3049,6 @@ paths: required: true schema: type: string - - $ref: '#/paths/~1service~1individuals/get/parameters/2' responses: '200': content: @@ -3080,23 +3067,18 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: READ - Read data agreement tags: - service - x-specification-crudl-model: DataAgreement - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-003 '/service/data-agreement/{dataAgreementId}/data-attributes': get: - description: READ - Fetch all latest versions of data attribute associated with an DataAgreement and the presented revisionId of that DataAgreement + summary: LIST - List all data attributes for data agreement + description: LIST - List all latest versions of data attribute associated with an DataAgreement and the presented revisionId of that DataAgreement operationId: serviceAgreementDataRead parameters: - $ref: '#/paths/~1audit~1data-agreement~1%7BdataAgreementId%7D/get/parameters/0' - $ref: '#/paths/~1config~1policies/get/parameters/1' - $ref: '#/paths/~1config~1policies/get/parameters/2' - $ref: '#/paths/~1config~1data-agreements/get/parameters/0' - - $ref: '#/paths/~1service~1individuals/get/parameters/2' responses: '200': content: @@ -3115,15 +3097,11 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: READ - Fetch all data attributes for data agreement tags: - service - x-specification-crudl-model: AgreementData - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-003 '/service/policy/{policyId}': get: + summary: READ - Read policy description: READ - Fetch the latest version of a Policy and the presented revisionId of an associated DataAgreement operationId: servicePolicyRead parameters: @@ -3134,7 +3112,6 @@ paths: schema: type: string - $ref: '#/paths/~1config~1data-agreements/get/parameters/0' - - $ref: '#/paths/~1service~1individuals/get/parameters/2' responses: '200': content: @@ -3151,7 +3128,6 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: READ - Read policy tags: - service x-specification-crudl-model: Policy @@ -3160,12 +3136,12 @@ paths: x-specification-usecase: UC-C-PIC-A-003 /service/verification/data-agreements: get: - description: LIST - Fetch all consent records + summary: LIST - List all consent records + description: LIST - List all consent records operationId: serviceVerificationAgreementList parameters: - $ref: '#/paths/~1config~1policies/get/parameters/1' - $ref: '#/paths/~1config~1policies/get/parameters/2' - - $ref: '#/paths/~1service~1individuals/get/parameters/2' responses: '200': content: @@ -3184,7 +3160,6 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: LIST - Fetch all consent records tags: - service x-specification-crudl-model: '' @@ -3193,11 +3168,11 @@ paths: x-specification-usecase: UC-C-PIC-A-003 '/service/verification/consent-record/{consentRecordId}': get: - description: READ - Fetch a consent record (latest revision). The individualId is supplied as HTTP header. + summary: READ - Read latest consent record + description: READ - Read latest consent record. operationId: serviceVerificationAgreementConsentRecordRead parameters: - $ref: '#/paths/~1audit~1consent-record~1%7BconsentRecordId%7D/get/parameters/0' - - $ref: '#/paths/~1service~1individuals/get/parameters/2' responses: '200': content: @@ -3214,7 +3189,6 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: READ - Fetch a consent record (latest revision) tags: - service x-specification-crudl-model: '' @@ -3223,12 +3197,12 @@ paths: x-specification-usecase: UC-C-PIC-A-003 /service/verification/consent-records: get: - description: LIST - Fetch consent records (latest revision). + summary: LIST - List all consent records + description: LIST - List all consent records operationId: serviceVerificationConsentRecordList parameters: - $ref: '#/paths/~1config~1policies/get/parameters/1' - $ref: '#/paths/~1config~1policies/get/parameters/2' - - $ref: '#/paths/~1service~1individuals/get/parameters/2' responses: '200': content: @@ -3247,7 +3221,6 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: LIST - Fetch consent records (latest revision) tags: - service x-specification-crudl-model: '' @@ -3256,12 +3229,13 @@ paths: x-specification-usecase: UC-C-PIC-A-003 '/service/individual/record/data-agreement/{dataAgreementId}': post: + summary: CREATE - Create consent record description: 'CREATE - For a particular individual and a particular data agreement, create a new consent record pointing to the current revision of a given data agreement.' operationId: serviceCreateIndividualConsentRecord parameters: - $ref: '#/paths/~1audit~1data-agreement~1%7BdataAgreementId%7D/get/parameters/0' - $ref: '#/paths/~1config~1data-agreements/get/parameters/0' - - $ref: '#/paths/~1service~1individuals/get/parameters/2' + - $ref: '#/paths/~1service~1individual~1record/delete/parameters/0' responses: '200': content: @@ -3278,7 +3252,6 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: CREATE - Create a consent record tags: - service x-specification-crudl-model: '' @@ -3286,11 +3259,12 @@ paths: x-specification-scenario: '1.2' x-specification-usecase: UC-C-PIC-I-002 get: + summary: READ - Read consent record description: READ - Read consent record. There should be one unambiguous DataAgreementRecord for an Individual and an DataAgreement. operationId: serviceReadIndividualRecordRead parameters: - $ref: '#/paths/~1audit~1data-agreement~1%7BdataAgreementId%7D/get/parameters/0' - - $ref: '#/paths/~1service~1individuals/get/parameters/2' + - $ref: '#/paths/~1service~1individual~1record/delete/parameters/0' responses: '200': content: @@ -3305,7 +3279,6 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: READ - Read consent record tags: - service x-specification-crudl-model: '' @@ -3314,6 +3287,7 @@ paths: x-specification-usecase: UC-C-PIC-I-001 /service/individual/record/consent-record/draft: post: + summary: CREATE - Create DRAFT consent record description: CREATE - Create a DRAFT (unsaved) consent record and signature objects (without a PK) for a given dataAgreementId. operationId: serviceCreateIndividualConsentRecordDraft parameters: @@ -3335,7 +3309,7 @@ paths: required: false schema: type: string - - $ref: '#/paths/~1service~1individuals/get/parameters/2' + - $ref: '#/paths/~1service~1individual~1record/delete/parameters/0' responses: '200': content: @@ -3352,7 +3326,6 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: CREATE - Create a DRAFT (unsaved) consent record and signature objects (without a PK) for a given dataAgreementId. tags: - service x-specification-crudl-model: '' @@ -3361,10 +3334,11 @@ paths: x-specification-usecase: UC-C-PIC-I-002 /service/individual/record/consent-record: post: + summary: CREATE - Create consent record and signature description: CREATE - Create a paired consent record and signature object. Returns the same objects with the PK defined. operationId: serviceCreateIndividualConsentRecordAndSignature parameters: - - $ref: '#/paths/~1service~1individuals/get/parameters/2' + - $ref: '#/paths/~1service~1individual~1record/delete/parameters/0' requestBody: content: application/json: @@ -3398,7 +3372,6 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: CREATE - Create a paired consent record and signature object tags: - service x-specification-crudl-model: '' @@ -3406,12 +3379,13 @@ paths: x-specification-scenario: '1.2' x-specification-usecase: UC-C-PIC-I-002 get: - description: LIST - Fetch all current unambiguous consent records stored for individual + summary: LIST - List all consent records for individual + description: LIST - List all current unambiguous consent records stored for individual operationId: serviceListIndividualConsentRecordList parameters: - $ref: '#/paths/~1config~1policies/get/parameters/1' - $ref: '#/paths/~1config~1policies/get/parameters/2' - - $ref: '#/paths/~1service~1individuals/get/parameters/2' + - $ref: '#/paths/~1service~1individual~1record/delete/parameters/0' responses: '200': content: @@ -3430,7 +3404,6 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: LIST - Fetch all consent records for individual tags: - service x-specification-crudl-model: '' @@ -3439,10 +3412,16 @@ paths: x-specification-usecase: UC-C-PIC-I-001 /service/individual/record: delete: + summary: DELETE - Delete all consent records for an individual description: 'DELETE - Cascading delete operation for Right To Be Forgotten, deletes all consent records that shall not be retained and have a "forgettable" DataAgreement. May also delete an unsigned consent record, for instance in cases where the user exits the signing process.' operationId: serviceDeleteAllRecords parameters: - - $ref: '#/paths/~1service~1individuals/get/parameters/2' + - in: header + name: X-ConsentBB-IndividualId + required: true + schema: + type: string + description: Individual Id responses: '200': description: '' @@ -3450,7 +3429,6 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: DELETE - Delete all consent records for an individual tags: - service x-specification-crudl-model: '' @@ -3459,7 +3437,8 @@ paths: x-specification-usecase: UC-C-PIC-I-003 '/service/individual/record/consent-record/{consentRecordId}': put: - description: UPDATE* - Update a consent record. Note that updating a signed consent record invalidates its signature. + summary: UPDATE - Update consent record + description: UPDATE - Update consent record. Note that updating a signed consent record invalidates its signature. operationId: serviceUpdateIndividualConsentRecord parameters: - $ref: '#/paths/~1audit~1consent-record~1%7BconsentRecordId%7D/get/parameters/0' @@ -3481,7 +3460,7 @@ paths: required: false schema: type: string - - $ref: '#/paths/~1service~1individuals/get/parameters/2' + - $ref: '#/paths/~1service~1individual~1record/delete/parameters/0' requestBody: content: application/json: @@ -3509,7 +3488,6 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: UPDATE* - Update a consent record tags: - service x-specification-crudl-model: '' @@ -3518,6 +3496,7 @@ paths: x-specification-usecase: UC-C-PIC-I-003 '/service/individual/record/consent-record/{consentRecordId}/signature': post: + summary: CREATE - Creates blank signature description: CREATE - Creates and returns a blank Signature object for the consent record operationId: serviceCreateIndividualConsentRecordSignature parameters: @@ -3527,7 +3506,7 @@ paths: required: true schema: type: string - - $ref: '#/paths/~1service~1individuals/get/parameters/2' + - $ref: '#/paths/~1service~1individual~1record/delete/parameters/0' responses: '200': content: @@ -3542,7 +3521,6 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: CREATE - Creates and returns a blank Signature object for the consent record tags: - service x-specification-crudl-model: '' @@ -3550,7 +3528,8 @@ paths: x-specification-scenario: '' x-specification-usecase: UC-Post-Partum-001-Registration_PostPartum_and_InfantCare put: - description: UPDATE - Updates a Signature object for a Data Agreement Record. This is used to add a signature to an existing unsigned Signature object. Consent BB is responsible for updating the Data Agreement Record state. + summary: UPDATE - Updates signature for consent record + description: UPDATE - Updates signature for consent record. This is used to add a signature to an existing unsigned consent record. Consent BB is responsible for updating the consent record state. operationId: serviceUpdateIndividualConsentRecordSignature parameters: - description: Unique ID of an object @@ -3559,7 +3538,7 @@ paths: required: true schema: type: string - - $ref: '#/paths/~1service~1individuals/get/parameters/2' + - $ref: '#/paths/~1service~1individual~1record/delete/parameters/0' requestBody: content: application/json: @@ -3585,22 +3564,18 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: UPDATE - Updates a Signature object for a Data Agreement Record tags: - service - x-specification-crudl-model: '' - x-specification-pii-or-sensitive: 'True' - x-specification-scenario: '' - x-specification-usecase: UC-Post-Partum-001-Registration_PostPartum_and_InfantCare '/service/individual/record/data-agreement/{dataAgreementId}/all': get: - description: LIST - Fetch consent records given to a data agreement. + summary: LIST - List all consent records for data agreement + description: LIST - List all consent records for data agreement operationId: serviceListIndividualAgreementConsentRecordList parameters: - $ref: '#/paths/~1audit~1data-agreement~1%7BdataAgreementId%7D/get/parameters/0' - $ref: '#/paths/~1config~1policies/get/parameters/1' - $ref: '#/paths/~1config~1policies/get/parameters/2' - - $ref: '#/paths/~1service~1individuals/get/parameters/2' + - $ref: '#/paths/~1service~1individual~1record/delete/parameters/0' responses: '200': content: @@ -3619,24 +3594,23 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: LIST - Fetch consent records given to a data agreement tags: - service x-specification-crudl-model: '' x-specification-pii-or-sensitive: 'True' x-specification-scenario: '' x-specification-usecase: UC-C-PIC-I-001 - /service/individual/record/consent-record/history': + /service/individual/record/consent-record/history: get: + summary: LIST - List all consent record history + description: LIST - List all consent record history operationId: serviceListDataAgreementRecordHistory tags: - service - description: LIST - Fetch all consent record history - summary: LIST - Fetch all consent record history parameters: - $ref: '#/paths/~1config~1policies/get/parameters/1' - $ref: '#/paths/~1config~1policies/get/parameters/2' - - $ref: '#/paths/~1service~1individuals/get/parameters/2' + - $ref: '#/paths/~1service~1individual~1record/delete/parameters/0' responses: '200': description: OK @@ -3683,16 +3657,22 @@ paths: - BearerAuth: [] /service/individual: post: - tags: - - service - summary: CREATE - Create an individual + summary: CREATE - Create individual + description: CREATE - Creates Individual in the Consent system operationId: configCreatePolicy - description: CREATE - Creates an Individual in the Consent system - parameters: [] - x-specification-usecase: '' - x-specification-scenario: '' - x-specification-pii-or-sensitive: 'True' - x-specification-crudl-model: Individual + requestBody: + content: + application/json: + schema: + type: object + properties: + individual: + allOf: + - $ref: '#/components/schemas/Individual' + - $ref: '#/paths/~1config~1individual/post/requestBody/content/application~1json/schema/properties/individual/allOf/1' + description: An object of type Individual + required: + - individual responses: '200': description: '' @@ -3710,26 +3690,13 @@ paths: description: bad input parameter security: - BearerAuth: [] - requestBody: - content: - application/json: - schema: - type: object - properties: - individual: - allOf: - - $ref: '#/components/schemas/Individual' - - $ref: '#/paths/~1config~1individual/post/requestBody/content/application~1json/schema/properties/individual/allOf/1' - description: An object of type Individual - required: - - individual - '/service/individual/{individualId}': - get: tags: - service - summary: READ - Read an individual + '/service/individual/{individualId}': + get: + summary: READ - Read individual + description: READ - Read individual in the Consent system operationId: configReadIndividual - description: READ - Fetch an Individual in the Consent system parameters: - in: path name: individualId @@ -3737,11 +3704,6 @@ paths: required: true schema: type: string - - $ref: '#/paths/~1service~1individuals/get/parameters/2' - x-specification-usecase: '' - x-specification-scenario: '' - x-specification-pii-or-sensitive: 'True' - x-specification-crudl-model: Individual responses: '200': description: '' @@ -3758,12 +3720,12 @@ paths: description: bad input parameter security: - BearerAuth: [] - put: tags: - service - summary: UPDATE - Update an individual + put: + summary: UPDATE - Update individual + description: UPDATE - Updates individual in the Consent system operationId: configUpdateIndividual - description: UPDATE - Updates an Individual in the Consent system parameters: - in: path name: individualId @@ -3771,11 +3733,6 @@ paths: required: true schema: type: string - - $ref: '#/paths/~1service~1individuals/get/parameters/2' - x-specification-usecase: '' - x-specification-scenario: '' - x-specification-pii-or-sensitive: 'True' - x-specification-crudl-model: Individual responses: '200': description: '' @@ -3790,8 +3747,6 @@ paths: - $ref: '#/paths/~1config~1individual/post/requestBody/content/application~1json/schema/properties/individual/allOf/1' '400': description: bad input parameter - security: - - BearerAuth: [] requestBody: content: application/json: @@ -3805,26 +3760,18 @@ paths: description: An object of type Individual required: - individual - /service/individuals: - get: + security: + - BearerAuth: [] tags: - service + /service/individuals: + get: summary: LIST - List all individuals - operationId: configListIndividuals description: LIST - lists individuals in the system + operationId: configListIndividuals parameters: - $ref: '#/paths/~1config~1policies/get/parameters/1' - $ref: '#/paths/~1config~1policies/get/parameters/2' - - in: header - name: X-ConsentBB-IndividualId - required: true - schema: - type: string - description: Individual Id - x-specification-usecase: '' - x-specification-scenario: '' - x-specification-pii-or-sensitive: 'True' - x-specification-crudl-model: Individual responses: '200': description: '' @@ -3845,13 +3792,14 @@ paths: description: bad input parameter security: - BearerAuth: [] + tags: + - service '/service/image/{imageId}': get: - deprecated: false - description: Get organization image + summary: READ - Read organisation image + description: READ - Read organisation image operationId: serviceReadOrganisationImage - parameters: - - $ref: '#/paths/~1service~1individuals/get/parameters/2' + deprecated: false responses: '200': headers: {} @@ -3861,7 +3809,8 @@ paths: - service /service/data-sharing: get: - description: READ - Data sharing UI + summary: READ - Read data sharing UI + description: READ - Read data sharing UI operationId: serviceReadDataSharingUi parameters: - name: dataAgreementId @@ -3925,7 +3874,6 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: READ - Data sharing UI tags: - service /audit/admin/logs: diff --git a/openapi/v2023.11.1/index.html b/openapi/v2023.11.1/index.html index a46012b..6997086 100644 --- a/openapi/v2023.11.1/index.html +++ b/openapi/v2023.11.1/index.html @@ -35,7 +35,8 @@ if ( apiInfoElement && labelOperationPathElements && - mainContentElement + mainContentElement && + sidebar ) { mainContentElement.style.padding = "10px"; apiInfoElement.style.marginLeft = "0"; @@ -56,6 +57,42 @@ applyStyleToApiInfo(); // Try applying the style immediately in case the element is already there } } else { + // Function to apply the style when the element is available + const applyStyleToApiInfo = () => { + const sidebar = rapiDocElement.shadowRoot.querySelector( + "[part*='section-navbar']" + ); + const post = rapiDocElement.shadowRoot.querySelectorAll( + ".nav-method.as-colored-block.post" + ); + const method = rapiDocElement.shadowRoot.querySelectorAll( + ".nav-method.as-colored-block" + ); + + if (sidebar && post) { + sidebar.style.minWidth = "385px"; + post.forEach(function (element) { + element.innerHTML = "POST"; + }); + method.forEach(function (element) { + element.style.borderRadius = "4px 4px 4px 4px"; + element.style.minWidth = "35px"; + element.style.display = "flex"; + element.style.justifyContent = "center"; + element.style.alignItems = "center"; + }); + + observer.disconnect(); // Stop observing once style is applied + } + }; + const observer = new MutationObserver(applyStyleToApiInfo); + if (rapiDocElement.shadowRoot) { + observer.observe(rapiDocElement.shadowRoot, { + childList: true, + subtree: true, + }); + applyStyleToApiInfo(); // Try applying the style immediately in case the element is already there + } rapiDocElement.setAttribute("render-style", "read"); // for sizes greater than a tablet } }); @@ -89,4 +126,4 @@ /> - \ No newline at end of file + diff --git a/openapi/v2023.11.1/index.yaml b/openapi/v2023.11.1/index.yaml index 350e8c7..918d47d 100644 --- a/openapi/v2023.11.1/index.yaml +++ b/openapi/v2023.11.1/index.yaml @@ -294,7 +294,7 @@ paths: /service/individual/record/data-agreement/{dataAgreementId}/all: get: $ref: ./paths/serviceListIndividualAgreementConsentRecordList.yaml - /service/individual/record/consent-record/history': + /service/individual/record/consent-record/history: get: $ref: "./paths/serviceListDataAgreementRecordHistory.yaml" /service/individual: diff --git a/openapi/v2023.11.1/paths/configUpdateIdp.yaml b/openapi/v2023.11.1/paths/configUpdateIdp.yaml index eecbc5a..c91e9cb 100644 --- a/openapi/v2023.11.1/paths/configUpdateIdp.yaml +++ b/openapi/v2023.11.1/paths/configUpdateIdp.yaml @@ -1,3 +1,4 @@ +summary: UPDATE - Update IDP description: UPDATE - Update an IDP operationId: configUpdatePolicy parameters: @@ -27,7 +28,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: UPDATE - Update an IDP tags: - config x-specification-crudl-model: IDP diff --git a/openapi/v2023.11.1/paths/serviceAgreementList.yaml b/openapi/v2023.11.1/paths/serviceAgreementList.yaml index 8251cdd..e1e713e 100644 --- a/openapi/v2023.11.1/paths/serviceAgreementList.yaml +++ b/openapi/v2023.11.1/paths/serviceAgreementList.yaml @@ -1,10 +1,10 @@ +summary: LIST - List all active data agreements description: LIST - List active data agreements operationId: serviceAgreementList parameters: - $ref: "../parameters/revisionId.yaml" - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" - - $ref: "../parameters/individualIdHeader.yaml" responses: "200": content: @@ -23,10 +23,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: LIST - List active data agreements tags: - service -x-specification-crudl-model: DataAgreement -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-A-003 diff --git a/openapi/v2023.11.1/paths/serviceAgreementRead.yaml b/openapi/v2023.11.1/paths/serviceAgreementRead.yaml index 8dd53f4..e15a33e 100644 --- a/openapi/v2023.11.1/paths/serviceAgreementRead.yaml +++ b/openapi/v2023.11.1/paths/serviceAgreementRead.yaml @@ -1,3 +1,4 @@ +summary: READ - Read data agreement description: READ - Read data agreement operationId: serviceAgreementRead parameters: @@ -7,7 +8,6 @@ parameters: required: true schema: type: string - - $ref: "../parameters/individualIdHeader.yaml" responses: "200": content: @@ -26,10 +26,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: READ - Read data agreement tags: - service -x-specification-crudl-model: DataAgreement -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-A-003 diff --git a/openapi/v2023.11.1/paths/serviceCreateIndividual.yaml b/openapi/v2023.11.1/paths/serviceCreateIndividual.yaml index f6dac0b..b0446ee 100644 --- a/openapi/v2023.11.1/paths/serviceCreateIndividual.yaml +++ b/openapi/v2023.11.1/paths/serviceCreateIndividual.yaml @@ -1,13 +1,20 @@ -tags: - - service -summary: "CREATE - Create an individual" +summary: CREATE - Create individual +description: "CREATE - Creates Individual in the Consent system" operationId: "configCreatePolicy" -description: "CREATE - Creates an Individual in the Consent system" -parameters: [] -x-specification-usecase: "" -x-specification-scenario: "" -x-specification-pii-or-sensitive: "True" -x-specification-crudl-model: "Individual" +requestBody: + content: + application/json: + schema: + type: object + properties: + individual: + allOf: + - $ref: "../definitions/Individual.yaml" + - $ref: "../definitions/IndividualExtras.yaml" + description: An object of type Individual + + required: + - individual responses: "200": description: "" @@ -27,18 +34,5 @@ responses: description: bad input parameter security: - BearerAuth: [] - -requestBody: - content: - application/json: - schema: - type: object - properties: - individual: - allOf: - - $ref: "../definitions/Individual.yaml" - - $ref: "../definitions/IndividualExtras.yaml" - description: An object of type Individual - - required: - - individual +tags: + - service diff --git a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecord.yaml b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecord.yaml index 2ea7a1e..fda383b 100644 --- a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecord.yaml +++ b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecord.yaml @@ -1,3 +1,4 @@ +summary: CREATE - Create consent record description: CREATE - For a particular individual and a particular data agreement, create a new consent record pointing to the current revision of a given data agreement. @@ -22,7 +23,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: CREATE - Create a consent record tags: - service x-specification-crudl-model: "" diff --git a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordAndSignature.yaml b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordAndSignature.yaml index bab221d..5265749 100644 --- a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordAndSignature.yaml +++ b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordAndSignature.yaml @@ -1,3 +1,4 @@ +summary: CREATE - Create consent record and signature description: CREATE - Create a paired consent record and signature object. Returns the same objects with the PK defined. operationId: serviceCreateIndividualConsentRecordAndSignature @@ -36,7 +37,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: CREATE - Create a paired consent record and signature object tags: - service x-specification-crudl-model: '' diff --git a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordDraft.yaml b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordDraft.yaml index fd9a72c..d6a8753 100644 --- a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordDraft.yaml +++ b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordDraft.yaml @@ -1,3 +1,4 @@ +summary: CREATE - Create DRAFT consent record description: CREATE - Create a DRAFT (unsaved) consent record and signature objects (without a PK) for a given dataAgreementId. @@ -38,9 +39,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: - CREATE - Create a DRAFT (unsaved) consent record and signature objects (without - a PK) for a given dataAgreementId. tags: - service x-specification-crudl-model: "" diff --git a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordSignature.yaml b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordSignature.yaml index 880e617..492549c 100644 --- a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordSignature.yaml +++ b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordSignature.yaml @@ -1,3 +1,4 @@ +summary: CREATE - Creates blank signature description: CREATE - Creates and returns a blank Signature object for the consent record operationId: serviceCreateIndividualConsentRecordSignature parameters: @@ -22,7 +23,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: CREATE - Creates and returns a blank Signature object for the consent record tags: - service x-specification-crudl-model: "" diff --git a/openapi/v2023.11.1/paths/serviceDeleteAllRecords.yaml b/openapi/v2023.11.1/paths/serviceDeleteAllRecords.yaml index 4a8d45c..e810f09 100644 --- a/openapi/v2023.11.1/paths/serviceDeleteAllRecords.yaml +++ b/openapi/v2023.11.1/paths/serviceDeleteAllRecords.yaml @@ -1,3 +1,4 @@ +summary: DELETE - Delete all consent records for an individual description: DELETE - Cascading delete operation for Right To Be Forgotten, deletes all consent records that shall not be retained and have a "forgettable" DataAgreement. May also delete an unsigned consent record, for instance in cases where the user @@ -12,7 +13,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: DELETE - Delete all consent records for an individual tags: - service x-specification-crudl-model: '' diff --git a/openapi/v2023.11.1/paths/serviceListDataAgreementRecordHistory.yaml b/openapi/v2023.11.1/paths/serviceListDataAgreementRecordHistory.yaml index 3a73586..a41541c 100644 --- a/openapi/v2023.11.1/paths/serviceListDataAgreementRecordHistory.yaml +++ b/openapi/v2023.11.1/paths/serviceListDataAgreementRecordHistory.yaml @@ -1,8 +1,8 @@ +summary: LIST - List all consent record history +description: LIST - List all consent record history operationId: serviceListDataAgreementRecordHistory tags: - service -description: LIST - Fetch all consent record history -summary: LIST - Fetch all consent record history parameters: - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" diff --git a/openapi/v2023.11.1/paths/serviceListDataAttributesForDataAgreement.yaml b/openapi/v2023.11.1/paths/serviceListDataAttributesForDataAgreement.yaml index e06dd69..0ebb444 100644 --- a/openapi/v2023.11.1/paths/serviceListDataAttributesForDataAgreement.yaml +++ b/openapi/v2023.11.1/paths/serviceListDataAttributesForDataAgreement.yaml @@ -1,11 +1,11 @@ -description: READ - Fetch all latest versions of data attribute associated with an DataAgreement and the presented revisionId of that DataAgreement +summary: LIST - List all data attributes for data agreement +description: LIST - List all latest versions of data attribute associated with an DataAgreement and the presented revisionId of that DataAgreement operationId: serviceAgreementDataRead parameters: - $ref: "../parameters/dataAgreementId.yaml" - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" - $ref: "../parameters/revisionId.yaml" - - $ref: "../parameters/individualIdHeader.yaml" responses: '200': content: @@ -24,10 +24,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: READ - Fetch all data attributes for data agreement tags: - service -x-specification-crudl-model: AgreementData -x-specification-pii-or-sensitive: 'False' -x-specification-scenario: '' -x-specification-usecase: UC-C-PIC-A-003 diff --git a/openapi/v2023.11.1/paths/serviceListIndividualAgreementConsentRecordList.yaml b/openapi/v2023.11.1/paths/serviceListIndividualAgreementConsentRecordList.yaml index e289ac1..d11e91b 100644 --- a/openapi/v2023.11.1/paths/serviceListIndividualAgreementConsentRecordList.yaml +++ b/openapi/v2023.11.1/paths/serviceListIndividualAgreementConsentRecordList.yaml @@ -1,4 +1,5 @@ -description: LIST - Fetch consent records given to a data agreement. +summary: LIST - List all consent records for data agreement +description: LIST - List all consent records for data agreement operationId: serviceListIndividualAgreementConsentRecordList parameters: - $ref: "../parameters/dataAgreementId.yaml" @@ -23,7 +24,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: LIST - Fetch consent records given to a data agreement tags: - service x-specification-crudl-model: "" diff --git a/openapi/v2023.11.1/paths/serviceListIndividualConsentRecordList.yaml b/openapi/v2023.11.1/paths/serviceListIndividualConsentRecordList.yaml index 4c4eb5b..f2f66b6 100644 --- a/openapi/v2023.11.1/paths/serviceListIndividualConsentRecordList.yaml +++ b/openapi/v2023.11.1/paths/serviceListIndividualConsentRecordList.yaml @@ -1,4 +1,5 @@ -description: LIST - Fetch all current unambiguous consent records stored for individual +summary: LIST - List all consent records for individual +description: LIST - List all current unambiguous consent records stored for individual operationId: serviceListIndividualConsentRecordList parameters: - $ref: "../parameters/offset.yaml" @@ -22,7 +23,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: LIST - Fetch all consent records for individual tags: - service x-specification-crudl-model: "" diff --git a/openapi/v2023.11.1/paths/serviceListIndividuals.yaml b/openapi/v2023.11.1/paths/serviceListIndividuals.yaml index 5620a1b..a6399f1 100644 --- a/openapi/v2023.11.1/paths/serviceListIndividuals.yaml +++ b/openapi/v2023.11.1/paths/serviceListIndividuals.yaml @@ -1,20 +1,12 @@ -tags: - - service -summary: "LIST - List all individuals" +summary: LIST - List all individuals +description: LIST - lists individuals in the system operationId: "configListIndividuals" -description: "LIST - lists individuals in the system" parameters: - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" - - $ref: "../parameters/individualIdHeader.yaml" -x-specification-usecase: "" -x-specification-scenario: "" -x-specification-pii-or-sensitive: "True" -x-specification-crudl-model: "Individual" responses: "200": description: "" - content: application/json: schema: @@ -28,8 +20,9 @@ responses: - $ref: "../definitions/IndividualExtras.yaml" pagination: $ref: "../definitions/Pagination.yaml" - "400": description: bad input parameter security: - BearerAuth: [] +tags: + - service diff --git a/openapi/v2023.11.1/paths/servicePolicyRead.yaml b/openapi/v2023.11.1/paths/servicePolicyRead.yaml index 9cface2..549c37c 100644 --- a/openapi/v2023.11.1/paths/servicePolicyRead.yaml +++ b/openapi/v2023.11.1/paths/servicePolicyRead.yaml @@ -1,9 +1,9 @@ +summary: READ - Read policy description: READ - Fetch the latest version of a Policy and the presented revisionId of an associated DataAgreement operationId: servicePolicyRead parameters: - $ref: "../parameters/policyId.yaml" - $ref: "../parameters/revisionId.yaml" - - $ref: "../parameters/individualIdHeader.yaml" responses: "200": content: @@ -20,7 +20,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: READ - Read policy tags: - service x-specification-crudl-model: Policy diff --git a/openapi/v2023.11.1/paths/serviceReadDataSharingUi.yaml b/openapi/v2023.11.1/paths/serviceReadDataSharingUi.yaml index 6779366..d2b9db6 100644 --- a/openapi/v2023.11.1/paths/serviceReadDataSharingUi.yaml +++ b/openapi/v2023.11.1/paths/serviceReadDataSharingUi.yaml @@ -1,4 +1,5 @@ -description: READ - Data sharing UI +summary: READ - Read data sharing UI +description: READ - Read data sharing UI operationId: serviceReadDataSharingUi parameters: - name: dataAgreementId @@ -62,6 +63,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: READ - Data sharing UI tags: - service diff --git a/openapi/v2023.11.1/paths/serviceReadIdp.yaml b/openapi/v2023.11.1/paths/serviceReadIdp.yaml index 53009a3..9bccade 100644 --- a/openapi/v2023.11.1/paths/serviceReadIdp.yaml +++ b/openapi/v2023.11.1/paths/serviceReadIdp.yaml @@ -1,8 +1,8 @@ -description: READ - Read an IDP +summary: READ - Read IdP +description: READ - Read IdP operationId: serviceReadIdp parameters: - $ref: "../parameters/idpId.yaml" - - $ref: "../parameters/individualIdHeader.yaml" responses: "200": content: @@ -17,10 +17,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: READ - Read an IDP tags: - service -x-specification-crudl-model: IDP -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-A-003 diff --git a/openapi/v2023.11.1/paths/serviceReadIndividual.yaml b/openapi/v2023.11.1/paths/serviceReadIndividual.yaml index 9599fe3..f99eeec 100644 --- a/openapi/v2023.11.1/paths/serviceReadIndividual.yaml +++ b/openapi/v2023.11.1/paths/serviceReadIndividual.yaml @@ -1,8 +1,6 @@ -tags: - - service -summary: "READ - Read an individual" +summary: READ - Read individual +description: READ - Read individual in the Consent system operationId: "configReadIndividual" -description: "READ - Fetch an Individual in the Consent system" parameters: - in: path name: "individualId" @@ -10,11 +8,6 @@ parameters: required: true schema: type: string - - $ref: "../parameters/individualIdHeader.yaml" -x-specification-usecase: "" -x-specification-scenario: "" -x-specification-pii-or-sensitive: "True" -x-specification-crudl-model: "Individual" responses: "200": description: "" @@ -28,8 +21,9 @@ responses: allOf: - $ref: "../definitions/Individual.yaml" - $ref: "../definitions/IndividualExtras.yaml" - "400": description: bad input parameter security: - BearerAuth: [] +tags: + - service diff --git a/openapi/v2023.11.1/paths/serviceReadIndividualRecordRead.yaml b/openapi/v2023.11.1/paths/serviceReadIndividualRecordRead.yaml index 701d6b7..9ede518 100644 --- a/openapi/v2023.11.1/paths/serviceReadIndividualRecordRead.yaml +++ b/openapi/v2023.11.1/paths/serviceReadIndividualRecordRead.yaml @@ -1,3 +1,4 @@ +summary: READ - Read consent record description: READ - Read consent record. There should be one unambiguous DataAgreementRecord for an Individual and an DataAgreement. @@ -19,7 +20,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: READ - Read consent record tags: - service x-specification-crudl-model: "" diff --git a/openapi/v2023.11.1/paths/serviceReadOrganisation.yaml b/openapi/v2023.11.1/paths/serviceReadOrganisation.yaml index c9fa05d..655a7f2 100644 --- a/openapi/v2023.11.1/paths/serviceReadOrganisation.yaml +++ b/openapi/v2023.11.1/paths/serviceReadOrganisation.yaml @@ -1,8 +1,7 @@ -deprecated: false -description: Read organization +description: READ - Read organisation +summary: Read organisation operationId: serviceReadOrganisation -parameters: - - $ref: "../parameters/individualIdHeader.yaml" +deprecated: false responses: '200': content: diff --git a/openapi/v2023.11.1/paths/serviceReadOrganisationCoverImage.yaml b/openapi/v2023.11.1/paths/serviceReadOrganisationCoverImage.yaml index f2ca865..c29aab5 100644 --- a/openapi/v2023.11.1/paths/serviceReadOrganisationCoverImage.yaml +++ b/openapi/v2023.11.1/paths/serviceReadOrganisationCoverImage.yaml @@ -1,12 +1,11 @@ -deprecated: false +summary: READ - Read organization cover image description: Read organization cover image operationId: serviceReadOrganisationCoverImage -parameters: - - $ref: "../parameters/individualIdHeader.yaml" responses: '200': headers: {} security: - BearerAuth: [] +deprecated: false tags: - service diff --git a/openapi/v2023.11.1/paths/serviceReadOrganisationImage.yaml b/openapi/v2023.11.1/paths/serviceReadOrganisationImage.yaml index e4c11b4..f10bada 100644 --- a/openapi/v2023.11.1/paths/serviceReadOrganisationImage.yaml +++ b/openapi/v2023.11.1/paths/serviceReadOrganisationImage.yaml @@ -1,12 +1,11 @@ -deprecated: false -description: Get organization image +summary: READ - Read organisation image +description: READ - Read organisation image operationId: serviceReadOrganisationImage -parameters: - - $ref: "../parameters/individualIdHeader.yaml" +deprecated: false responses: - '200': + "200": headers: {} security: -- BearerAuth: [] + - BearerAuth: [] tags: -- service + - service diff --git a/openapi/v2023.11.1/paths/serviceReadOrganisationLogoImage.yaml b/openapi/v2023.11.1/paths/serviceReadOrganisationLogoImage.yaml index b9c9962..16256ec 100644 --- a/openapi/v2023.11.1/paths/serviceReadOrganisationLogoImage.yaml +++ b/openapi/v2023.11.1/paths/serviceReadOrganisationLogoImage.yaml @@ -1,8 +1,7 @@ -deprecated: false -description: Read organization logo image +summary: READ - Read organisation logo image +description: Read organisation logo image operationId: serviceReadOrganisationLogoImage -parameters: - - $ref: "../parameters/individualIdHeader.yaml" +deprecated: false responses: "200": headers: {} diff --git a/openapi/v2023.11.1/paths/serviceUpdateIndividual.yaml b/openapi/v2023.11.1/paths/serviceUpdateIndividual.yaml index 5216487..a1b4492 100644 --- a/openapi/v2023.11.1/paths/serviceUpdateIndividual.yaml +++ b/openapi/v2023.11.1/paths/serviceUpdateIndividual.yaml @@ -1,8 +1,6 @@ -tags: - - service -summary: "UPDATE - Update an individual" +summary: UPDATE - Update individual +description: UPDATE - Updates individual in the Consent system operationId: "configUpdateIndividual" -description: "UPDATE - Updates an Individual in the Consent system" parameters: - in: path name: "individualId" @@ -10,11 +8,6 @@ parameters: required: true schema: type: string - - $ref: "../parameters/individualIdHeader.yaml" -x-specification-usecase: "" -x-specification-scenario: "" -x-specification-pii-or-sensitive: "True" -x-specification-crudl-model: "Individual" responses: '200': description: "" @@ -28,12 +21,8 @@ responses: allOf: - $ref: "../definitions/Individual.yaml" - $ref: "../definitions/IndividualExtras.yaml" - '400': description: bad input parameter -security: - - BearerAuth: [] - requestBody: content: application/json: @@ -47,4 +36,8 @@ requestBody: description: An object of type Individual required: - - individual \ No newline at end of file + - individual +security: + - BearerAuth: [] +tags: + - service \ No newline at end of file diff --git a/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecord.yaml b/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecord.yaml index e7a5352..09c34cb 100644 --- a/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecord.yaml +++ b/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecord.yaml @@ -1,4 +1,5 @@ -description: UPDATE* - Update a consent record. Note that updating a signed consent record invalidates its signature. +summary: UPDATE - Update consent record +description: UPDATE - Update consent record. Note that updating a signed consent record invalidates its signature. operationId: serviceUpdateIndividualConsentRecord parameters: - $ref: "../parameters/consentRecordId.yaml" @@ -48,7 +49,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: UPDATE* - Update a consent record tags: - service x-specification-crudl-model: "" diff --git a/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecordSignature.yaml b/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecordSignature.yaml index 2b86826..f206193 100644 --- a/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecordSignature.yaml +++ b/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecordSignature.yaml @@ -1,7 +1,7 @@ -description: - UPDATE - Updates a Signature object for a Data Agreement Record. This is used - to add a signature to an existing unsigned Signature object. Consent BB is responsible - for updating the Data Agreement Record state. +summary: UPDATE - Updates signature for consent record +description: UPDATE - Updates signature for consent record. This is used + to add a signature to an existing unsigned consent record. Consent BB is responsible + for updating the consent record state. operationId: serviceUpdateIndividualConsentRecordSignature parameters: - description: Unique ID of an object @@ -36,10 +36,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: UPDATE - Updates a Signature object for a Data Agreement Record tags: - service -x-specification-crudl-model: "" -x-specification-pii-or-sensitive: "True" -x-specification-scenario: "" -x-specification-usecase: UC-Post-Partum-001-Registration_PostPartum_and_InfantCare diff --git a/openapi/v2023.11.1/paths/serviceVerificationAgreementConsentRecordRead.yaml b/openapi/v2023.11.1/paths/serviceVerificationAgreementConsentRecordRead.yaml index 7492d02..32677cf 100644 --- a/openapi/v2023.11.1/paths/serviceVerificationAgreementConsentRecordRead.yaml +++ b/openapi/v2023.11.1/paths/serviceVerificationAgreementConsentRecordRead.yaml @@ -1,8 +1,8 @@ -description: READ - Fetch a consent record (latest revision). The individualId is supplied as HTTP header. +summary: READ - Read latest consent record +description: READ - Read latest consent record. operationId: serviceVerificationAgreementConsentRecordRead parameters: - $ref: "../parameters/consentRecordId.yaml" - - $ref: "../parameters/individualIdHeader.yaml" responses: "200": content: @@ -19,7 +19,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: READ - Fetch a consent record (latest revision) tags: - service x-specification-crudl-model: "" diff --git a/openapi/v2023.11.1/paths/serviceVerificationAgreementList.yaml b/openapi/v2023.11.1/paths/serviceVerificationAgreementList.yaml index 1685d65..08adfc0 100644 --- a/openapi/v2023.11.1/paths/serviceVerificationAgreementList.yaml +++ b/openapi/v2023.11.1/paths/serviceVerificationAgreementList.yaml @@ -1,9 +1,9 @@ -description: LIST - Fetch all consent records +summary: LIST - List all consent records +description: LIST - List all consent records operationId: serviceVerificationAgreementList parameters: - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" - - $ref: "../parameters/individualIdHeader.yaml" responses: "200": content: @@ -22,7 +22,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: LIST - Fetch all consent records tags: - service x-specification-crudl-model: "" diff --git a/openapi/v2023.11.1/paths/serviceVerificationConsentRecordList.yaml b/openapi/v2023.11.1/paths/serviceVerificationConsentRecordList.yaml index 98a0067..a722bd8 100644 --- a/openapi/v2023.11.1/paths/serviceVerificationConsentRecordList.yaml +++ b/openapi/v2023.11.1/paths/serviceVerificationConsentRecordList.yaml @@ -1,9 +1,9 @@ -description: LIST - Fetch consent records (latest revision). +summary: LIST - List all consent records +description: LIST - List all consent records operationId: serviceVerificationConsentRecordList parameters: - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" - - $ref: "../parameters/individualIdHeader.yaml" responses: "200": content: @@ -22,7 +22,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: LIST - Fetch consent records (latest revision) tags: - service x-specification-crudl-model: ""