Upd: descriptions and summary

Signed-off-by: George J Padayatti <[email protected]>

openapi/v2023.8.2/index.yaml

@@ -112,7 +112,7 @@ paths:
   /service/individual:
     post:
       $ref: ./paths/serviceIndividualCreate.yaml
-  /service/individual/record:
+  /service/individual/data-agreement-records:
     delete:
       $ref: ./paths/serviceDeleteAllRecords.yaml
     get:
@@ -149,14 +149,9 @@ paths:
   /service/individuals:
     get:
       $ref: ./paths/serviceIndividualList.yaml
-    post:
-      $ref: ./paths/serviceIndividualListFilter.yaml
   /service/policy/{policyId}:
     get:
       $ref: ./paths/servicePolicyRead.yaml
-  /service/purpose/{purposeId}:
-    get:
-      $ref: ./paths/serviceAgreementPurposeRead.yaml
   /service/verification/data-agreement/{dataAgreementId}:
     get:
       $ref: ./paths/serviceVerificationAgreementConsentRecordRead.yaml

openapi/v2023.8.2/paths/auditAgreementList.yaml

@@ -1,4 +1,4 @@
-description: LIST - fetch all data agreements stored in the system
+description: LIST - Fetch all data agreements stored in the system
 operationId: auditAgreementList
 parameters:
   - description:
@@ -42,7 +42,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: LIST - fetch all data agreements stored in the system
+summary: LIST - Fetch all data agreements stored in the system
 tags:
   - auditor
 x-specification-crudl-model: ""

openapi/v2023.8.2/paths/auditConsentRecordList.yaml

@@ -1,4 +1,4 @@
-description: LIST - fetch all consent records
+description: LIST - Fetch all consent records
 operationId: auditConsentRecordList
 parameters:
 - description: Requested index for start of resources to be provided in response requested
@@ -40,7 +40,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: LIST - fetch all consent records
+summary: LIST - Fetch all consent records
 tags:
 - auditor
 x-specification-crudl-model: ''

openapi/v2023.8.2/paths/auditConsentRecordRead.yaml

@@ -1,4 +1,4 @@
-description: READ - fetch a single data agreement record
+description: READ - Fetch a single data agreement record
 operationId: auditConsentRecordRead
 parameters:
   - description: Unique ID of an object
@@ -18,7 +18,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: READ - fetch a single data agreement record
+summary: READ - Fetch a single data agreement record
 tags:
   - auditor
 x-specification-crudl-model: ""

openapi/v2023.8.2/paths/auditReadRecord.yaml

@@ -1,4 +1,4 @@
-description: READ - fetch a single data agreement.
+description: READ - Fetch a single data agreement.
 operationId: auditReadRecord
 parameters:
 - description: Unique ID of an object
@@ -18,7 +18,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: READ - fetch a single data agreement.
+summary: READ - Fetch a single data agreement.
 tags:
 - auditor
 x-specification-crudl-model: ''

openapi/v2023.8.2/paths/configCreateAgreement.yaml

@@ -1,4 +1,4 @@
-description: CREATE - a new data agreement and returned together with revision
+description: CREATE - Create a new data agreement and returned together with revision
 operationId: configCreateAgreement
 parameters: []
 requestBody:
@@ -27,7 +27,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: CREATE - a new data agreement and returned together with revision
+summary: CREATE - Create a new data agreement and returned together with revision
 tags:
   - config
 x-specification-crudl-model: Agreement

openapi/v2023.8.2/paths/configCreatePolicy.yaml

@@ -1,4 +1,4 @@
-description: CREATE - a new policy and returned together with revision
+description: CREATE - Create a new policy and returned together with revision
 operationId: configCreatePolicy
 parameters: []
 requestBody:
@@ -28,7 +28,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: CREATE - a new policy and returned together with revision
+summary: CREATE - Create a new policy and returned together with revision
 tags:
 - config
 x-specification-crudl-model: Policy

openapi/v2023.8.2/paths/configDeleteAgreement.yaml

@@ -1,4 +1,4 @@
-description: DELETE - a data agreement
+description: DELETE - Delete a data agreement
 operationId: configDeleteAgreement
 parameters:
 - description: Unique ID of an object
@@ -18,7 +18,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: DELETE - a data agreement
+summary: DELETE - Delete a data agreement
 tags:
 - config
 x-specification-crudl-model: Agreement

openapi/v2023.8.2/paths/configDeletePolicy.yaml

@@ -20,7 +20,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: DELETE - an existing policy
+summary: DELETE - Deletes an existing policy
 tags:
   - config
 x-specification-crudl-model: Policy

openapi/v2023.8.2/paths/configListAgreement.yaml

@@ -1,38 +1,40 @@
-description: LIST - fetch all data agreements
+description: LIST - Fetch all data agreements
 operationId: configListAgreement
 parameters:
-- description: Requested index for start of resources to be provided in response requested
-    by client
-  in: query
-  name: offset
-  required: false
-  schema:
-    type: integer
-- description: Requested number of resources to be provided in response requested
-    by client
-  in: query
-  name: limit
-  required: false
-  schema:
-    type: integer
+  - description:
+      Requested index for start of resources to be provided in response requested
+      by client
+    in: query
+    name: offset
+    required: false
+    schema:
+      type: integer
+  - description:
+      Requested number of resources to be provided in response requested
+      by client
+    in: query
+    name: limit
+    required: false
+    schema:
+      type: integer
 responses:
