Upd: Identation issues

Signed-off-by: George J Padayatti <george.padayatti@igrant.io>
decentralised-dataexchange · Sep 1, 2023 · c9604be · c9604be
1 parent 2bf4c15
commit c9604be
Show file tree

Hide file tree

Showing 10 changed files with 35 additions and 46 deletions.
diff --git a/Makefile b/Makefile
@@ -12,10 +12,10 @@ check-swagger-cli:
 bootstrap: resources/ssl/development ## Boostraps development environment
 	make -C resources/ssl/development bootstrap
 
-up: bootstrap ## Run nginx server with swagger ui
+up: bootstrap ## Run nginx server with swagger ui and start watching for changes
 	docker-compose up -d
 
-down: ## Stop the nginx server
+down: ## Stop the nginx server and file watcher
 	docker-compose down
 
 bundle: check-swagger-cli ## Bundles swagger files

diff --git a/openapi/index.html b/openapi/index.html
@@ -9,7 +9,7 @@
       href="https://cdn.jsdelivr.net/npm/tailwindcss@2.2.19/dist/tailwind.min.css"
       rel="stylesheet"
     />
-    <meta http-equiv="refresh" content="0; URL=https://consent-bb-swagger.igrant.io/v2023.8.2/index.html" />
+    <meta http-equiv="refresh" content="0; URL=./v2023.8.2/index.html" />
   </head>
 
   <body class="bg-gray-100 h-screen flex items-center justify-center">

diff --git a/openapi/v2023.8.1/index.html b/openapi/v2023.8.1/index.html
@@ -64,7 +64,7 @@
   <body>
     <rapi-doc
       render-style="focused"
-      spec-url="./index.yaml"
+      spec-url="./bundled.yaml"
       theme="light"
       show-header="false"
       nav-bg-color="#0a065e"

diff --git a/openapi/v2023.8.2/bundled.yaml b/openapi/v2023.8.2/bundled.yaml
@@ -4306,15 +4306,11 @@ components:
         DataAgreementRecordRevision:
           $ref: '#/components/schemas/DataAgreementRecordRevision'
           description: |
-            A *generic* revision model captures the serialized contents of any shema's single row. 
-            This is then subject to 1) cryptographic signature and 2) auditing. Aside from \"successor\" column, a 
-            revision should be considered locked.
+            A generic revision model captures the serialized contents of any shema's single row.  This is then subject to 1) cryptographic signature and 2) auditing. Aside from successor column, a  revision should be considered locked.
     DataAgreementRecordRevision:
       type: object
-      description: |-
-        A *generic* revision model captures the serialized contents of any shema's single row. This is then subject to 1) cryptographic signature and 2) auditing.
-
-        Aside from "successor" column, a revision should be considered locked.
+      description: |
+        A generic revision model captures the serialized contents of any schema's single row.  This is then subject to 1) cryptographic signature and 2) auditing. Aside from successor column,  a revision should be considered locked.
       required:
         - id
         - schema_name
@@ -5218,8 +5214,7 @@ components:
           type: string
         attributeSensitive:
           description: |
-            Indicates that personal data is sensitive or belongs to a 
-            special category as per a regulations, typically requiring additional measures of handling.
+            Indicates that personal data is sensitive or belongs to a  special category as per a regulations, typically requiring additional measures of handling.
           type: boolean
         attributeCategory:
           description: A category of personal data
@@ -5293,9 +5288,7 @@ components:
       title: Data agreement
       type: object
       description: |
-        The Data Agreement Vocabulary provides terms to describe and represent information related to 
-        processing of personal data based on established requirements such as for the EU General Data 
-        Protection Regulation (GDPR).
+        The Data Agreement Vocabulary provides terms to describe and represent information related to  processing of personal data based on established requirements such as for the EU General Data  Protection Regulation (GDPR).
       properties:
         language:
           type: string
@@ -5314,28 +5307,23 @@ components:
           $ref: '#/components/schemas/GlobalDataPolicyConfiguration'
         purpose:
           description: |
-            Describes the purpose for which a data controller (Data Source or Data Using Service) uses personal data for. 
-            This is also the purpose for which the data agreeent is being formulated
+            Describes the purpose for which a data controller (Data Source or Data Using Service) uses personal data for.  This is also the purpose for which the data agreeent is being formulated
           type: string
         purposeDescription:
           description: |
-            Provides description of the purpose for which the personal data us used, 
-            comprehensive to the individual whose data is being used by the data controller.
+            Provides description of the purpose for which the personal data us used,  comprehensive to the individual whose data is being used by the data controller.
           type: string
         lawfulBasis:
           description: |
-            An organization processing personal data to have a valid lawful basis for that personal data processing activity. GDPR, 
-            for e.g., consent, legal_obligation, contract, vital_interest, public_task and legitimate_interest.
+            An organization processing personal data to have a valid lawful basis for that personal data processing activity. GDPR,  for e.g., consent, legal_obligation, contract, vital_interest, public_task and legitimate_interest.
           type: string
         methodOfUse:
           description: |
-            This is used to describe whether controller is using personal data for internal purposes of for data exchange towards an external third party. 
-            Data exchange could be for exposing data (as a Data Source) or consuming data as a Data Using Service.
+            This is used to describe whether controller is using personal data for internal purposes of for data exchange towards an external third party.  Data exchange could be for exposing data (as a Data Source) or consuming data as a Data Using Service.
           type: string
         dataAttributes:
           description: |
-            Encapsulates the attributes used for the the usage purpose defined. 
-            Its an array of personal data attributes.
+            Encapsulates the attributes used for the the usage purpose defined.  Its an array of personal data attributes.
           type: array
           items:
             $ref: '#/components/schemas/DataAttribute'
