Upd: Summary and styling

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

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 @@
       />
     </rapi-doc>
   </body>
-</html>
+</html>

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:

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

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

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

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

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: ""

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: ''

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: ""

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: ""

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: ''

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"

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

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: ""

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: ""

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

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

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