Merge branch 'draft' into locations-endpoint

Author: tntra-dhananjay

build/build_apis.cmd

@@ -2,14 +2,22 @@
 # Assumes the command is run from the root folder i.e ./standards
 # For each new category, please make sure to add a reference link in this file for easy auto generation of yamls.
 
+# build auth APIs
 swagger-cli -f 2 -t yaml bundle ./src/authz/authz_core_api_v1.0.0.yaml -o ./release/yaml/authz_core_api_v1.0.0.yaml
-swagger-cli -f 2 -t yaml bundle ./src/registry/registry_core_api_v1.0.0.yaml -o ./release/yaml/registry_core_api_v1.0.0.yaml
-swagger-cli -f 2 -t yaml bundle ./src/locations/locations_core_api_v1.0.0.yaml -o ./release/yaml/locations_core_api_v1.0.0.yaml
-
 redocly build-docs ./release/yaml/authz_core_api_v1.0.0.yaml  -o ./release/html/authz_core_api_v1.0.0.html
+
+# build registry core APIs
+swagger-cli -f 2 -t yaml bundle ./src/registry/registry_core_api_v1.0.0.yaml -o ./release/yaml/registry_core_api_v1.0.0.yaml
 redocly build-docs ./release/yaml/registry_core_api_v1.0.0.yaml  -o ./release/html/registry_core_api_v1.0.0.html
+
+# build locations APIs
+swagger-cli -f 2 -t yaml bundle ./src/locations/locations_core_api_v1.0.0.yaml -o ./release/yaml/locations_core_api_v1.0.0.yaml
 redocly build-docs ./release/yaml/locations_core_api_v1.0.0.yaml -o ./release/html/locations_core_api_v1.0.0.html
 
+# build jwks APIs
+swagger-cli -f 2 -t yaml bundle ./src/jwks/jwks_core_api_v1.0.0.yaml -o ./release/yaml/jwks_core_api_v1.0.0.yaml
+redocly build-docs ./release/yaml/jwks_core_api_v1.0.0.yaml  -o ./release/html/jwks_core_api_v1.0.0.html
+
 # IBR registry build steps
 swagger-cli -f 2 -t yaml bundle ./src/registry/ibr_api_v1.0.0.yaml -o ./release/yaml/ibr_api_v1.0.0.yaml
 redocly build-docs ./release/yaml/ibr_api_v1.0.0.yaml  -o ./release/html/ibr_api_v1.0.0.html

src/jwks/README.md

@@ -0,0 +1,7 @@
+## G2P Connect JSON Web Token Set Specs
+
+### Wiki Pages
+1. [Specifications](https://digital-convergence-initiative-d.gitbook.io/dci-standards-1/standards/1.-crvs)
+
+### Reference Links
+1. [Build Instructions](../build_instructions.md) to edit and build swagger yaml files.

src/jwks/jwks_core_api_v1.0.0.yaml

@@ -0,0 +1,44 @@
+openapi: 3.0.3
+info:
+  title: Interoperability APIs - JWKs
+  x-logo:
+    url: 'https://spdci.github.io/api-documentation/draft/dci-logo.png'
+    backgroundColor: '#FFFFFF'
+    altText: 'Digital Convergence Initiative'
+  description: Provide JSON Web Key Set to registered clients/services.
+  version: 1.0.0
+  contact:
+    name: DCI Social Protection
+    email: [email protected]
+  license:
+   name: DCI Social Protection License
+   url: https://github.com/spdci/standards/blob/draft/LICENSE.md
+servers:
+  - url: "https://sandbox.spdci.org/namespace/v1.0.0"
+    description: Sandbox Server
+paths:
+ /.well-known/jwks.json:
+  get: 
+    summary: "JWKs : /.well-known/jwks.json"
+    description: "This end point is in compliance with RFC 7517 to share the encryption & signature verification public keys over HTTPS channel"
+    operationId: get_jwks_json
+    responses:
+      '200': 
+        description: "JSON Web Key Set Response"
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/JWKSResponse"
+      '404':
+        $ref: "#/components/responses/HttpErrorResponse"
+      '500':
+        $ref: "#/components/responses/HttpErrorResponse"
+    deprecated: false
+components:
+  schemas:
+    JWKSResponse:
+      $ref: schema/core/JWKSResponse.yaml
+  responses:
+    HttpErrorResponse:
+      $ref: "../common/response/HttpErrorResponse.yaml"
+  

src/jwks/schema/core/JWK.yaml

@@ -0,0 +1,24 @@
+type: object
+additionalProperties: true
+properties:
+  kty:
+    description: "The cryptographic algorithm family used with the key"
+    type: string
+    example: RSA
+  kid:
+    description: "The thumbprint of the key according to RFC 7638 which will be used to match a JWS or JWE 'kid' header parameter value"
+    type: string
+  use:
+    description: "The intended use of the key"
+    type: string
+    enum: [sig, enc]
+  alg:
+    description: "Identify the algorithm intented for use with the key"
+    type: string
+    example: RS256
+required:
+  - kty
+  - kid
+  - use
+  - alg
+description: "JSON Web Key Set"

src/jwks/schema/core/JWKSResponse.yaml

@@ -0,0 +1,15 @@
+type: object
+properties:
+  keys:
+    description: "An array of public JWKs used for encryption & verification. In addition to the common properties, each JWK will have properties that are key type specific."
+    type: array
+    items:
+      $ref: "#/components/schemas/JWK"
+required:
+  - keys
+description: "JSON Web Key Set"
+components:
+  schemas:
+    JWK:
+      $ref: ./JWK.yaml
+