@@ -5402,9 +5390,7 @@ components:
           type: string
         thirdPartyDataSharing:
           description: |
-            This is a boolean value to indicate that the DA is used for third party data disclosures. 
-            This indicates that some data disclosures will happen and is used to release personal data 
-            to DUS based on an agreement
+            This is a boolean value to indicate that the DA is used for third party data disclosures.  This indicates that some data disclosures will happen and is used to release personal data  to DUS based on an agreement
           type: boolean
       required:
         - policyUrl

diff --git a/openapi/v2023.8.2/definitions/config/DataAgreement.yaml b/openapi/v2023.8.2/definitions/config/DataAgreement.yaml
@@ -1,6 +1,6 @@
 title: Data agreement
 type: object
-description: |
+description: >
   The Data Agreement Vocabulary provides terms to describe and represent information related to 
   processing of personal data based on established requirements such as for the EU General Data 
   Protection Regulation (GDPR).
@@ -21,27 +21,27 @@ properties:
     description: Encapsulate the data policies used in the use of personal data.
     $ref: "./GlobalDataPolicyConfiguration.yaml"
   purpose:
-    description: |
+    description: >
       Describes the purpose for which a data controller (Data Source or Data Using Service) uses personal data for. 
       This is also the purpose for which the data agreeent is being formulated
     type: string
   purposeDescription:
-    description: |
+    description: >
       Provides description of the purpose for which the personal data us used, 
       comprehensive to the individual whose data is being used by the data controller.
     type: string
   lawfulBasis:
-    description: |
+    description: >
       An organization processing personal data to have a valid lawful basis for that personal data processing activity. GDPR, 
       for e.g., consent, legal_obligation, contract, vital_interest, public_task and legitimate_interest.
     type: string
   methodOfUse:
-    description: |
+    description: >
       This is used to describe whether controller is using personal data for internal purposes of for data exchange towards an external third party. 
       Data exchange could be for exposing data (as a Data Source) or consuming data as a Data Using Service.
     type: string
   dataAttributes:
-    description: |
+    description: >
       Encapsulates the attributes used for the the usage purpose defined. 
       Its an array of personal data attributes.
     type: array
@@ -55,7 +55,7 @@ properties:
         description: The date on which the DPIA report is generated after a DPIA.
         type: string
       dpiaSummaryUrl:
-        description: |
+        description: >
           The URl providing the DPIA result reports, summary etc that can be verified by any interested parties.
         type: string
     required:

diff --git a/openapi/v2023.8.2/definitions/config/DataAttribute.yaml b/openapi/v2023.8.2/definitions/config/DataAttribute.yaml
@@ -9,7 +9,7 @@ properties:
     description: Name of the attribute
     type: string
   attributeSensitive:
-    description: |
+    description: >
       Indicates that personal data is sensitive or belongs to a 
       special category as per a regulations, typically requiring additional measures of handling.
     type: boolean

diff --git a/openapi/v2023.8.2/definitions/config/GlobalDataPolicyConfiguration.yaml b/openapi/v2023.8.2/definitions/config/GlobalDataPolicyConfiguration.yaml
@@ -5,15 +5,15 @@ properties:
     description: Policy URL for the organisation
     type: string
   jurisdiction:
-    description: |
+    description: >
       Indicates a legal jurisdiction, e.g. of some legislation, or where some government service is based.
     type: string
   industrySectorId:
-    description: |
+    description: >
       Identifier for the industry sector
     type: string
   industrySector:
-    description: |
+    description: >
       Indicate or restrict scope for interpretation and application of purpose in a domain.
     type: string
   dataRetentionPeriod:
@@ -26,7 +26,7 @@ properties:
     description: The geographic location where the personal data is stored
     type: string
   thirdPartyDataSharing:
-    description: |
+    description: >
       This is a boolean value to indicate that the DA is used for third party data disclosures. 
       This indicates that some data disclosures will happen and is used to release personal data 
       to DUS based on an agreement

diff --git a/openapi/v2023.8.2/definitions/service/DataAgreementRecord.yaml b/openapi/v2023.8.2/definitions/service/DataAgreementRecord.yaml
@@ -28,7 +28,7 @@ properties:
         description: "Data retention expiry in UTC timestamp"
   DataAgreementRecordRevision:
     $ref: "./DataAgreementRecordRevision.yaml"
-    description: |
-      A *generic* revision model captures the serialized contents of any shema's single row. 
-      This is then subject to 1) cryptographic signature and 2) auditing. Aside from \"successor\" column, a 
+    description: >
+      A generic revision model captures the serialized contents of any shema's single row. 
+      This is then subject to 1) cryptographic signature and 2) auditing. Aside from successor column, a 
       revision should be considered locked.
diff --git a/openapi/v2023.8.2/definitions/service/DataAgreementRecordRevision.yaml b/openapi/v2023.8.2/definitions/service/DataAgreementRecordRevision.yaml
@@ -1,5 +1,8 @@
 type: object
-description: "A *generic* revision model captures the serialized contents of any shema's single row. This is then subject to 1) cryptographic signature and 2) auditing.\n\nAside from \"successor\" column, a revision should be considered locked."
+description: >
+  A generic revision model captures the serialized contents of any schema's single row. 
+  This is then subject to 1) cryptographic signature and 2) auditing. Aside from successor column, 
+  a revision should be considered locked.
 required:
   - id
   - schema_name

diff --git a/openapi/v2023.8.2/index.html b/openapi/v2023.8.2/index.html
@@ -64,7 +64,7 @@
   <body>
     <rapi-doc
       render-style="focused"
-      spec-url="./index.yaml"
+      spec-url="./bundled.yaml"
       theme="light"
       show-header="false"
       nav-bg-color="#0a065e"