-  '200':
+  "200":
     content:
       application/json:
         schema:
           items:
             oneOf:
-            - $ref: ../definitions/Agreement.yaml
+              - $ref: ../definitions/Agreement.yaml
           type: array
-    description: ''
-  '400':
+    description: ""
+  "400":
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: LIST - fetch all data agreements
+summary: LIST - Fetch all data agreements
 tags:
-- config
+  - config
 x-specification-crudl-model: Agreement
-x-specification-pii-or-sensitive: 'False'
-x-specification-scenario: ''
+x-specification-pii-or-sensitive: "False"
+x-specification-scenario: ""
 x-specification-usecase: UC-C-PIC-A-003

openapi/v2023.8.2/paths/configListAgreementFilter.yaml

@@ -1,4 +1,4 @@
-description: LIST - fetch all data agreements matching the data agreement filter
+description: LIST - Fetch all data agreements matching the data agreement filter
 operationId: configListAgreementFilter
 parameters:
 - description: Requested index for start of resources to be provided in response requested
@@ -40,7 +40,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: LIST - fetch all data agreements matching the data agreement filter
+summary: LIST - Fetch all data agreements matching the data agreement filter
 tags:
 - config
 x-specification-crudl-model: Agreement

openapi/v2023.8.2/paths/configListPolicy.yaml

@@ -1,4 +1,4 @@
-description: LIST - Fetches list of policies
+description: LIST - Fetch all policies
 operationId: configListPolicy
 parameters:
 - description: An object with id revisionId
@@ -35,7 +35,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: LIST - Fetches list of policies
+summary: LIST - Fetch all policies
 tags:
 - config
 x-specification-crudl-model: Policy

openapi/v2023.8.2/paths/configListPolicyRevisions.yaml

@@ -1,4 +1,4 @@
-description: LIST - returns all the revisions for the policy
+description: LIST - Returns all the revisions for the policy
 operationId: configListPolicyRevisions
 parameters:
 - description: Unique ID of an object
@@ -32,7 +32,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: LIST - returns all the revisions for the policy
+summary: LIST - Returns all the revisions for the policy
 tags:
 - config
 x-specification-crudl-model: Revision

openapi/v2023.8.2/paths/configReadAgreement.yaml

@@ -1,4 +1,4 @@
-description: READ - fetches the latest version of a data agreement
+description: READ - Fetch the latest version of a data agreement
 operationId: configReadAgreement
 parameters:
 - description: Unique ID of an object
@@ -22,7 +22,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: READ - fetches the latest version of a data agreement
+summary: READ - Fetch the latest version of a data agreement
 tags:
 - config
 x-specification-crudl-model: Agreement

openapi/v2023.8.2/paths/configReadPolicy.yaml

@@ -1,4 +1,4 @@
-description: READ - get a policy + latest revision. If a policy filter is supplied
+description: READ - Fetch a policy + latest revision. If a policy filter is supplied
   and contains a `revisionId`, then this specific revision is returned.
 operationId: configReadPolicy
 parameters:
@@ -29,7 +29,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: READ - get a policy + latest revision
+summary: READ - Fetch a policy + latest revision
 tags:
 - config
 x-specification-crudl-model: Policy

openapi/v2023.8.2/paths/configUpdateAgreement.yaml

@@ -1,4 +1,4 @@
-description: UPDATE - an existing data agreement and returned together with revision
+description: UPDATE - Update an existing data agreement and returned together with revision
 operationId: configUpdateAgreement
 parameters:
 - description: Unique ID of an object
@@ -33,7 +33,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: UPDATE - an existing data agreement and returned together with revision
+summary: UPDATE - Update an existing data agreement and returned together with revision
 tags:
 - config
 x-specification-crudl-model: Agreement

openapi/v2023.8.2/paths/configUpdatePolicy.yaml

@@ -1,4 +1,4 @@
-description: UPDATE - Updates an existing policy, returning the updated version
+description: UPDATE - Update an existing policy, returning the updated version
   and a new revision. Updating a Policy does not affect existing references in Agreement,
   the new revision should be specified for Agreement.
 operationId: configUpdatePolicy
@@ -35,7 +35,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: UPDATE - Updates an existing policy, returning the updated version and a new revision.
+summary: UPDATE - Update an existing policy, returning the updated version and a new revision.
 tags:
   - config
 x-specification-crudl-model: Policy

openapi/v2023.8.2/paths/serviceAgreementDataRead.yaml

@@ -1,4 +1,4 @@
-description: READ - fetches a list of latest versions of AgreementData associated
+description: READ - Fetch all latest versions of AgreementData associated
   with an Agreement and the presented revisionId of that Agreement
 operationId: serviceAgreementDataRead
 parameters:
@@ -28,7 +28,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: READ - fetches a list of latest versions of AgreementData associated with
+summary: READ - Fetch all latest versions of AgreementData associated with
   an Agreement and the presented revisionId of that Agreement
 tags:
 - service

openapi/v2023.8.2/paths/serviceAgreementRead.yaml

@@ -1,4 +1,4 @@
-description: READ - fetches the latest version of an Agreement
+description: READ - Fetches the latest version of an Agreement
 operationId: serviceAgreementRead
 parameters:
 - description: Unique ID of an object
@@ -22,7 +22,7 @@ responses:
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: READ - fetches the latest version of an Agreement
+summary: READ - Fetches the latest version of an Agreement
 tags:
 - service
 x-specification-crudl-model: Agreement