Refactored APIs

release/yaml/registry_core_api_v1.0.0.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.3
 info:
   title: Interoperability APIs - Foundational/Functional registries
   x-logo:
-    url: 'https://standards.spdci.org/api-documentation/draft/dci-logo.png'
+    url: ./dci-logo.png
     backgroundColor: '#FFFFFF'
     altText: Digital Convergence Initiative
   description: |-
@@ -1623,7 +1623,7 @@ components:
     RegistryType:
       type: string
       description: |
-        @context: "https://schema.spdci.org/common/v1/RegistryType.jsonld" <br>
+        @context: https://schema.spdci.org/common/v1/RegistryType.jsonld <br>
         @type: "RegistryType" <br>
 
         **Notes:**

src/common/schema/Identifier.yaml

@@ -0,0 +1,19 @@
+type: object
+description: Identifier type and value object
+properties:
+  type:
+    type: string
+    description: |
+      @context: "https://schema.spdci.org/common/v1/identifier_type.jsonld" <br>
+      @type: "IdType" <br>
+      
+      **Notes:**
+        1. Identifier type values defined as per implementation context.
+        2. Usually a list of **enum** values of all possible queryable identifiers.
+        3. e.g: UIN, MOBILE, BRN, MRN, DRN, etc., 
+    example: "UIN"
+  value:
+    allOf:
+      - description: Identifier Value of the subject.
+      - $ref: AttributeValue.yaml
+    example: "12314567890"

src/extensions/ibr/Person.yaml

@@ -1,44 +1,7 @@
 type: object
 description: | 
   1. Attributes of a person to create fetch records, create verifiable credentials or use in search criteria.
-  3. Allowes Country/Registry specific implementation extensions using Attribute Name/Value pairs.
-properties:
-  identifier:
-    $ref: IdentifierTypeValue.yaml
-    description: "Information of identifier of the person"
-  name: 
-    $ref: ../dci/Name.yaml
-  sex:
-    $ref: ../dci/Sex.yaml
-  birthdate:
-    description: Represents Date and time of the applicant's birth as in [ISO 8601](https://www.iso.org/standard/40874.html) 
-    type: string
-  address:
-    $ref: ../openid/Address.yaml
-  marital_status:
-    $ref: ../dci/MaritalStatus.yaml
-  poverty_score:
-    type: string
-    description: details of poverty score
-  disabled:
-    type: boolean
-    description: True is disabled, false if no disability
-  household_identifier:
-    type: string
-    description: Value of the household identifier
-  programms:
-    type: array
-    description: "Details of the programmes the person is enrolled in"
-    items:
-      $ref: Programme.yaml
-  benefits:
-    type: array
-    description: "Benefits received by the person"
-    items:
-      $ref: Benefit.yaml
-  payments:
-    type: array
-    description: "Payment information"
-    items:
-      $ref: DisburshmentInfo.yaml
-
+  3. Allows Country/Registry specific implementation extensions using Attribute Name/Value pairs.
+
+  @context: "https://schema.spdci.org/extensions/ibr/v1/Person.jsonld" <br>
+  @type: "@context" <br>

src/extensions/social/Person.yaml

@@ -1,77 +1,7 @@
 type: object
 description: | 
