Revert "Merge remote-tracking branch 'origin/changes_based_on_discuss…

…ion_points' into draft" This reverts commit c871d39, reversing changes made to 7381d39.
spdci · Aug 30, 2023 · 2bec406 · 2bec406
1 parent c871d39
commit 2bec406
Show file tree

Hide file tree

Showing 33 changed files with 336 additions and 661 deletions.
diff --git a/release/html/registry_core_api_v1_0.0.0.html b/release/html/registry_core_api_v1_0.0.0.html
diff --git a/release/yaml/registry_core_api_v1.0.0.yaml b/release/yaml/registry_core_api_v1.0.0.yaml
diff --git a/src/common/schema/Expression.yaml b/src/common/schema/Expression.yaml
@@ -1,5 +1,4 @@
 description: Expression
-type: object
 properties:
   seq_num:
     description: expression seq number for correlation 

diff --git a/src/common/schema/ExpressionList.yaml b/src/common/schema/ExpressionList.yaml
@@ -1,4 +1,3 @@
-type: object
 description: list of attributes with matching conditions
 items:
   $ref: "./Expression.yaml"
diff --git a/src/common/schema/ExpressionResult.yaml b/src/common/schema/ExpressionResult.yaml
@@ -1,5 +1,4 @@
 description: Expression result
-type: object
 properties:
   seq_num:
     description: expression seq number for correlation 

diff --git a/src/common/schema/ExpressionResultList.yaml b/src/common/schema/ExpressionResultList.yaml
@@ -1,3 +1,2 @@
-type: array
 items:
   $ref: "./ExpressionResult.yaml"
diff --git a/src/common/schema/ExpressionWithConditionList.yaml b/src/common/schema/ExpressionWithConditionList.yaml
@@ -1,3 +1,2 @@
-type: array
 items:
   $ref: "./ExpressionWithCondition.yaml"
diff --git a/src/common/schema/ReferenceIdList.yaml b/src/common/schema/ReferenceIdList.yaml
@@ -1,3 +1,2 @@
-type: array
 items:
   $ref: "./ReferenceId.yaml"
diff --git a/src/common/schema/SearchSortList.yaml b/src/common/schema/SearchSortList.yaml
@@ -1,3 +1,2 @@
-type: array
 items:
   $ref: "./SearchSort.yaml"
diff --git a/src/common/schema/Version-1.0.0.yaml b/src/common/schema/Version-1.0.0.yaml
diff --git a/src/extensions/cdpi/PersonId.yaml b/src/extensions/cdpi/PersonId.yaml
@@ -1,4 +1,4 @@
-type: object
+type: string
 description: |
   1. Person id is case insensitve normative represenation as id-type:id@provider <br>
   2. This will enumerate foundational and functioanl id's to easily resolvable addressess <br>

diff --git a/src/extensions/dci/IdentifierTypeValue.yaml b/src/extensions/dci/IdentifierTypeValue.yaml
@@ -1,4 +1,3 @@
-type: object
 properties:
   identifier_type:
     $ref: IdentifierType.yaml

diff --git a/src/extensions/dci/PersonRecord.yaml b/src/extensions/dci/PersonRecord.yaml
@@ -13,15 +13,9 @@ properties:
   phone_number:
     description: Applicant preferred phone number as in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I/en)
     type: string
