diff --git a/openapi/v2023.11.1/bundled.yaml b/openapi/v2023.11.1/bundled.yaml index cf2ac2f..dece0ab 100644 --- a/openapi/v2023.11.1/bundled.yaml +++ b/openapi/v2023.11.1/bundled.yaml @@ -827,7 +827,7 @@ openapi: 3.1.0 paths: /config/data-agreement: post: - summary: CREATE - Create a data agreement + summary: CREATE - Create data agreement description: | This endpoint creates a data agreement for an organisation. It also returns the latest revision of the created data agreement. @@ -862,13 +862,12 @@ paths: - BearerAuth: [] tags: - config - x-specification-crudl-model: DataAgreement - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-001 '/config/data-agreement/{dataAgreementId}': get: - description: READ - Fetch the latest version of a data agreement + summary: READ - Read data agreement + description: | + This endpoint allows the admin to view the latest data agreement defined + earlier in an organisation. It also returns the latest revision number. operationId: configReadAgreement parameters: - description: Unique ID of an object @@ -893,15 +892,11 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: READ - Read data agreement tags: - config - x-specification-crudl-model: DataAgreement - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-003 put: - description: UPDATE - Update an existing data agreement and returned together with revision + summary: UPDATE - Update data agreement + description: This endpoint allows the admin to update the latest data agreement defined earlier in an organisation. It also returns the updated revision number. operationId: configUpdateAgreement parameters: - description: Unique ID of an object @@ -937,15 +932,11 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: UPDATE - Update data agreement tags: - config - x-specification-crudl-model: DataAgreement - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-002 delete: - description: DELETE - Delete a data agreement + summary: DELETE - Delete data agreement + description: This endpoint allows the admin to delete all revisions of a chosen data agreement defined earlier in an organisation. operationId: configDeleteAgreement parameters: - description: Unique ID of an object @@ -965,16 +956,12 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: DELETE - Delete data agreement tags: - config - x-specification-crudl-model: DataAgreement - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-004 /config/data-agreements: get: - description: LIST - Fetch all data agreements + summary: LIST - List all data agreements + description: This endpoint allows the admin to read all data agreements and their revisions defined earlier in an organisation. operationId: configListAgreement parameters: - description: An object with id revisionId @@ -1008,16 +995,12 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: LIST - List all data agreements tags: - config - x-specification-crudl-model: DataAgreement - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-003 '/config/data-agreement/{dataAgreementId}/revisions': get: - description: LIST - Returns all the revisions for the data agreement + summary: LIST - List data agreement revisions + description: This endpoint lists all revisions of a data agreement defined earlier in an organisation. operationId: configListAgreementRevisions parameters: - $ref: '#/paths/~1audit~1data-agreement~1%7BdataAgreementId%7D/get/parameters/0' @@ -1043,16 +1026,15 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: LIST - List all data agreement revisions tags: - config x-specification-crudl-model: Revision x-specification-pii-or-sensitive: 'False' x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-003 '/config/data-agreement/{dataAgreementId}/data-attributes': get: - description: READ - Read all data attributes for the data agreement + summary: READ - Read data attributes + description: This endpoint reads all data attrinbutes defined in a data agreement. operationId: configListDataAttribute parameters: - $ref: '#/paths/~1audit~1data-agreement~1%7BdataAgreementId%7D/get/parameters/0' @@ -1081,16 +1063,12 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: READ - Read all data attributes for the data agreement tags: - config - x-specification-crudl-model: DataAttribute - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-003 '/config/data-agreements/data-attribute/{dataAttributeId}': put: - description: UPDATE - Update an existing data attribute and returned together with revision + summary: UPDATE - Update data attribute + description: 'This endpoint updates an existing data attribute defined in a data agreement. If updated, the associated data agreement revision is incremented automatically.' operationId: configUpdateDataAttribute parameters: - description: Unique ID of an object @@ -1124,16 +1102,12 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: UPDATE - Update data attribute tags: - config - x-specification-crudl-model: DataAttribute - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-002 /config/data-agreements/data-attributes: get: - description: LIST - Fetch all data attributes + summary: LIST - List all data attributes + description: This endpoint reads all data attrinbutes defined in a data agreement with pagination. operationId: configListDataAttribute parameters: - $ref: '#/paths/~1config~1data-agreements/get/parameters/0' @@ -1172,16 +1146,12 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: LIST - List all data attributes tags: - config - x-specification-crudl-model: DataAttribute - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-003 /config/policy: post: - description: CREATE - Create a new policy and returned together with revision + summary: CREATE - Create data policy + description: This endpoint creates a new data policy that can be reused as global parameter across all newly crearted data agremements. operationId: configCreatePolicy parameters: [] requestBody: @@ -1211,16 +1181,12 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: CREATE - Create policy tags: - config - x-specification-crudl-model: Policy - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-001 '/config/policy/{policyId}': get: - description: 'READ - Fetch a policy + latest revision. If a policy filter is supplied and contains a `revisionId`, then this specific revision is returned.' + summary: READ - Read data policy + description: READ - This endpoint reads a data policy with the latest revision info. operationId: configReadPolicy parameters: - description: Unique ID of an object @@ -1251,15 +1217,11 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: READ - Read policy tags: - config - x-specification-crudl-model: Policy - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-003 put: - description: 'UPDATE - Update an existing policy, returning the updated version and a new revision. Updating a Policy does not affect existing references in DataAgreement, the new revision should be specified for DataAgreement.' + summary: UPDATE - Update data policy + description: This endpoint is used to update and existing data policy. It updates the existing and returns the updated version info. Updating a data policy does not affect existing data agreements. operationId: configUpdatePolicy parameters: - description: Unique ID of an object @@ -1295,15 +1257,11 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: UPDATE - Update policy tags: - config - x-specification-crudl-model: Policy - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-002 delete: - description: 'DELETE - Deletes an existing policy, returning the updated version and a new revision. Deleting a policy is not possible if it''s associated with active DataAgreement.' + summary: DELETE - Delete data policy + description: This endpoint is used to delete an existing data policy. operationId: configDeletePolicy parameters: - description: Unique ID of an object @@ -1323,16 +1281,12 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: DELETE - Deletes policy tags: - config - x-specification-crudl-model: Policy - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-004 /config/policies: get: - description: LIST - Fetch all policies + summary: LIST - List all data policies + description: This endpoint reads all data policies defined in the consent building block. operationId: configListPolicy parameters: - description: An object with id revisionId @@ -1372,16 +1326,12 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: LIST - List all policies tags: - config - x-specification-crudl-model: Policy - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: 'UC-C-PIC-A-001, UC-C-PIC-A-002' '/config/policy/{policyId}/revisions': get: - description: LIST - Returns all the revisions for the policy + summary: LIST - List data policy revisions + description: This endpoint reads all data policy revisions defined in the consent building block. operationId: configListPolicyRevisions parameters: - description: Unique ID of an object @@ -1412,25 +1362,13 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: LIST - List all policy revisions tags: - config - x-specification-crudl-model: Revision - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-003 /config/individual: post: - tags: - - config - summary: CREATE - Create an individual + summary: CREATE - Create individual + description: This endpoint creates an individual for an organisation in the consent block system. This is used to onboard existing or new users. 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 responses: '200': description: '' @@ -1479,13 +1417,13 @@ paths: description: An object of type Individual required: - individual - '/config/individual/{individualId}': - get: tags: - config - summary: READ - Read an individual + '/config/individual/{individualId}': + get: + summary: READ - Read individual + description: This endpoint is used to read an individual info defined for an organisation in the consent building block. operationId: configReadIndividual - description: READ - Fetch an Individual in the Consent system parameters: - in: path name: individualId @@ -1493,10 +1431,6 @@ paths: required: true schema: type: string - x-specification-usecase: '' - x-specification-scenario: '' - x-specification-pii-or-sensitive: 'True' - x-specification-crudl-model: Individual responses: '200': description: '' @@ -1513,12 +1447,12 @@ paths: description: bad input parameter security: - BearerAuth: [] - put: tags: - config - summary: UPDATE - Update an individual + put: + summary: UPDATE - Update individual + description: This endpoint is used to udpated an individual for an organisation defined in the consent building block. operationId: configUpdateIndividual - description: UPDATE - Updates an Individual in the Consent system parameters: - in: path name: individualId @@ -1526,10 +1460,6 @@ paths: required: true schema: type: string - x-specification-usecase: '' - x-specification-scenario: '' - x-specification-pii-or-sensitive: 'True' - x-specification-crudl-model: Individual responses: '200': description: '' @@ -1559,20 +1489,16 @@ paths: description: An object of type Individual required: - individual - /config/individuals: - get: tags: - config + /config/individuals: + get: summary: LIST - List all individuals + description: This endpoint is used to list all individuals in the organisation defined in the consent building block. operationId: configListIndividuals - description: LIST - lists individuals in the system parameters: - $ref: '#/paths/~1config~1policies/get/parameters/1' - $ref: '#/paths/~1config~1policies/get/parameters/2' - x-specification-usecase: '' - x-specification-scenario: '' - x-specification-pii-or-sensitive: 'True' - x-specification-crudl-model: Individual responses: '200': description: '' @@ -1593,11 +1519,12 @@ paths: description: bad input parameter security: - BearerAuth: [] + tags: + - config /config/individual/upload: post: - deprecated: false - description: CREATE - Create individuals in bulk from CSV file - summary: CREATE - Create individuals in bulk from CSV file + summary: CREATE - Create individual(s) via csv + description: This endpoint is used to onboard existing individual users defined in the organisation to consent building block using a .csv file. operationId: configUploadIndividuals requestBody: content: @@ -1617,15 +1544,14 @@ paths: content: {} security: - BearerAuth: [] + deprecated: false tags: - config /config/webhook: post: - operationId: configCreateWebhook summary: CREATE - Create webhook - description: Create webhook - tags: - - config + description: This endpoint is used to create a webhook to trigger events from consent building block to an external IT system. + operationId: configCreateWebhook requestBody: content: application/json: @@ -1648,13 +1574,13 @@ paths: deprecated: false security: - BearerAuth: [] + tags: + - config '/config/webhook/{webhookId}': get: - operationId: configReadWebhook summary: READ - Read webhook - description: Get a webhook by ID - tags: - - config + description: This endpoint is used to read a webhook to by its ID defined in the consent building block. + operationId: configReadWebhook parameters: - name: webhookId in: path @@ -1675,12 +1601,12 @@ paths: deprecated: false security: - BearerAuth: [] - put: - operationId: configUpdateWebhook - summary: UPDATE - Update webhook - description: UPDATE - Update webhook tags: - config + put: + summary: UPDATE - Update webhook + description: This endpoint is used to update an existing webhook to trigger events from consent building block to an external IT system. + operationId: configUpdateWebhook parameters: - name: webhookId in: path @@ -1710,12 +1636,12 @@ paths: deprecated: false security: - BearerAuth: [] - delete: - operationId: configDeleteWebhook - summary: DELETE - Delete webhook - description: Delete webhook tags: - config + delete: + summary: DELETE - Delete webhook + description: This endpoint is used to delete an existing webhook that was defined to trigger events from the consent building block to an external IT system. + operationId: configDeleteWebhook parameters: - name: webhookId in: path @@ -1736,13 +1662,13 @@ paths: deprecated: false security: - BearerAuth: [] + tags: + - config /config/webhooks: get: - operationId: configListWebhooks summary: LIST - List all webhooks - description: Get all webhooks for an organisation - tags: - - config + description: This endpoint is used to get all webhooks that was defined to trigger events from the consent building block to an external IT system. + operationId: configListWebhooks parameters: - $ref: '#/paths/~1config~1policies/get/parameters/1' - $ref: '#/paths/~1config~1policies/get/parameters/2' @@ -1765,13 +1691,13 @@ paths: deprecated: false security: - BearerAuth: [] + tags: + - config '/config/webhook/{webhookId}/ping': post: - operationId: configPingWebhook summary: Ping webhook - description: Ping webhook - tags: - - config + description: This endpoint is used to ping a webhook that was defined to trigger events from the consent building block to an external IT system. + operationId: configPingWebhook parameters: - name: webhookId in: path @@ -1820,13 +1746,13 @@ paths: deprecated: false security: - BearerAuth: [] + tags: + - config '/config/webhooks/{webhookId}/deliveries': get: + summary: LIST - List all webhook deliveries + description: This endpoint is used to read recent webhook deliveries with pagination from the consent building block that were sent to an external IT system. operationId: configListAllRecentWebhookDeliveries - summary: Get recent webhook deliveries - description: Get recent webhook deliveries - tags: - - config parameters: - name: webhookId in: path @@ -1882,13 +1808,13 @@ paths: deprecated: false security: - BearerAuth: [] + tags: + - config '/config/webhooks/{webhookId}/delivery/{deliveryId}': get: + summary: READ - Read webhook delivery + description: This endpint is used to get the recent webhook deliveries for a webhook defined in the consent building block. operationId: configReadRecentWebhookDelivery - summary: Get recent webhook delivery by ID - description: Get recent webhook delivery by ID - tags: - - config parameters: - name: webhookId in: path @@ -1921,13 +1847,13 @@ paths: deprecated: false security: - BearerAuth: [] + tags: + - config '/config/webhooks/{webhookId}/delivery/{deliveryId}/redeliver': post: + summary: Re-deliver a webhook event + description: This endpoint is used to re-deliver a webhook payload by delivery ID. operationId: configRedeliverWebhook - summary: Redeliver a webhook payload by delivery ID - description: Redeliver a webhook payload by delivery ID - tags: - - config parameters: - name: organizationId in: path @@ -1954,13 +1880,13 @@ paths: deprecated: false security: - BearerAuth: [] + tags: + - config /config/webhooks/event-types: get: + summary: READ - Read webhook event types + description: This endpoint is used to list all webhook event types defined in the consent building block. operationId: configReadWebhookEventTypes - description: Get webhook event types - summary: LIST - List all webhook event types - tags: - - config responses: '200': description: OK @@ -1991,13 +1917,13 @@ paths: deprecated: false security: - BearerAuth: [] + tags: + - config /config/webhooks/payload/content-types: get: + summary: LIST - List all webhook content types + description: This endpoint is used to get webhook content types. operationId: getWebhookPayloadContentTypes.yaml - summary: LIST - List all webhook payload content types - description: Get webhook payload content types - tags: - - config responses: '200': description: OK @@ -2018,9 +1944,12 @@ paths: deprecated: false security: - BearerAuth: [] + tags: + - config /config/idp/open-id: post: - description: CREATE - Create an IDP + summary: CREATE - Create IDP + description: This endpoint is used to configure an IdP (e.g. OIDC based) used by the organisation in the consent building block. operationId: configCreateIdp parameters: [] requestBody: @@ -2048,16 +1977,12 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: CREATE - Create an IDP tags: - config - x-specification-crudl-model: IDP - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: '' '/config/idp/open-id/{idpId}': get: - description: READ - Read an IDP + summary: READ - Read IdP details + description: This endpoint is used to read the IdP details configured by the organisation in the consent building block. operationId: configReadIdp parameters: - $ref: '#/paths/~1service~1idp~1open-id/get/parameters/0' @@ -2075,13 +2000,8 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: READ - Read an IDP tags: - config - x-specification-crudl-model: IDP - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-003 put: description: UPDATE - Update an IDP operationId: configUpdatePolicy @@ -2189,18 +2109,12 @@ paths: x-specification-usecase: UC-C-PIC-A-004 /config/idp/open-ids: post: - tags: - - config - summary: LIST - List IDP + summary: LIST - List all IdPs + description: This endpoint read all IdPs configured for the organisation in the consent building block. operationId: configListIdp - description: LIST - List IDP parameters: - $ref: '#/paths/~1config~1policies/get/parameters/1' - $ref: '#/paths/~1config~1policies/get/parameters/2' - x-specification-usecase: '' - x-specification-scenario: '' - x-specification-pii-or-sensitive: 'True' - x-specification-crudl-model: IDP responses: '200': description: '' @@ -2220,9 +2134,12 @@ paths: description: bad input parameter security: - BearerAuth: [] + tags: + - config /config/admin/apikeys: get: - description: LIST - List all api keys + summary: LIST - List all api keys + description: This endpoint lists all API keys created in consent building block with pagination. operationId: configListApiKey parameters: - $ref: '#/paths/~1config~1policies/get/parameters/1' @@ -2246,16 +2163,12 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: LIST - List all api keys tags: - config - x-specification-crudl-model: ApiKey - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-003 /config/admin/apikey: post: - description: CREATE - Create an API key + summary: CREATE - Create API key + description: 'This endpoint is used to create an API key for accessing endpoints in the consent building block. It can created for a specific scope. E.g. Config, Onboard, Audit, Service.' operationId: configCreateApikey parameters: [] requestBody: @@ -2265,7 +2178,7 @@ paths: properties: apiKey: $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/delete/responses/200/content/application~1json/schema/allOf/0' - description: An object of type ApiKey + description: An object of type APIKey required: - apiKey type: object @@ -2282,21 +2195,17 @@ paths: required: - apiKey type: object - description: 'A set consisting of the new ApiKey object created, together with the initial Revision object.' + description: '' '400': description: bad input parameter security: - BearerAuth: [] - summary: CREATE - Create an API key tags: - config - x-specification-crudl-model: ApiKey - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-001 '/config/admin/apikey/{apiKeyId}': put: - description: UPDATE - Update an API key + summary: UPDATE - Update API key + description: 'This endpoint is used to update an existing API key for accessing endpoints in the consent building block. It can be updated for a specific scope. E.g. Config, Onboard, Audit, Service.' operationId: configUpdateApiKey parameters: - description: Unique ID of an object @@ -2312,7 +2221,7 @@ paths: properties: apiKey: $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/delete/responses/200/content/application~1json/schema/allOf/0' - description: An object of type ApiKey + description: An object of type APIKey required: - apiKey type: object @@ -2331,15 +2240,11 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: UPDATE - Update an API key tags: - config - x-specification-crudl-model: ApiKey - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-002 delete: - description: DELETE - Deletes an API key DataAgreement. + summary: DELETE - Delete API key + description: This endpoint is used to delete an existing API key for accessing endpoints in the consent building block. operationId: configDeletePolicy parameters: - $ref: '#/paths/~1config~1admin~1apikey~1%7BapiKeyId%7D/put/parameters/0' @@ -2398,17 +2303,13 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: DELETE - Deletes an API key tags: - config - x-specification-crudl-model: ApiKey - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-A-004 + x-specification-crudl-model: ApiK /config/privacy-dashboard: get: - deprecated: false - description: Read privacy dashboard + summary: GET - Read privacy dashboard + description: This endpoint is used to read the deployed privacy board for the organiastion as per the data agreement defined in the consent building block. operationId: readPrivacyDashboard responses: '200': @@ -2436,6 +2337,7 @@ paths: - privacydashboard type: object description: OK + deprecated: false security: - BearerAuth: [] tags: @@ -4028,9 +3930,9 @@ paths: - service /audit/admin/logs: get: + summary: LIST - Fetch all organisational logs + description: This endpoint is used to list all logs with pagination for an organisation defined in the consent building block. operationId: auditAdminLogs - tags: - - audit security: - BearerAuth: [] parameters: @@ -4042,8 +3944,6 @@ paths: required: false schema: type: integer - description: LIST - List all organisation admin logs - summary: LIST - List all organisation admin logs responses: '200': content: @@ -4079,9 +3979,12 @@ paths: type: array pagination: $ref: '#/components/schemas/Pagination' + tags: + - audit /audit/consent-records: get: - description: LIST - Fetch all consent records + summary: LIST - Fetch all consent records + description: This endpoint is used to fetch all consent records with pagination for individuals in an organisation defined in the consent building block. operationId: auditDataAgreementRecordsList parameters: - $ref: '#/paths/~1config~1policies/get/parameters/1' @@ -4148,16 +4051,12 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: LIST - Fetch all consent records tags: - audit - x-specification-crudl-model: '' - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: UC-C-PIC-AT-003 '/audit/consent-record/{consentRecordId}': get: - description: READ - Fetch a single consent record + summary: READ - Get consent record + description: This endpoint is used to get a single consent record by ID in an organisation defined in the consent building block. operationId: auditConsentRecordRead parameters: - description: Unique ID of an object @@ -4180,16 +4079,12 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: READ - Fetch a single consent record tags: - audit - x-specification-crudl-model: '' - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: '' /audit/data-agreements: get: - description: LIST - Fetch all data agreements stored in the system + summary: LIST - Fetch all data agreements + description: This endpoint is used to fetch all data agreements defined in the consent building block. operationId: auditDataAgreementList parameters: - $ref: '#/paths/~1config~1policies/get/parameters/1' @@ -4212,16 +4107,12 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: LIST - Fetch all data agreements stored in the system tags: - audit - x-specification-crudl-model: '' - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: 'UC-C-PIC-AT-001, UC-C-PIC-AT-003' '/audit/data-agreement/{dataAgreementId}': get: - description: READ - Fetch a single data agreement. + summary: READ - Get data agreement + description: 'This endpoint is used to fetch a single data agreement for audit purposes, for e.g., by an external third party.' operationId: auditReadRecord parameters: - description: Unique ID of an object @@ -4244,13 +4135,8 @@ paths: description: bad input parameter security: - BearerAuth: [] - summary: READ - Fetch a single data agreement. tags: - audit - x-specification-crudl-model: '' - x-specification-pii-or-sensitive: 'False' - x-specification-scenario: '' - x-specification-usecase: 'UC-C-PIC-AT-001, UC-C-PIC-AT-003' servers: - description: Development server url: 'https://api.bb-consent.dev/v2' @@ -4259,15 +4145,15 @@ servers: - description: Demo server url: 'https://demo-consent-bb-api.igrant.io/v2' tags: - - description: Operations for external auditing systems to query detailed data from the system and subscribe to notifications. + - description: This consists of endpoints for an external auditing systems or for organisational to query consent record from consent building block. name: audit x-tag-expanded: false - - description: Secured operations available to organization API integration + - description: 'This consists of ndpoints available to organisation admins to manage data agreements, data agreement records, consents and consent records. It also provides mechanisms onboard the organisation to consent building block.' name: config x-tag-expanded: false - - description: 'Secured operations for individuals, data consumers and applications to record and verify consent' + - description: 'This consists of endpoints towards individuals, data consumers and applications to view, sign/record their agreement to the processing of personal data. In cases where the data agreement is of legal basis consent and for legitimate interest, the individual can opt-in and opt-out at any stage.' name: service x-tag-expanded: false - - description: 'These are used for onboard the organisation, organisation admin and individual users to the system. It also deals with all authentication and authorisation APIs that can be configured towards external IDPs.' + - description: This consists of endpoints towards organisation admin to onboard to consent building block. It also deals with all authentication and authorisation APIs that can be configured towards external IDPs (e.g. using OpenID Connect). name: onboard x-tag-expanded: false diff --git a/openapi/v2023.11.1/index.yaml b/openapi/v2023.11.1/index.yaml index 4507879..350e8c7 100644 --- a/openapi/v2023.11.1/index.yaml +++ b/openapi/v2023.11.1/index.yaml @@ -193,7 +193,6 @@ paths: /onboard/password/forgot: put: $ref: "./paths/onboardForgotPassword.yaml" - /onboard/admin/login: post: $ref: ./paths/loginOrganisationAdmin.yaml @@ -339,21 +338,26 @@ servers: url: https://demo-consent-bb-api.igrant.io/v2 tags: - description: - Operations for external auditing systems to query detailed data from - the system and subscribe to notifications. + This consists of endpoints for an external auditing systems or for organisational to query + consent record from consent building block. name: audit x-tag-expanded: false - - description: Secured operations available to organization API integration + - description: + This consists of ndpoints available to organisation admins to manage data agreements, + data agreement records, consents and consent records. It also provides mechanisms + onboard the organisation to consent building block. name: config x-tag-expanded: false - description: - Secured operations for individuals, data consumers and applications - to record and verify consent + This consists of endpoints towards individuals, data consumers and applications + to view, sign/record their agreement to the processing of personal data. In cases + where the data agreement is of legal basis consent and for legitimate interest, + the individual can opt-in and opt-out at any stage. name: service x-tag-expanded: false - description: - These are used for onboard the organisation, organisation admin and - individual users to the system. It also deals with all authentication and authorisation - APIs that can be configured towards external IDPs. + This consists of endpoints towards organisation admin to onboard to consent building block. + It also deals with all authentication and authorisation APIs that can be configured + towards external IDPs (e.g. using OpenID Connect). name: onboard x-tag-expanded: false diff --git a/openapi/v2023.11.1/paths/auditAdminLogs.yaml b/openapi/v2023.11.1/paths/auditAdminLogs.yaml index dae3af6..87d5d36 100644 --- a/openapi/v2023.11.1/paths/auditAdminLogs.yaml +++ b/openapi/v2023.11.1/paths/auditAdminLogs.yaml @@ -1,14 +1,14 @@ +summary: LIST - Fetch all organisational logs +description: + This endpoint is used to list all logs with pagination for an + organisation defined in the consent building block. operationId: auditAdminLogs -tags: - - audit security: - BearerAuth: [] parameters: - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" - $ref: "../parameters/logType.yaml" -description: LIST - List all organisation admin logs -summary: LIST - List all organisation admin logs responses: "200": content: @@ -22,3 +22,6 @@ responses: type: array pagination: $ref: "../definitions/Pagination.yaml" +tags: + - audit + diff --git a/openapi/v2023.11.1/paths/auditDataAgreementList.yaml b/openapi/v2023.11.1/paths/auditDataAgreementList.yaml index 529a376..34c8d1d 100644 --- a/openapi/v2023.11.1/paths/auditDataAgreementList.yaml +++ b/openapi/v2023.11.1/paths/auditDataAgreementList.yaml @@ -1,4 +1,7 @@ -description: LIST - Fetch all data agreements stored in the system +summary: LIST - Fetch all data agreements +description: + This endpoint is used to fetch all data agreements defined + in the consent building block. operationId: auditDataAgreementList parameters: - $ref: "../parameters/offset.yaml" @@ -21,10 +24,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: LIST - Fetch all data agreements stored in the system tags: - audit -x-specification-crudl-model: "" -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-AT-001, UC-C-PIC-AT-003 diff --git a/openapi/v2023.11.1/paths/auditDataAgreementRecordRead.yaml b/openapi/v2023.11.1/paths/auditDataAgreementRecordRead.yaml index c23fd90..bb991fd 100644 --- a/openapi/v2023.11.1/paths/auditDataAgreementRecordRead.yaml +++ b/openapi/v2023.11.1/paths/auditDataAgreementRecordRead.yaml @@ -1,4 +1,7 @@ -description: READ - Fetch a single consent record +summary: READ - Get consent record +description: + This endpoint is used to get a single consent record by ID in an + organisation defined in the consent building block. operationId: auditConsentRecordRead parameters: - $ref: "../parameters/consentRecordId.yaml" @@ -16,10 +19,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: READ - Fetch a single consent record tags: - audit -x-specification-crudl-model: "" -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: "" diff --git a/openapi/v2023.11.1/paths/auditDataAgreementRecordsList.yaml b/openapi/v2023.11.1/paths/auditDataAgreementRecordsList.yaml index 3b778e0..5725c8c 100644 --- a/openapi/v2023.11.1/paths/auditDataAgreementRecordsList.yaml +++ b/openapi/v2023.11.1/paths/auditDataAgreementRecordsList.yaml @@ -1,4 +1,7 @@ -description: LIST - Fetch all consent records +summary: LIST - Fetch all consent records +description: + This endpoint is used to fetch all consent records with pagination + for individuals in an organisation defined in the consent building block. operationId: auditDataAgreementRecordsList parameters: - $ref: "../parameters/offset.yaml" @@ -25,10 +28,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: LIST - Fetch all consent records tags: - audit -x-specification-crudl-model: "" -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-AT-003 diff --git a/openapi/v2023.11.1/paths/auditReadDataAgreement.yaml b/openapi/v2023.11.1/paths/auditReadDataAgreement.yaml index 9fddba2..14044e4 100644 --- a/openapi/v2023.11.1/paths/auditReadDataAgreement.yaml +++ b/openapi/v2023.11.1/paths/auditReadDataAgreement.yaml @@ -1,4 +1,7 @@ -description: READ - Fetch a single data agreement. +summary: READ - Get data agreement +description: + This endpoint is used to fetch a single data agreement for audit + purposes, for e.g., by an external third party. operationId: auditReadRecord parameters: - $ref: "../parameters/dataAgreementId.yaml" @@ -16,10 +19,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: READ - Fetch a single data agreement. tags: - - audit -x-specification-crudl-model: "" -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-AT-001, UC-C-PIC-AT-003 + - audit \ No newline at end of file diff --git a/openapi/v2023.11.1/paths/configCreateAgreement.yaml b/openapi/v2023.11.1/paths/configCreateAgreement.yaml index f477d39..2426f47 100644 --- a/openapi/v2023.11.1/paths/configCreateAgreement.yaml +++ b/openapi/v2023.11.1/paths/configCreateAgreement.yaml @@ -1,4 +1,4 @@ -summary: CREATE - Create a data agreement +summary: CREATE - Create data agreement description: | This endpoint creates a data agreement for an organisation. It also returns the latest revision of the created data agreement. @@ -33,7 +33,3 @@ security: - BearerAuth: [] tags: - config -x-specification-crudl-model: DataAgreement -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-A-001 diff --git a/openapi/v2023.11.1/paths/configCreateApikey.yaml b/openapi/v2023.11.1/paths/configCreateApikey.yaml index 8fd30c1..4130a85 100644 --- a/openapi/v2023.11.1/paths/configCreateApikey.yaml +++ b/openapi/v2023.11.1/paths/configCreateApikey.yaml @@ -1,4 +1,8 @@ -description: CREATE - Create an API key +summary: CREATE - Create API key +description: + This endpoint is used to create an API key for accessing endpoints + in the consent building block. It can created for a specific scope. + E.g. Config, Onboard, Audit, Service. operationId: configCreateApikey parameters: [] requestBody: @@ -8,7 +12,7 @@ requestBody: properties: apiKey: $ref: ../definitions/ApiKey.yaml - description: An object of type ApiKey + description: An object of type APIKey required: - apiKey type: object @@ -25,16 +29,10 @@ responses: required: - apiKey type: object - description: A set consisting of the new ApiKey object created, together with - the initial Revision object. + description: "" '400': description: bad input parameter security: - BearerAuth: [] -summary: CREATE - Create an API key tags: -- config -x-specification-crudl-model: ApiKey -x-specification-pii-or-sensitive: 'False' -x-specification-scenario: '' -x-specification-usecase: UC-C-PIC-A-001 +- config \ No newline at end of file diff --git a/openapi/v2023.11.1/paths/configCreateIdp.yaml b/openapi/v2023.11.1/paths/configCreateIdp.yaml index cc55c50..01d37ee 100644 --- a/openapi/v2023.11.1/paths/configCreateIdp.yaml +++ b/openapi/v2023.11.1/paths/configCreateIdp.yaml @@ -1,4 +1,7 @@ -description: CREATE - Create an IDP +summary: CREATE - Create IDP +description: + This endpoint is used to configure an IdP (e.g. OIDC based) used by + the organisation in the consent building block. operationId: configCreateIdp parameters: [] requestBody: @@ -26,10 +29,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: CREATE - Create an IDP tags: - - config -x-specification-crudl-model: IDP -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: "" + - config \ No newline at end of file diff --git a/openapi/v2023.11.1/paths/configCreateIndividual.yaml b/openapi/v2023.11.1/paths/configCreateIndividual.yaml index eab2f94..48b998b 100644 --- a/openapi/v2023.11.1/paths/configCreateIndividual.yaml +++ b/openapi/v2023.11.1/paths/configCreateIndividual.yaml @@ -1,17 +1,11 @@ -tags: - - config -summary: "CREATE - Create an individual" +summary: CREATE - Create individual +description: + This endpoint creates an individual for an organisation in the + consent block system. This is used to onboard existing or new users. 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" responses: "200": description: "" - content: application/json: schema: @@ -27,7 +21,6 @@ responses: description: bad input parameter security: - BearerAuth: [] - requestBody: content: application/json: @@ -39,6 +32,7 @@ requestBody: - $ref: "../definitions/Individual.yaml" - $ref: "../definitions/IndividualExtras.yaml" description: An object of type Individual - required: - individual +tags: + - config diff --git a/openapi/v2023.11.1/paths/configCreatePolicy.yaml b/openapi/v2023.11.1/paths/configCreatePolicy.yaml index bca552f..cb9d198 100644 --- a/openapi/v2023.11.1/paths/configCreatePolicy.yaml +++ b/openapi/v2023.11.1/paths/configCreatePolicy.yaml @@ -1,4 +1,7 @@ -description: CREATE - Create a new policy and returned together with revision +summary: CREATE - Create data policy +description: + This endpoint creates a new data policy that can be reused as global + parameter across all newly crearted data agremements. operationId: configCreatePolicy parameters: [] requestBody: @@ -29,10 +32,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: CREATE - Create policy tags: - config -x-specification-crudl-model: Policy -x-specification-pii-or-sensitive: 'False' -x-specification-scenario: '' -x-specification-usecase: UC-C-PIC-A-001 diff --git a/openapi/v2023.11.1/paths/configCreateWebhook.yaml b/openapi/v2023.11.1/paths/configCreateWebhook.yaml index 27d0f57..62adc33 100644 --- a/openapi/v2023.11.1/paths/configCreateWebhook.yaml +++ b/openapi/v2023.11.1/paths/configCreateWebhook.yaml @@ -1,8 +1,9 @@ -operationId: configCreateWebhook + summary: CREATE - Create webhook -description: Create webhook -tags: - - config +description: + This endpoint is used to create a webhook to trigger events from + consent building block to an external IT system. +operationId: configCreateWebhook requestBody: content: application/json: @@ -25,3 +26,5 @@ responses: deprecated: false security: - BearerAuth: [] +tags: + - config diff --git a/openapi/v2023.11.1/paths/configDeleteAgreement.yaml b/openapi/v2023.11.1/paths/configDeleteAgreement.yaml index 97cc725..e43a357 100644 --- a/openapi/v2023.11.1/paths/configDeleteAgreement.yaml +++ b/openapi/v2023.11.1/paths/configDeleteAgreement.yaml @@ -1,4 +1,7 @@ -description: DELETE - Delete a data agreement +summary: DELETE - Delete data agreement +description: + This endpoint allows the admin to delete all revisions of a chosen + data agreement defined earlier in an organisation. operationId: configDeleteAgreement parameters: - description: Unique ID of an object @@ -18,10 +21,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: DELETE - Delete data agreement tags: - config -x-specification-crudl-model: DataAgreement -x-specification-pii-or-sensitive: 'False' -x-specification-scenario: '' -x-specification-usecase: UC-C-PIC-A-004 diff --git a/openapi/v2023.11.1/paths/configDeleteApiKey.yaml b/openapi/v2023.11.1/paths/configDeleteApiKey.yaml index 6d5faff..5e4f2ea 100644 --- a/openapi/v2023.11.1/paths/configDeleteApiKey.yaml +++ b/openapi/v2023.11.1/paths/configDeleteApiKey.yaml @@ -1,5 +1,7 @@ -description: DELETE - Deletes an API key - DataAgreement. +summary: DELETE - Delete API key +description: + This endpoint is used to delete an existing API key for accessing + endpoints in the consent building block. operationId: configDeletePolicy parameters: - $ref: "../parameters/apiKeyId.yaml" @@ -16,10 +18,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: DELETE - Deletes an API key tags: - config -x-specification-crudl-model: ApiKey -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-A-004 +x-specification-crudl-model: ApiK diff --git a/openapi/v2023.11.1/paths/configDeletePolicy.yaml b/openapi/v2023.11.1/paths/configDeletePolicy.yaml index f0bcad0..247320f 100644 --- a/openapi/v2023.11.1/paths/configDeletePolicy.yaml +++ b/openapi/v2023.11.1/paths/configDeletePolicy.yaml @@ -1,6 +1,6 @@ -description: DELETE - Deletes an existing policy, returning the updated version - and a new revision. Deleting a policy is not possible if it's associated with active - DataAgreement. +summary: DELETE - Delete data policy +description: + This endpoint is used to delete an existing data policy. operationId: configDeletePolicy parameters: - description: Unique ID of an object @@ -20,10 +20,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: DELETE - Deletes policy tags: - config -x-specification-crudl-model: Policy -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-A-004 diff --git a/openapi/v2023.11.1/paths/configDeleteWebhook.yaml b/openapi/v2023.11.1/paths/configDeleteWebhook.yaml index aedc1c5..8280e56 100644 --- a/openapi/v2023.11.1/paths/configDeleteWebhook.yaml +++ b/openapi/v2023.11.1/paths/configDeleteWebhook.yaml @@ -1,8 +1,8 @@ -operationId: configDeleteWebhook summary: DELETE - Delete webhook -description: Delete webhook -tags: - - config +description: + This endpoint is used to delete an existing webhook that was defined + to trigger events from the consent building block to an external IT system. +operationId: configDeleteWebhook parameters: - name: webhookId in: path @@ -22,4 +22,6 @@ responses: $ref: "../definitions/Webhook.yaml" deprecated: false security: - - BearerAuth: [] \ No newline at end of file + - BearerAuth: [] +tags: + - config \ No newline at end of file diff --git a/openapi/v2023.11.1/paths/configListAgreement.yaml b/openapi/v2023.11.1/paths/configListAgreement.yaml index 2cf9f7e..56282b4 100644 --- a/openapi/v2023.11.1/paths/configListAgreement.yaml +++ b/openapi/v2023.11.1/paths/configListAgreement.yaml @@ -1,4 +1,7 @@ -description: LIST - Fetch all data agreements +summary: LIST - List all data agreements +description: + This endpoint allows the admin to read all data agreements and their + revisions defined earlier in an organisation. operationId: configListAgreement parameters: - $ref: "../parameters/revisionId.yaml" @@ -23,10 +26,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: LIST - List all data agreements tags: - - config -x-specification-crudl-model: DataAgreement -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-A-003 + - config \ No newline at end of file diff --git a/openapi/v2023.11.1/paths/configListAgreementRevisions.yaml b/openapi/v2023.11.1/paths/configListAgreementRevisions.yaml index 69eabef..6c038ba 100644 --- a/openapi/v2023.11.1/paths/configListAgreementRevisions.yaml +++ b/openapi/v2023.11.1/paths/configListAgreementRevisions.yaml @@ -1,4 +1,6 @@ -description: LIST - Returns all the revisions for the data agreement +summary: LIST - List data agreement revisions +description: + This endpoint lists all revisions of a data agreement defined earlier in an organisation. operationId: configListAgreementRevisions parameters: - $ref: "../parameters/dataAgreementId.yaml" @@ -24,10 +26,8 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: LIST - List all data agreement revisions tags: - config x-specification-crudl-model: Revision x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-A-003 +x-specification-scenario: "" \ No newline at end of file diff --git a/openapi/v2023.11.1/paths/configListAllRecentWebhookDeliveries.yaml b/openapi/v2023.11.1/paths/configListAllRecentWebhookDeliveries.yaml index 274c00a..203b546 100644 --- a/openapi/v2023.11.1/paths/configListAllRecentWebhookDeliveries.yaml +++ b/openapi/v2023.11.1/paths/configListAllRecentWebhookDeliveries.yaml @@ -1,8 +1,8 @@ +summary: LIST - List all webhook deliveries +description: + This endpoint is used to read recent webhook deliveries with pagination + from the consent building block that were sent to an external IT system. operationId: configListAllRecentWebhookDeliveries -summary: Get recent webhook deliveries -description: Get recent webhook deliveries -tags: - - config parameters: - name: webhookId in: path @@ -34,3 +34,5 @@ responses: deprecated: false security: - BearerAuth: [] +tags: + - config diff --git a/openapi/v2023.11.1/paths/configListApiKey.yaml b/openapi/v2023.11.1/paths/configListApiKey.yaml index dbf357a..1f98470 100644 --- a/openapi/v2023.11.1/paths/configListApiKey.yaml +++ b/openapi/v2023.11.1/paths/configListApiKey.yaml @@ -1,4 +1,7 @@ -description: LIST - List all api keys +summary: LIST - List all api keys +description: + This endpoint lists all API keys created in consent building block + with pagination. operationId: configListApiKey parameters: - $ref: "../parameters/offset.yaml" @@ -22,10 +25,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: LIST - List all api keys tags: - config -x-specification-crudl-model: ApiKey -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/configListDataAttribute.yaml b/openapi/v2023.11.1/paths/configListDataAttribute.yaml index 6b851f6..a56e1e0 100644 --- a/openapi/v2023.11.1/paths/configListDataAttribute.yaml +++ b/openapi/v2023.11.1/paths/configListDataAttribute.yaml @@ -1,4 +1,7 @@ -description: LIST - Fetch all data attributes +summary: LIST - List all data attributes +description: + This endpoint reads all data attrinbutes defined in a data agreement + with pagination. operationId: configListDataAttribute parameters: - $ref: "../parameters/revisionId.yaml" @@ -28,10 +31,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: LIST - List all data attributes tags: - - config -x-specification-crudl-model: DataAttribute -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-A-003 + - config \ No newline at end of file diff --git a/openapi/v2023.11.1/paths/configListDataAttributesForDataAgreement.yaml b/openapi/v2023.11.1/paths/configListDataAttributesForDataAgreement.yaml index ba2b213..afca830 100644 --- a/openapi/v2023.11.1/paths/configListDataAttributesForDataAgreement.yaml +++ b/openapi/v2023.11.1/paths/configListDataAttributesForDataAgreement.yaml @@ -1,4 +1,6 @@ -description: READ - Read all data attributes for the data agreement +summary: READ - Read data attributes +description: + This endpoint reads all data attrinbutes defined in a data agreement. operationId: configListDataAttribute parameters: - $ref: "../parameters/dataAgreementId.yaml" @@ -27,10 +29,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: READ - Read all data attributes for the data agreement tags: - - config -x-specification-crudl-model: DataAttribute -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-A-003 + - config \ No newline at end of file diff --git a/openapi/v2023.11.1/paths/configListIdp.yaml b/openapi/v2023.11.1/paths/configListIdp.yaml index 8154aba..29379dc 100644 --- a/openapi/v2023.11.1/paths/configListIdp.yaml +++ b/openapi/v2023.11.1/paths/configListIdp.yaml @@ -1,16 +1,11 @@ -tags: - - config -summary: "LIST - List IDP" +summary: LIST - List all IdPs +description: + This endpoint read all IdPs configured for the organisation in + the consent building block. operationId: "configListIdp" -description: "LIST - List IDP" parameters: - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" - -x-specification-usecase: "" -x-specification-scenario: "" -x-specification-pii-or-sensitive: "True" -x-specification-crudl-model: "IDP" responses: "200": description: "" @@ -32,3 +27,5 @@ responses: description: bad input parameter security: - BearerAuth: [] +tags: + - config diff --git a/openapi/v2023.11.1/paths/configListIndividuals.yaml b/openapi/v2023.11.1/paths/configListIndividuals.yaml index e463a38..40a64fa 100644 --- a/openapi/v2023.11.1/paths/configListIndividuals.yaml +++ b/openapi/v2023.11.1/paths/configListIndividuals.yaml @@ -1,16 +1,11 @@ -tags: - - config -summary: "LIST - List all individuals" +summary: LIST - List all individuals +description: + This endpoint is used to list all individuals in the organisation + defined in the consent building block. operationId: "configListIndividuals" -description: "LIST - lists individuals in the system" parameters: - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" - -x-specification-usecase: "" -x-specification-scenario: "" -x-specification-pii-or-sensitive: "True" -x-specification-crudl-model: "Individual" responses: "200": description: "" @@ -28,8 +23,9 @@ responses: - $ref: "../definitions/IndividualExtras.yaml" pagination: $ref: "../definitions/Pagination.yaml" - "400": description: bad input parameter security: - BearerAuth: [] +tags: + - config \ No newline at end of file diff --git a/openapi/v2023.11.1/paths/configListPolicy.yaml b/openapi/v2023.11.1/paths/configListPolicy.yaml index 71aead9..bfe0087 100644 --- a/openapi/v2023.11.1/paths/configListPolicy.yaml +++ b/openapi/v2023.11.1/paths/configListPolicy.yaml @@ -1,4 +1,6 @@ -description: LIST - Fetch all policies +summary: LIST - List all data policies +description: + This endpoint reads all data policies defined in the consent building block. operationId: configListPolicy parameters: - description: An object with id revisionId @@ -27,10 +29,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: LIST - List all policies tags: - config -x-specification-crudl-model: Policy -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-A-001, UC-C-PIC-A-002 diff --git a/openapi/v2023.11.1/paths/configListPolicyRevisions.yaml b/openapi/v2023.11.1/paths/configListPolicyRevisions.yaml index a78ea58..39278fe 100644 --- a/openapi/v2023.11.1/paths/configListPolicyRevisions.yaml +++ b/openapi/v2023.11.1/paths/configListPolicyRevisions.yaml @@ -1,4 +1,7 @@ -description: LIST - Returns all the revisions for the policy +summary: LIST - List data policy revisions +description: + This endpoint reads all data policy revisions defined in the + consent building block. operationId: configListPolicyRevisions parameters: - description: Unique ID of an object @@ -29,10 +32,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: LIST - List all policy revisions tags: - config -x-specification-crudl-model: Revision -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/configListWebhooks.yaml b/openapi/v2023.11.1/paths/configListWebhooks.yaml index a65f140..978f67a 100644 --- a/openapi/v2023.11.1/paths/configListWebhooks.yaml +++ b/openapi/v2023.11.1/paths/configListWebhooks.yaml @@ -1,8 +1,8 @@ -operationId: configListWebhooks summary: LIST - List all webhooks -description: Get all webhooks for an organisation -tags: - - config +description: + This endpoint is used to get all webhooks that was defined to + trigger events from the consent building block to an external IT system. +operationId: configListWebhooks parameters: - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" @@ -25,3 +25,5 @@ responses: deprecated: false security: - BearerAuth: [] +tags: + - config diff --git a/openapi/v2023.11.1/paths/configPingWebhook.yaml b/openapi/v2023.11.1/paths/configPingWebhook.yaml index 4158aeb..90d5725 100644 --- a/openapi/v2023.11.1/paths/configPingWebhook.yaml +++ b/openapi/v2023.11.1/paths/configPingWebhook.yaml @@ -1,8 +1,8 @@ -operationId: configPingWebhook summary: Ping webhook -description: Ping webhook -tags: - - config +description: + This endpoint is used to ping a webhook that was defined to trigger + events from the consent building block to an external IT system. +operationId: configPingWebhook parameters: - name: webhookId in: path @@ -23,3 +23,5 @@ responses: deprecated: false security: - BearerAuth: [] +tags: + - config diff --git a/openapi/v2023.11.1/paths/configReadAgreement.yaml b/openapi/v2023.11.1/paths/configReadAgreement.yaml index e6d579c..8750788 100644 --- a/openapi/v2023.11.1/paths/configReadAgreement.yaml +++ b/openapi/v2023.11.1/paths/configReadAgreement.yaml @@ -1,4 +1,7 @@ -description: READ - Fetch the latest version of a data agreement +summary: READ - Read data agreement +description: | + This endpoint allows the admin to view the latest data agreement defined + earlier in an organisation. It also returns the latest revision number. operationId: configReadAgreement parameters: - description: Unique ID of an object @@ -23,10 +26,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: READ - Read data agreement tags: - config -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/configReadIdp.yaml b/openapi/v2023.11.1/paths/configReadIdp.yaml index 49d13c1..27e9938 100644 --- a/openapi/v2023.11.1/paths/configReadIdp.yaml +++ b/openapi/v2023.11.1/paths/configReadIdp.yaml @@ -1,4 +1,7 @@ -description: READ - Read an IDP +summary: READ - Read IdP details +description: + This endpoint is used to read the IdP details configured by the + organisation in the consent building block. operationId: configReadIdp parameters: - $ref: "../parameters/idpId.yaml" @@ -16,10 +19,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: READ - Read an IDP tags: - config -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/configReadIndividual.yaml b/openapi/v2023.11.1/paths/configReadIndividual.yaml index 4f323d1..8b7b0f5 100644 --- a/openapi/v2023.11.1/paths/configReadIndividual.yaml +++ b/openapi/v2023.11.1/paths/configReadIndividual.yaml @@ -1,8 +1,8 @@ -tags: - - config -summary: "READ - Read an individual" +summary: READ - Read individual +description: + This endpoint is used to read an individual info defined for an + organisation in the consent building block. operationId: "configReadIndividual" -description: "READ - Fetch an Individual in the Consent system" parameters: - in: path name: "individualId" @@ -10,11 +10,6 @@ parameters: required: true schema: type: string - -x-specification-usecase: "" -x-specification-scenario: "" -x-specification-pii-or-sensitive: "True" -x-specification-crudl-model: "Individual" responses: "200": description: "" @@ -28,8 +23,9 @@ responses: allOf: - $ref: "../definitions/Individual.yaml" - $ref: "../definitions/IndividualExtras.yaml" - "400": description: bad input parameter security: - BearerAuth: [] +tags: + - config \ No newline at end of file diff --git a/openapi/v2023.11.1/paths/configReadPolicy.yaml b/openapi/v2023.11.1/paths/configReadPolicy.yaml index e75d98a..5f22b75 100644 --- a/openapi/v2023.11.1/paths/configReadPolicy.yaml +++ b/openapi/v2023.11.1/paths/configReadPolicy.yaml @@ -1,5 +1,6 @@ -description: READ - Fetch a policy + latest revision. If a policy filter is supplied - and contains a `revisionId`, then this specific revision is returned. +summary: READ - Read data policy +description: READ - + This endpoint reads a data policy with the latest revision info. operationId: configReadPolicy parameters: - description: Unique ID of an object @@ -30,10 +31,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: READ - Read policy tags: - config -x-specification-crudl-model: Policy -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/configReadPrivacyDashboard.yaml b/openapi/v2023.11.1/paths/configReadPrivacyDashboard.yaml index 09769b4..aabef63 100644 --- a/openapi/v2023.11.1/paths/configReadPrivacyDashboard.yaml +++ b/openapi/v2023.11.1/paths/configReadPrivacyDashboard.yaml @@ -1,5 +1,7 @@ -deprecated: false -description: Read privacy dashboard +summary: GET - Read privacy dashboard +description: + This endpoint is used to read the deployed privacy board for the organiastion + as per the data agreement defined in the consent building block. operationId: readPrivacyDashboard responses: '200': @@ -27,6 +29,7 @@ responses: - privacydashboard type: object description: OK +deprecated: false security: - BearerAuth: [] tags: diff --git a/openapi/v2023.11.1/paths/configReadRecentWebhookDelivery.yaml b/openapi/v2023.11.1/paths/configReadRecentWebhookDelivery.yaml index d66f741..6d88f88 100644 --- a/openapi/v2023.11.1/paths/configReadRecentWebhookDelivery.yaml +++ b/openapi/v2023.11.1/paths/configReadRecentWebhookDelivery.yaml @@ -1,8 +1,8 @@ +summary: READ - Read webhook delivery +description: + This endpint is used to get the recent webhook deliveries for a + webhook defined in the consent building block. operationId: configReadRecentWebhookDelivery -summary: Get recent webhook delivery by ID -description: Get recent webhook delivery by ID -tags: - - config parameters: - name: webhookId in: path @@ -34,4 +34,6 @@ responses: description: WebhookDelivery deprecated: false security: - - BearerAuth: [] \ No newline at end of file + - BearerAuth: [] +tags: + - config diff --git a/openapi/v2023.11.1/paths/configReadWebhook.yaml b/openapi/v2023.11.1/paths/configReadWebhook.yaml index 60e9d24..a2d6f3e 100644 --- a/openapi/v2023.11.1/paths/configReadWebhook.yaml +++ b/openapi/v2023.11.1/paths/configReadWebhook.yaml @@ -1,8 +1,8 @@ -operationId: configReadWebhook summary: READ - Read webhook -description: Get a webhook by ID -tags: - - config +description: + This endpoint is used to read a webhook to by its ID defined in + the consent building block. +operationId: configReadWebhook parameters: - name: webhookId in: path @@ -22,4 +22,6 @@ responses: $ref: "../definitions/Webhook.yaml" deprecated: false security: - - BearerAuth: [] \ No newline at end of file + - BearerAuth: [] +tags: + - config diff --git a/openapi/v2023.11.1/paths/configReadWebhookEventTypes.yaml b/openapi/v2023.11.1/paths/configReadWebhookEventTypes.yaml index 9e0db95..e6855e3 100644 --- a/openapi/v2023.11.1/paths/configReadWebhookEventTypes.yaml +++ b/openapi/v2023.11.1/paths/configReadWebhookEventTypes.yaml @@ -1,8 +1,8 @@ +summary: READ - Read webhook event types +description: + This endpoint is used to list all webhook event types defined in + the consent building block. operationId: configReadWebhookEventTypes -description: Get webhook event types -summary: LIST - List all webhook event types -tags: - - config responses: '200': description: OK @@ -19,4 +19,6 @@ responses: $ref: "../definitions/WebhookEventType.yaml" deprecated: false security: - - BearerAuth: [] \ No newline at end of file + - BearerAuth: [] +tags: + - config \ No newline at end of file diff --git a/openapi/v2023.11.1/paths/configRedeliverWebhook.yaml b/openapi/v2023.11.1/paths/configRedeliverWebhook.yaml index 0bbd4b0..3f50c38 100644 --- a/openapi/v2023.11.1/paths/configRedeliverWebhook.yaml +++ b/openapi/v2023.11.1/paths/configRedeliverWebhook.yaml @@ -1,8 +1,7 @@ +summary: Re-deliver a webhook event +description: + This endpoint is used to re-deliver a webhook payload by delivery ID. operationId: configRedeliverWebhook -summary: Redeliver a webhook payload by delivery ID -description: Redeliver a webhook payload by delivery ID -tags: - - config parameters: - name: organizationId in: path @@ -28,4 +27,6 @@ responses: content: {} deprecated: false security: - - BearerAuth: [] \ No newline at end of file + - BearerAuth: [] +tags: + - config diff --git a/openapi/v2023.11.1/paths/configUpdateAgreement.yaml b/openapi/v2023.11.1/paths/configUpdateAgreement.yaml index 2ed74af..f670e15 100644 --- a/openapi/v2023.11.1/paths/configUpdateAgreement.yaml +++ b/openapi/v2023.11.1/paths/configUpdateAgreement.yaml @@ -1,4 +1,7 @@ -description: UPDATE - Update an existing data agreement and returned together with revision +summary: UPDATE - Update data agreement +description: + This endpoint allows the admin to update the latest data agreement defined + earlier in an organisation. It also returns the updated revision number. operationId: configUpdateAgreement parameters: - description: Unique ID of an object @@ -34,10 +37,6 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: UPDATE - Update data agreement + tags: - config -x-specification-crudl-model: DataAgreement -x-specification-pii-or-sensitive: 'False' -x-specification-scenario: '' -x-specification-usecase: UC-C-PIC-A-002 diff --git a/openapi/v2023.11.1/paths/configUpdateApiKey.yaml b/openapi/v2023.11.1/paths/configUpdateApiKey.yaml index 81e72cf..dcb8fdc 100644 --- a/openapi/v2023.11.1/paths/configUpdateApiKey.yaml +++ b/openapi/v2023.11.1/paths/configUpdateApiKey.yaml @@ -1,4 +1,8 @@ -description: UPDATE - Update an API key +summary: UPDATE - Update API key +description: + This endpoint is used to update an existing API key for accessing endpoints + in the consent building block. It can be updated for a specific scope. + E.g. Config, Onboard, Audit, Service. operationId: configUpdateApiKey parameters: - $ref: "../parameters/apiKeyId.yaml" @@ -9,7 +13,7 @@ requestBody: properties: apiKey: $ref: ../definitions/ApiKey.yaml - description: An object of type ApiKey + description: An object of type APIKey required: - apiKey type: object @@ -28,10 +32,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: UPDATE - Update an API key tags: - config -x-specification-crudl-model: ApiKey -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-A-002 diff --git a/openapi/v2023.11.1/paths/configUpdateDataAttribute.yaml b/openapi/v2023.11.1/paths/configUpdateDataAttribute.yaml index 10eb237..12724c6 100644 --- a/openapi/v2023.11.1/paths/configUpdateDataAttribute.yaml +++ b/openapi/v2023.11.1/paths/configUpdateDataAttribute.yaml @@ -1,4 +1,7 @@ -description: UPDATE - Update an existing data attribute and returned together with revision +summary: UPDATE - Update data attribute +description: + This endpoint updates an existing data attribute defined in a data agreement. + If updated, the associated data agreement revision is incremented automatically. operationId: configUpdateDataAttribute parameters: - $ref: "../parameters/dataAttributeId.yaml" @@ -27,10 +30,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: UPDATE - Update data attribute tags: - config -x-specification-crudl-model: DataAttribute -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-A-002 diff --git a/openapi/v2023.11.1/paths/configUpdateIndividual.yaml b/openapi/v2023.11.1/paths/configUpdateIndividual.yaml index 4941c02..62ef3f8 100644 --- a/openapi/v2023.11.1/paths/configUpdateIndividual.yaml +++ b/openapi/v2023.11.1/paths/configUpdateIndividual.yaml @@ -1,8 +1,8 @@ -tags: - - config -summary: "UPDATE - Update an individual" +summary: UPDATE - Update individual +description: + This endpoint is used to udpated an individual for an organisation + defined in the consent building block. operationId: "configUpdateIndividual" -description: "UPDATE - Updates an Individual in the Consent system" parameters: - in: path name: "individualId" @@ -10,11 +10,6 @@ parameters: required: true schema: type: string - -x-specification-usecase: "" -x-specification-scenario: "" -x-specification-pii-or-sensitive: "True" -x-specification-crudl-model: "Individual" responses: '200': description: "" @@ -28,12 +23,10 @@ responses: allOf: - $ref: "../definitions/Individual.yaml" - $ref: "../definitions/IndividualExtras.yaml" - '400': description: bad input parameter security: - BearerAuth: [] - requestBody: content: application/json: @@ -47,4 +40,6 @@ requestBody: description: An object of type Individual required: - - individual \ No newline at end of file + - individual +tags: + - config \ No newline at end of file diff --git a/openapi/v2023.11.1/paths/configUpdatePolicy.yaml b/openapi/v2023.11.1/paths/configUpdatePolicy.yaml index cbbc6c6..e86ffeb 100644 --- a/openapi/v2023.11.1/paths/configUpdatePolicy.yaml +++ b/openapi/v2023.11.1/paths/configUpdatePolicy.yaml @@ -1,6 +1,8 @@ -description: UPDATE - Update an existing policy, returning the updated version - and a new revision. Updating a Policy does not affect existing references in DataAgreement, - the new revision should be specified for DataAgreement. +summary: UPDATE - Update data policy +description: + This endpoint is used to update and existing data policy. It updates + the existing and returns the updated version info. Updating a data + policy does not affect existing data agreements. operationId: configUpdatePolicy parameters: - description: Unique ID of an object @@ -36,10 +38,5 @@ responses: description: bad input parameter security: - BearerAuth: [] -summary: UPDATE - Update policy tags: - - config -x-specification-crudl-model: Policy -x-specification-pii-or-sensitive: "False" -x-specification-scenario: "" -x-specification-usecase: UC-C-PIC-A-002 + - config \ No newline at end of file diff --git a/openapi/v2023.11.1/paths/configUpdateWebhook.yaml b/openapi/v2023.11.1/paths/configUpdateWebhook.yaml index b59b356..0e244c5 100644 --- a/openapi/v2023.11.1/paths/configUpdateWebhook.yaml +++ b/openapi/v2023.11.1/paths/configUpdateWebhook.yaml @@ -1,8 +1,8 @@ -operationId: configUpdateWebhook summary: UPDATE - Update webhook -description: UPDATE - Update webhook -tags: - - config +description: + This endpoint is used to update an existing webhook to + trigger events from consent building block to an external IT system. +operationId: configUpdateWebhook parameters: - name: webhookId in: path @@ -31,4 +31,6 @@ responses: $ref: "../definitions/Webhook.yaml" deprecated: false security: - - BearerAuth: [] \ No newline at end of file + - BearerAuth: [] +tags: + - config diff --git a/openapi/v2023.11.1/paths/configUploadIndividuals.yaml b/openapi/v2023.11.1/paths/configUploadIndividuals.yaml index b2270ce..3b8dde4 100644 --- a/openapi/v2023.11.1/paths/configUploadIndividuals.yaml +++ b/openapi/v2023.11.1/paths/configUploadIndividuals.yaml @@ -1,6 +1,7 @@ -deprecated: false -description: CREATE - Create individuals in bulk from CSV file -summary: CREATE - Create individuals in bulk from CSV file +summary: CREATE - Create individual(s) via csv +description: + This endpoint is used to onboard existing individual users defined + in the organisation to consent building block using a .csv file. operationId: configUploadIndividuals requestBody: content: @@ -20,5 +21,6 @@ responses: content: {} security: - BearerAuth: [] +deprecated: false tags: - config diff --git a/openapi/v2023.11.1/paths/getWebhookPayloadContentTypes.yaml b/openapi/v2023.11.1/paths/getWebhookPayloadContentTypes.yaml index 7162ccc..b593f67 100644 --- a/openapi/v2023.11.1/paths/getWebhookPayloadContentTypes.yaml +++ b/openapi/v2023.11.1/paths/getWebhookPayloadContentTypes.yaml @@ -1,8 +1,7 @@ +summary: LIST - List all webhook content types +description: + This endpoint is used to get webhook content types. operationId: getWebhookPayloadContentTypes.yaml -summary: LIST - List all webhook payload content types -description: Get webhook payload content types -tags: - - config responses: '200': description: OK @@ -22,4 +21,6 @@ responses: - application/x-www-form-urlencoded deprecated: false security: - - BearerAuth: [] \ No newline at end of file + - BearerAuth: [] +tags: + - config \ No newline at end of file