-  This data object contains the information on people and households held in the social registry.  In case of a household the information for the head of household is provided.
-  The data object may include information received from other registries, including CRVS and disability registries.  It may be queried by SP-MIS to determine an applicant's eligibility.
-properties:
-  identifier:
-    $ref: IdentifierTypeValue.yaml
-    description: The person identification number
-#  name: 
-#    $ref: ../dci/Name.yaml
-#    description: Full name in a displayable form, possibly including titles and suffixes, in the order of the applicant's locale norms and/or preferences.    
-#  parent1_identifier:
-#    $ref: IdentifierTypeValue.yaml
-#    description: "Identifier for one parent of the applicant. Must be a unique identifier similar to the applicant's identifier."
-#  parent2_identifier:
-#    $ref: IdentifierTypeValue.yaml
-#    description: "Identifier for one parent of the applicant. Must be a unique identifier similar to the applicant's identifier."
-  birth_date:
-    description: Represents Date and time of the applicant's birth as in [ISO 8601](https://www.iso.org/standard/40874.html) 
-    type: string
-#  sex:
-#    $ref: ../dci/Sex.yaml
-  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
-#  marital_status:
-#    $ref: ../dci/MaritalStatus.yaml
-  household_identifier:
-    type: string
-    description: Value of the household identifier
-  is_head:
-    type: boolean
-    description: Defines if the person is the head of the household or not
-  is_disabled:
-    type: boolean
-    description: Specifies if the applicant is disabled, not disabled or not known
-  registration_date: 
-    description: The date on which the person was first registered in the social registry
-    $ref: ../../common/schema/DateTime.yaml   
-#  address:
-#    description: Current residential address of the applicant, represented as an address object.
-#    $ref: ../openid/Address.yaml
-  death_date:
-    description: The date of death of the applicant, if applicable. Formatted according to schema:DateTime.
-    $ref: ../../common/schema/DateTime.yaml
-#  deathplace:
-#    $ref: ../openid/Address.yaml
-  email:
-    type: string
-    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)
-  email_verified: 
-    type: boolean
-    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.
-  nationality:
-    type: string
-    description: The nationality of the person registered
-  poverty_score:
-    type: string
-    description: The poverty score assigned to the household as a result of a proxy means test or other poverty ranking approach
-  employment_status:
-    type: string
-    description: Binary representation of if the beneficiary is formally employed or not
-  disability_information:
-    $ref: DisabilityInfo.yaml
-  is_deceased:
-    type: boolean
-    description: True is disabled, false if no disability
-  ethnicity:
-    type: string  
-    description: Ethnicity of the applicant
-  last_updated:
-    type: string  
-    description: Date on which applicant data was last updated
-#
+  1. Attributes of a person to create fetch records, create verifiable credentials or use in search criteria.
+  3. Allows Country/Registry specific implementation extensions using Attribute Name/Value pairs.
+
+  @context: https://schema.spdci.org/extensions/social/v1/Person.jsonld <br>
+  @type: "@context" <br>

src/registry/ibr/SearchResponse.yaml

@@ -33,7 +33,7 @@ properties:
             reg_records:
               description: |
                 The "Person" object contains fields expected in response of search
-                @context: "https://spdci.github.io/schemas/extensions/ibr/v1/Person.jsonld <br>
+                @context: https://schema.spdci.org/extensions/ibr/v1/Person.jsonld <br>
                 @type: "Person" <br>
                 @container: "@set" <br>
           required: 

src/registry/ibr_api_v1.0.0.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.3
 info:
   title: Interoperability APIs - Integrated Beneficiary Registry
   x-logo:
-    url: 'https://standards.spdci.org/api-documentation/draft/dci-logo.png'
+    url: './dci-logo.png'
     backgroundColor: '#FFFFFF'
     altText: 'Digital Convergence Initiative'  
   description: |-

src/registry/registry_core_api_v1.0.0.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.3
 info:
   title: Interoperability APIs - Foundational/Functional registries
   x-logo:
-    url: 'https://standards.spdci.org/api-documentation/draft/dci-logo.png'
+    url: './dci-logo.png'
     backgroundColor: '#FFFFFF'
     altText: 'Digital Convergence Initiative'  
   description: |-

src/registry/schema/RegistryType.yaml

@@ -1,10 +1,10 @@
 type: string
 description: |
-  @context: "https://schema.spdci.org/common/v1/RegistryType.jsonld" <br>
+  @context: https://schema.spdci.org/common/v1/RegistryType.jsonld <br>
   @type: "RegistryType" <br>
   
   **Notes:**
     1. Registry type values defined as per implementation context.
     2. Usually a list of **enum** values of all possible queryable functional registries 
     3. example: "ns:org:RegistryType:Civil"
-example: "ns:org:RegistryType:Civil"
+example: "ns:org:RegistryType:Civil"

src/registry/social_api_v1.0.0.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.3
 info:
   title: Interoperability APIs - Integrated Beneficiary Registry
   x-logo:
-    url: 'https://standards.spdci.org/api-documentation/draft/dci-logo.png'
+    url: './dci-logo.png'
     backgroundColor: '#FFFFFF'
     altText: 'Digital Convergence Initiative'  
   description: |-