-  phone_number_verified:
-    description: True if the End-User's phone number has been verified; otherwise false. 
-    type: string
   email:
     description: Applicant preferred e-mail address as in [RFC 5322](https://datatracker.ietf.org/doc/html/rfc5322) [addr-spec](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1) [specification](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4.1)
     type: string
-  email_verified: 
-    description: Email address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.
-    type: boolean
   sex:
     $ref: Sex.yaml
   birthdate:

diff --git a/src/extensions/nid/DeceasedRecord.yaml b/src/extensions/nid/DeceasedRecord.yaml
@@ -26,4 +26,5 @@ properties:
     description: Date in DDMMYYYY format to capture the Demo Check Date
     type: string
   document:
+    description: Reference document collected for registering the deceased information
     $ref: Document.yaml
diff --git a/src/extensions/nid/Document.yaml b/src/extensions/nid/Document.yaml
@@ -1,5 +1,5 @@
 type: object
-description: Supporting document of the Resident,Reference document collected for registering the deceased information,Document encoded as Base64 string
+description: Supporting document of the Resident
 properties:
   document_name:
     description: Name of the document

diff --git a/src/extensions/nid/EKycDetails.yaml b/src/extensions/nid/EKycDetails.yaml
@@ -1,5 +1,5 @@
 type: object
-description: eKYC details of the resident ,ekyc Details undertaken by the Resident
+description: eKYC details of the resident
 properties:
   ekyc_date:
     description: Date on which eKYC has been done. A null value indicates that eKYC has not been undertaken

diff --git a/src/extensions/nid/ResidentNationality.yaml b/src/extensions/nid/ResidentNationality.yaml
@@ -1,5 +1,5 @@
 type: object
-description: Resident Nationality Information,Nationality information of the Resident
+description: Resident Nationality Information
 properties:
   nationality:
     description: Nationality information of the Resident

diff --git a/src/extensions/nid/ResidentPhoto.yaml b/src/extensions/nid/ResidentPhoto.yaml
@@ -1,5 +1,5 @@
 type: object
-description: Resident Photo,Image encoded as Base64 string
+description: Resident Photo
 properties:
   photo:
     description: Photo encoded as Base64 string

diff --git a/src/extensions/nid/ResidentRecord.yaml b/src/extensions/nid/ResidentRecord.yaml
@@ -26,10 +26,14 @@ properties:
   local_address:
     $ref: ResidentLocalAddress.yaml
   photo:
+    description: Image encoded as Base64 string
     $ref: ResidentPhoto.yaml
   nationality:
+    description: Nationality information of the Resident
     $ref: ResidentNationality.yaml
   kyc_status:
+    description: ekyc Details undertaken by the Resident
     $ref: EKycDetails.yaml
   document:
+    description: Document encoded as Base64 string
     $ref: Document.yaml
diff --git a/src/extensions/openid/Address.yaml b/src/extensions/openid/Address.yaml
@@ -1,5 +1,4 @@
 title: Address
-type: object
 description: Address info as per OpenID <a href="https://openid.net/specs/openid-connect-core-1_0.html#AddressClaim">specs</a>
 properties:
   address_line1:

diff --git a/src/extensions/openid/PersonRecord.yaml b/src/extensions/openid/PersonRecord.yaml
@@ -1,4 +1,3 @@
-type: object
 description: | 
   1. Attributes of a person to create fetch records, create verifiable credentials or use in search criteria.
   2. Allowes Country/Registry specific implementation extensions using Attribute Name/Value pairs.

diff --git a/src/registry/registry_core_api_v1.0.0.yaml b/src/registry/registry_core_api_v1.0.0.yaml
@@ -47,65 +47,6 @@ tags:
     description: Sync endpoints
   - name: Schemas
     description: Schemas
-  - name: SearchRequest
-    x-displayName: SearchRequest
-    description: |
-      <SchemaDefinition schemaRef="#/components/schemas/SearchRequest" />    
-  - name: SearchResponse
-    x-displayName: SearchResponse
-    description: |
-      <SchemaDefinition schemaRef="#/components/schemas/SearchResponse" />    
-  - name: SubscribeRequest
-    x-displayName: SubscribeRequest
-    description: |
-      <SchemaDefinition schemaRef="#/components/schemas/SubscribeRequest" />    
-  - name: NotifyEventRequest
-    x-displayName: NotifyEventRequest
-    description: |
-      <SchemaDefinition schemaRef="#/components/schemas/NotifyEventRequest" />    
-  - name: TxnStatusRequest
-    x-displayName: TxnStatusRequest
-    description: |
-      <SchemaDefinition schemaRef="#/components/schemas/TxnStatusRequest" />    
-  - name: TxnStatusResponse
-    x-displayName: TxnStatusResponse
-    description: |
-      <SchemaDefinition schemaRef="#/components/schemas/TxnStatusResponse" />    
-  - name: FetchSubscriptionsRequest
-    x-displayName: FetchSubscriptionsRequest
-    description: |
-      <SchemaDefinition schemaRef="#/components/schemas/FetchSubscriptionsRequest" />    
-  - name: FetchSubscriptionsResponse
-    x-displayName: FetchSubscriptionsResponse
-    description: |
-      <SchemaDefinition schemaRef="#/components/schemas/FetchSubscriptionsResponse" />    
-  - name: UnSubscribeRequest
-    x-displayName: UnSubscribeRequest
-    description: |
-      <SchemaDefinition schemaRef="#/components/schemas/UnSubscribeRequest" />    
-  - name: UnSubscribeResponse
-    x-displayName: UnSubscribeResponse
-    description: |
-      <SchemaDefinition schemaRef="#/components/schemas/UnSubscribeResponse" />  
-
-x-tagGroups:
-  - name: API Definitions
-    tags:
-      - Async
-      - Sync
-  - name: Schema Objects
-    tags:
-      - SearchRequest
-      - SearchResponse 
-      - SubscribeRequest
-      - NotifyEventRequest
-      - TxnStatusRequest
-      - TxnStatusResponse
-      - FetchSubscriptionsRequest
-      - FetchSubscriptionsResponse
-      - UnSubscribeRequest
-      - UnSubscribeResponse  
-
 paths:
  /registry/search:
   post: 
@@ -718,7 +659,7 @@ paths:
                 message:
                   type: object
                   description: The search data using which registry search to be performed
-                  oneOf:
+                  anyOf:
                     - $ref: '#/components/schemas/SearchRequest'
                     - $ref: '#/components/schemas/EncryptedMessage'
               required:
@@ -1050,6 +991,7 @@ components:
       $ref: ../extensions/dci/Sex.yaml
     dci_VitalEvents: 
       $ref: ../extensions/dci/VitalEvents.yaml
+
     ###### src/extensions/fhir schema objects
 
     ###### src/extensions/google schema objects
@@ -1121,62 +1063,24 @@ components:
       $ref: schema/core/AllRecordTypes.yaml
     coreReg_EventType: 
       $ref: schema/core/EventType.yaml
-    FetchSubscriptionsRequest:
-      type: object
-      properties:
-        version:
-          type: string
-          example: 1.0.0
-        data:
-          $ref: schema/core/FetchSubscriptionsRequest.yaml     
-
+    FetchSubscriptionsRequest: 
+      $ref: schema/core/FetchSubscriptionsRequest.yaml
     FetchSubscriptionsResponse:
-      type: object
-      properties:
-        version:
-          type: string
-          example: 1.0.0
-        data:
-          $ref: schema/core/FetchSubscriptionsResponse.yaml     
-    NotifyEventRequest:
-      type: object
-      properties:
-        version:
-          type: string
-          example: 1.0.0
-        data:
-          $ref: schema/core/NotifyEventRequest.yaml        
+      $ref: schema/core/FetchSubscriptionsResponse.yaml
+    NotifyEventRequest: 
+      $ref: schema/core/NotifyEventRequest.yaml
     other_RecordType: 
       $ref: schema/core/RegistryRecordType.yaml
     coreReg_Type: 
       $ref: schema/core/RegistryType.yaml
-    SearchRequest:
-      type: object
-      properties:
-        version:
-          type: string
-          example: 1.0.0
-        data:
-          $ref: schema/core/SearchRequest.yaml
-    SearchResponse:
-      type: object
-      properties:
-        version:
-          type: string
-          example: 1.0.0
-        data:
-          $ref: schema/core/SearchResponse.yaml     
+    SearchRequest: 
+      $ref: schema/core/SearchRequest.yaml
+    SearchResponse: 
+      $ref: schema/core/SearchResponse.yaml
     SearchStatusReasonCode: 
       $ref: schema/core/SearchStatusReasonCode.yaml
-    SubscribeRequest:
-      type: object
-      properties:
-        version:
-          type: string
-          example: 1.0.0
-        data:
-          $ref: schema/core/SubscribeRequest.yaml      
-
+    SubscribeRequest: 
+      $ref: schema/core/SubscribeRequest.yaml
     # SubscribeResponse: 
     #   $ref: schema/core/SubscribeResponse.yaml
     SubscribeStatusReasonCode: 
@@ -1188,37 +1092,13 @@ components:
     SubscriptionStatus:
         $ref: schema/core/SubscriptionStatus.yaml
     TxnStatusRequest: 
-      type: object
-      properties:
-        version:
-          type: string
-          example: 1.0.0
-        data:
-          $ref: schema/core/TxnStatusRequest.yaml    
+      $ref: schema/core/TxnStatusRequest.yaml            
     TxnStatusResponse: 
-      type: object
-      properties:
-        version:
-          type: string
-          example: 1.0.0
-        data:
-          $ref: schema/core/TxnStatusResponse.yaml     
+      $ref: schema/core/TxnStatusResponse.yaml  
     UnSubscribeRequest: 
-      type: object
-      properties:
-        version:
-          type: string
-          example: 1.0.0
-        data:
-          $ref: schema/core/UnSubscribeRequest.yaml    
+      $ref: schema/core/UnSubscribeRequest.yaml
     UnSubscribeResponse: 
-      type: object
-      properties:
-        version:
-          type: string
-          example: 1.0.0
-        data:
-          $ref: schema/core/UnSubscribeResponse.yaml    
+      $ref: schema/core/UnSubscribeResponse.yaml
     UnSubscribeStatusReasonCode: 
       $ref: schema/core/UnSubscribeStatusReasonCode.yaml           
 

diff --git a/src/registry/schema/civil/EventType.yaml b/src/registry/schema/civil/EventType.yaml
@@ -3,7 +3,7 @@ description: |
   2. This is an indicative list as reference and every country, organisation, system shall customise to local requirements as extensions
   3. Example Civil Registration events: person, birth, death, marriage, divorce, annulment, seperation, adoption, demo_change, unregister, etc.,
 type: string
-enum:
+example:
   - "person"
   - "birth"
   - "death"

diff --git a/src/registry/schema/civil/PersonRecord.yaml b/src/registry/schema/civil/PersonRecord.yaml
@@ -1,4 +1,3 @@
-type: object
 description: | 
   1. A sample person record to identity an individual or civil regisration event in a typical civil registry
   2, This is an indicative list as reference and every country, organisation, system shall customise to local requirements as extensions
@@ -18,7 +17,6 @@ allOf:
       type: string
     registration_date:
       description: Registration date
-      type: string
     link_registration_number:
       description: Registration number to related record. e.g birth registration no for death, marriage registration no for divorce/annulment, etc.,
       type: string

diff --git a/src/registry/schema/civil/RecordType.yaml b/src/registry/schema/civil/RecordType.yaml
@@ -3,7 +3,7 @@ description: |
   1. A sample record list to identity various records that civil registry can produce
   2, This is an indicative list as reference and every country, organisation, system shall customise to local requirements as extensions
   3. Example Civil Registry records - person_record, birth_cert, death_cert, marriage_cert, etc.,
-enum:
+example:
   - "person_record"
   - "brith_cert"
   - "death_cert"

diff --git a/src/registry/schema/core/AllEvents.yaml b/src/registry/schema/core/AllEvents.yaml
@@ -1,4 +1,3 @@
-type: string
 description: |
   1. List of all events type defined by respective registries, entities, coutnries and organisation as extensions
   2. Events can be used for defining custom selection criteria with in the context of registry domain

diff --git a/src/registry/schema/core/AllQueries.yaml b/src/registry/schema/core/AllQueries.yaml
@@ -1,4 +1,3 @@
-type: object
 description: |
   1. Pre defined query objects injected by each country/org/system to query a registry
   2. Implementing systems may create pre-defined query objects based on use cases and inject as custom extensions

diff --git a/src/registry/schema/core/AllRecordTypes.yaml b/src/registry/schema/core/AllRecordTypes.yaml
@@ -1,4 +1,3 @@
-type: string
 description: |
   1. RecordType are pre defined as list of attributes or an object to return upon successful search/subscribe requests
   2. This is equivalent to column list in a typical sql query i.e select col1, col2, col3 from table where condition

diff --git a/src/registry/schema/core/EventType.yaml b/src/registry/schema/core/EventType.yaml
@@ -1,11 +1,11 @@
-type: string
 description: |
   Functional registry event types:
     1. update - search or subscribe to update events; e.g update to postal_code 12345 between date_range
     2. link - search or subscribe to linking events; e.g mobile no link with ID, national ID link with civil reg record, etc.,
     3. unlink - search or subscribe to unlinking events; <br>
 
   Note: update event can also cover link/unlink events on a registry record.
+type: string
 enum:
   - "update"
   - "link"