@mojaloop/api-snippets 13.0.4 → 13.0.5

package/CHANGELOG.md

@@ -1,4 +1,11 @@
 # Changelog: [mojaloop/api-snippets](https://github.com/mojaloop/api-snippets)
+### [13.0.5](https://github.com/mojaloop/api-snippets/compare/v13.0.4...v13.0.5) (2022-02-18)
+
+
+### Bug Fixes
+
+* fix enumeration for authentication response ([#118](https://github.com/mojaloop/api-snippets/issues/118)) ([29e64f0](https://github.com/mojaloop/api-snippets/commit/29e64f07c3ac217e0676d5dd6e04bf4f13eab4c0))
+
 ### [13.0.4](https://github.com/mojaloop/api-snippets/compare/v13.0.3...v13.0.4) (2021-11-03)
 
 

package/docs/thirdparty-openapi3-snippets.yaml

@@ -3027,7 +3027,7 @@ paths:
                                 - "FIDO" - A FIDO public/private keypair
                                 - "GENERIC" - A Generic public/private keypair
                             status:
-                              title: CredentialStatus
+                              title: CredentialStatusPending
                               type: string
                               enum: &ref_115
                                 - PENDING
@@ -3454,7 +3454,7 @@ paths:
                       type: object
                       properties:
                         status:
-                          title: CredentialStatus
+                          title: CredentialStatusVerified
                           type: string
                           enum: &ref_128
                             - VERIFIED
@@ -6639,14 +6639,14 @@ paths:
           application/json:
             schema:
               oneOf:
-                - title: ThirdpartyRequestsAuthorizationsIDPutResponseGeneric
+                - title: ThirdpartyRequestsAuthorizationsIDPutResponseRejected
                   type: object
                   description: >-
                     The object sent in the PUT
                     /thirdpartyRequests/authorizations/{ID} callback.
                   properties: &ref_147
                     responseType:
-                      title: AuthorizationResponseType
+                      title: AuthorizationResponseTypeRejected
                       description: |
                         The customer rejected the terms of the transfer.
                       type: string
@@ -7426,7 +7426,7 @@ paths:
         information regarding a previously created or requested authorization.
         The *{ID}*
 
-        in the URI should contain the verification request ID 
+        in the URI should contain the verification request ID
       parameters:
         - name: Accept
           in: header
@@ -7476,18 +7476,17 @@ paths:
         - sampled
       operationId: PutThirdpartyRequestsVerificationsById
       summary: PutThirdpartyRequestsVerificationsById
-      description: >
+      description: >-
         The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by
-        the Auth-Service to inform
-
-        the DFSP of a successful result in validating the verification of a
-        Thirdparty Transaction Request.
+        the Auth-Service to inform the DFSP of a successful result in validating
+        the verification of a Thirdparty Transaction Request.
 
+        If the validation fails, the auth-service will send back `PUT
+        /thirdpartyRequests/verifications/{ID}` with `authenticationResponse:
+        'REJECTED'`.
 
-        If the validation fails, The Auth-Service MUST use `PUT
-        /thirdpartyRequests/verifications/{ID}/error`
-
-        instead.
+        In unplanned error cases the Auth-Service MUST use `PUT
+        /thirdpartyRequests/verifications/{ID}/error`.
       parameters:
         - name: Content-Length
           in: header
@@ -7511,13 +7510,21 @@ paths:
               description: >-
                 The object sent in the PUT
                 /thirdpartyRequests/verifications/{ID} request.
-              properties: &ref_157
+              properties: &ref_158
                 authenticationResponse:
+                  title: AuthenticationResponse
                   type: string
-                  enum:
+                  enum: &ref_157
                     - VERIFIED
-                  description: The verification passed
-              required: &ref_158
+                    - REJECTED
+                  description: >-
+                    Below are the allowed values for the enumeration
+                    AuthenticationResponse.
+
+                    - VERIFIED - The challenge was correctly signed.
+
+                    - REJECTED - The challenge was not correctly signed.
+              required: &ref_159
                 - authenticationResponse
             example:
               authenticationResponse: VERIFIED
@@ -8490,7 +8497,7 @@ components:
         - "FIDO" - A FIDO public/private keypair
         - "GENERIC" - A Generic public/private keypair
     CredentialStatusPending:
-      title: CredentialStatus
+      title: CredentialStatusPending
       type: string
       enum: *ref_115
       description: |
@@ -8618,7 +8625,7 @@ components:
       required: *ref_127
       additionalProperties: false
     CredentialStatusVerified:
-      title: CredentialStatus
+      title: CredentialStatusVerified
       type: string
       enum: *ref_128
       description: |
@@ -8708,13 +8715,13 @@ components:
       required: *ref_145
       additionalProperties: false
     AuthorizationResponseTypeRejected:
-      title: AuthorizationResponseType
+      title: AuthorizationResponseTypeRejected
       description: |
         The customer rejected the terms of the transfer.
       type: string
       enum: *ref_146
     ThirdpartyRequestsAuthorizationsIDPutResponseRejected:
-      title: ThirdpartyRequestsAuthorizationsIDPutResponseGeneric
+      title: ThirdpartyRequestsAuthorizationsIDPutResponseRejected
       type: object
       description: >-
         The object sent in the PUT /thirdpartyRequests/authorizations/{ID}
@@ -8780,14 +8787,22 @@ components:
       description: The object sent in the POST /thirdpartyRequests/verifications request.
       properties: *ref_155
       required: *ref_156
+    AuthenticationResponse:
+      title: AuthenticationResponse
+      type: string
+      enum: *ref_157
+      description: |-
+        Below are the allowed values for the enumeration AuthenticationResponse.
+        - VERIFIED - The challenge was correctly signed.
+        - REJECTED - The challenge was not correctly signed.
     ThirdpartyRequestsVerificationsIDPutResponse:
       title: ThirdpartyRequestsVerificationsIDPutResponse
       type: object
       description: >-
         The object sent in the PUT /thirdpartyRequests/verifications/{ID}
         request.
-      properties: *ref_157
-      required: *ref_158
+      properties: *ref_158
+      required: *ref_159
   parameters:
     ID:
       name: ID

package/lib/thirdparty/index.d.ts

@@ -6,6 +6,7 @@ export declare namespace Schemas {
     type AccountsIDPutResponse = components['schemas']['AccountsIDPutResponse'];
     type Amount = components['schemas']['Amount'];
     type AmountType = components['schemas']['AmountType'];
+    type AuthenticationResponse = components['schemas']['AuthenticationResponse'];
     type AuthenticationType = components['schemas']['AuthenticationType'];
     type AuthorizationChannelType = components['schemas']['AuthorizationChannelType'];
     type AuthorizationResponseType = components['schemas']['AuthorizationResponseType'];

package/lib/thirdparty/openapi.d.ts

@@ -16318,11 +16318,9 @@ export interface operations {
         };
     };
     /**
-     * The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by the Auth-Service to inform
-     * the DFSP of a successful result in validating the verification of a Thirdparty Transaction Request.
-     *
-     * If the validation fails, The Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`
-     * instead.
+     * The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by the Auth-Service to inform the DFSP of a successful result in validating the verification of a Thirdparty Transaction Request.
+     * If the validation fails, the auth-service will send back `PUT /thirdpartyRequests/verifications/{ID}` with `authenticationResponse: 'REJECTED'`.
+     * In unplanned error cases the Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`.
      */
     PutThirdpartyRequestsVerificationsById: {
         parameters: {
@@ -16338,9 +16336,11 @@ export interface operations {
         requestBody: {
             "application/json": {
                 /**
-                 * The verification passed
+                 * Below are the allowed values for the enumeration AuthenticationResponse.
+                 * - VERIFIED - The challenge was correctly signed.
+                 * - REJECTED - The challenge was not correctly signed.
                  */
-                authenticationResponse: "VERIFIED";
+                authenticationResponse: "VERIFIED" | "REJECTED";
             };
         };
         responses: {
@@ -20450,14 +20450,22 @@ export interface components {
              */
             genericSignedPayload: string;
         };
+        /**
+         * Below are the allowed values for the enumeration AuthenticationResponse.
+         * - VERIFIED - The challenge was correctly signed.
+         * - REJECTED - The challenge was not correctly signed.
+         */
+        AuthenticationResponse: "VERIFIED" | "REJECTED";
         /**
          * The object sent in the PUT /thirdpartyRequests/verifications/{ID} request.
          */
         ThirdpartyRequestsVerificationsIDPutResponse: {
             /**
-             * The verification passed
+             * Below are the allowed values for the enumeration AuthenticationResponse.
+             * - VERIFIED - The challenge was correctly signed.
+             * - REJECTED - The challenge was not correctly signed.
              */
-            authenticationResponse: "VERIFIED";
+            authenticationResponse: "VERIFIED" | "REJECTED";
         };
     };
     responses: {

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@mojaloop/api-snippets",
-  "version": "13.0.4",
+  "version": "13.0.5",
   "description": "Mojaloop API specification reusable snippets",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
+  "engines": {
+    "node": ">=12.0.0"
+  },
   "scripts": {
     "audit:resolve": "SHELL=sh resolve-audit --production",
     "audit:check": "SHELL=sh check-audit --production",

package/thirdparty/openapi3/components/schemas/AuthenticationResponse.yaml

@@ -0,0 +1,9 @@
+title: AuthenticationResponse
+type: string
+enum:
+  - VERIFIED
+  - REJECTED
+description: |-
+  Below are the allowed values for the enumeration AuthenticationResponse.
+  - VERIFIED - The challenge was correctly signed.
+  - REJECTED - The challenge was not correctly signed.

package/thirdparty/openapi3/components/schemas/AuthorizationResponseTypeRejected.yaml

@@ -1,4 +1,4 @@
-title: AuthorizationResponseType
+title: AuthorizationResponseTypeRejected
 description: |
   The customer rejected the terms of the transfer.
 type: string

package/thirdparty/openapi3/components/schemas/CredentialStatusPending.yaml

@@ -1,4 +1,4 @@
-title: CredentialStatus
+title: CredentialStatusPending
 type: string
 enum:
   - PENDING

package/thirdparty/openapi3/components/schemas/CredentialStatusVerified.yaml

@@ -1,4 +1,4 @@
-title: CredentialStatus
+title: CredentialStatusVerified
 type: string
 enum:
   - VERIFIED

package/thirdparty/openapi3/components/schemas/SignedCredential.yaml

@@ -12,7 +12,7 @@ properties:
     $ref: ./CredentialType.yaml
   # The challenge has signed but not yet verified.
   status:
-   $ref: ./CredentialStatusPending.yaml
+    $ref: ./CredentialStatusPending.yaml
   genericPayload:
     $ref: ./GenericCredential.yaml
   fidoPayload:

package/thirdparty/openapi3/components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseRejected.yaml

@@ -1,8 +1,8 @@
-title: ThirdpartyRequestsAuthorizationsIDPutResponseGeneric
+title: ThirdpartyRequestsAuthorizationsIDPutResponseRejected
 type: object
 description: 'The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.'
 properties:
-  responseType: 
-    $ref: ./AuthorizationResponseTypeRejected.yaml  
+  responseType:
+    $ref: ./AuthorizationResponseTypeRejected.yaml
 required:
   - responseType

package/thirdparty/openapi3/components/schemas/ThirdpartyRequestsVerificationsIDPutResponse.yaml

@@ -3,10 +3,6 @@ type: object
 description: The object sent in the PUT /thirdpartyRequests/verifications/{ID} request.
 properties:
   authenticationResponse:
-    type: string
-    enum:
-      - VERIFIED
-    description: 'The verification passed'
+    $ref: ./AuthenticationResponse.yaml
 required:
   - authenticationResponse
-  

package/thirdparty/openapi3/components/schemas/index.yaml

@@ -9,11 +9,13 @@ Amount:
 AmountType:
   $ref: ./AmountType.yaml
 AuthenticationInfo:
-   $ref: ./AuthenticationInfo.yaml
+  $ref: ./AuthenticationInfo.yaml
+AuthenticationResponse:
+  $ref: ./AuthenticationResponse.yaml
 AuthenticationType:
   $ref: ./AuthenticationType.yaml
 AuthenticationValue:
-   $ref: ./AuthenticationValue.yaml
+  $ref: ./AuthenticationValue.yaml
 AuthorizationChannelType:
   $ref: ./AuthorizationChannelType.yaml
 AuthorizationResponseType:

package/thirdparty/openapi3/paths/thirdpartyRequests_verifications_ID.yaml

@@ -20,7 +20,7 @@ get:
   description: |
     The HTTP request `/thirdpartyRequests/verifications/{ID}` is used to get
     information regarding a previously created or requested authorization. The *{ID}*
-    in the URI should contain the verification request ID 
+    in the URI should contain the verification request ID
   parameters:
     #Headers
     - $ref: ../components/parameters/Accept.yaml
@@ -49,12 +49,14 @@ put:
     - sampled
   operationId: PutThirdpartyRequestsVerificationsById
   summary: PutThirdpartyRequestsVerificationsById
-  description: |
+  description: >-
     The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by the Auth-Service to inform
     the DFSP of a successful result in validating the verification of a Thirdparty Transaction Request.
 
-    If the validation fails, The Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`
-    instead.
+    If the validation fails, the auth-service will send back `PUT /thirdpartyRequests/verifications/{ID}`
+    with `authenticationResponse: 'REJECTED'`.
+
+    In unplanned error cases the Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`.
   parameters:
     - $ref: ../components/parameters/Content-Length.yaml
   requestBody: