chore: rebase master

mojaloop · Sep 14, 2020 · b9865f1 · b9865f1
1 parent 752849e
commit b9865f1
Showing 1 changed file with 73 additions and 17 deletions.
diff --git a/docs/thirdparty-openapi3-snippets.yaml b/docs/thirdparty-openapi3-snippets.yaml
@@ -239,26 +239,30 @@ components:
           description: Accounts associated with the Party.
       required:
         - account
-    AuthChannelsType:
-      title: AuthChannelsType
+    AuthorizationChannelType:
+      title: AuthorizationChannelType
       type: string
       enum:
-        - WEB
         - OTP
+        - QRCODE
+        - U2F
       description: |
-        The auth channel being used for the consentRequest.
-        - "WEB" - The Web auth channel
-        - "OTP" - The OTP auth channel
-    AuthScopesType:
-      title: AuthScopesType
+        Below are the allowed values for the enumeration AuthorizationChannelType.
+        - OTP - One-time password generated by the Payer FSP.
+        - QRCODE - QR code used as One Time Password.
+        - U2F - U2F is a new addition isolated to Thirdparty stream.
+      example: U2F
+    AuthorizationResponseType:
+      title: AuthorizationResponseType
+      description: |
+        Enum containing response information; if the customer entered the
+        authentication value, rejected the transaction, or requested a
+        resend of the authentication value.
       type: string
       enum:
-        - accounts.getBalance
-        - accounts.transfer
-      description: |
-        The scopes requested for a ConsentRequest.
-        - "accounts.getBalance" - Get the balance of a given account.
-        - "accounts.transfer" - Initiate a transfer from an account.
+        - ENTERED
+        - REJECTED
+        - RESEND
     Consent:
       title: Consent
       type: object
@@ -363,6 +367,26 @@ components:
         - initiatorId
         - scopes
         - credential
+    ConsentRequestChannelType:
+      title: ConsentRequestChannelType
+      type: string
+      enum:
+        - WEB
+        - OTP
+      description: |
+        The auth channel being used for the consentRequest.
+        - "WEB" - The Web auth channel.
+        - "OTP" - The OTP auth channel.
+    ConsentScopeType:
+      title: ConsentScopeType
+      type: string
+      enum:
+        - accounts.getBalance
+        - accounts.transfer
+      description: |
+        The scopes requested for a ConsentRequest.
+        - "accounts.getBalance" - Get the balance of a given account.
+        - "accounts.transfer" - Initiate a transfer from an account.
     ConsentStatusType:
       title: ConsentStatusType
       type: string
@@ -435,7 +459,7 @@ components:
       description: |
         The object sent in the PUT /parties/{Type}/{ID} callback.
 
-        This is a based on FSPIOP `PartiesTypeIDPutResponse` specification.
+        This is a variant based on FSPIOP `PartiesTypeIDPutResponse` specification.
         Main difference being that it returns a `Party` with the newly added
         `accounts` property.
       properties:
@@ -449,7 +473,7 @@ components:
       description: |
         Data model for the complex type Party.
 
-        This is a based on FSPIOP `Party` specification.
+        This is a variant based on FSPIOP `Party` specification.
         Main difference being the newly added `accounts` property.
       properties:
         partyIdInfo:
@@ -594,12 +618,44 @@ components:
       description: Scope + Account Identifier mapping for a Consent.
       properties:
         scope:
-          $ref: '#/components/schemas/AuthScopesType'
+          $ref: '#/components/schemas/ConsentScopeType'
         accountId:
           $ref: '#/components/schemas/AccountAddress'
       required:
         - scope
         - accountId
+    ThirdpartyAuthorizationIDPostResponse:
+      title: ThirdpartyAuthorizationIDPostResponse
+      type: object
+      description: 'The response for POST /thirdpartyRequests/transactions/{id}/authorizations request.'
+      properties:
+        challenge:
+          type: string
+          description: The original Challenge Object as a JSON string
+        value:
+          allOf:
+            - $ref: '#/components/schemas/ThirdpartyAuthorizationIDPutRequest/properties/value/allOf/0'
+          description: Base64 encoded binary string - the signed challenge
+        consentId:
+          allOf:
+            - $ref: '#/components/schemas/Consent/properties/id/allOf/0'
+          description: |
+            Common ID between the PISP and FSP for the Consent object This tells DFSP and auth-service which constent allows the PISP to initiate transaction.
+        sourceAccountId:
+          allOf:
+            - $ref: '#/components/schemas/AccountAddress'
+          description: 'DFSP specific account identifiers, e.g. `dfspa.alice.1234`'
+        status:
+          type: string
+          enum:
+            - VERIFIED
+          description: The status of the authorization.
+      required:
+        - challenge
+        - value
+        - consentId
+        - sourceAccountId
+        - status
     ThirdpartyAuthorizationIDPostRequest:
       title: ThirdpartyAuthorizationIDPostRequest
       type: object