@mojaloop/api-snippets 13.0.6 → 13.0.9

package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/VerifiedCredential.yaml

@@ -4,21 +4,20 @@ description: |
   A credential used to allow a user to prove their identity and access
   to an account with a DFSP.
 
-  VerifiedCredential is a special formatting of the credential to allow us to be
+  VerifiedCredential is a special formatting of Credential to allow us to be
   more explicit about the `status` field - it should only ever be VERIFIED when
   updating a credential.
 properties:
   credentialType:
     $ref: ./CredentialType.yaml
   status:
-    type: string
-    enum:
-      - VERIFIED
-    description: The Credential is valid, and ready to be used by the PISP.
-  payload:
+    $ref: ./CredentialStatusVerified.yaml
+  genericPayload:
+    $ref: ./GenericCredential.yaml
+  fidoPayload:
     $ref: ./FIDOPublicKeyCredentialAttestation.yaml
 required:
   - credentialType
   - status
-  - payload
 additionalProperties: false
+

package/thirdparty/{openapi3 → v1_0/openapi3}/openapi.yaml

@@ -29,20 +29,20 @@ paths:
           application/json:
             schema:
               oneOf:
-                - $ref: './components/schemas/AuthorizationChannelType.yaml'
+                - $ref: './components/schemas/ParticipantsIDPutResponse.yaml'
+                - $ref: './components/schemas/PartiesTypeIDPutResponse.yaml'
+                - $ref: './components/schemas/QuotesIDPutResponse.yaml'
+                - $ref: './components/schemas/ThirdpartyRequestsTransactionsIDPatchResponse.yaml'
                 - $ref: './components/schemas/AuthorizationResponseType.yaml'
-                - $ref: './components/schemas/AuthorizationsPostRequest.yaml'
+                - $ref: './components/schemas/ConsentStatusIssued.yaml'
                 - $ref: './components/schemas/IlpFulfilment.yaml'
+                - $ref: './components/schemas/Integer.yaml'
                 - $ref: './components/schemas/Note.yaml'
-                - $ref: './components/schemas/PartyResult.yaml'
-                - $ref: './components/schemas/ParticipantsIDPutResponse.yaml'
-                - $ref: './components/schemas/ParticipantsPostRequest.yaml'
-                - $ref: './components/schemas/PartiesTypeIDPutResponse.yaml'
                 - $ref: './components/schemas/PartyIdInfoTPLink.yaml'
+                - $ref: './components/schemas/PartyResult.yaml'
                 - $ref: './components/schemas/ServiceType.yaml'
-                - $ref: './components/schemas/ThirdpartyRequestsTransactionsIDPatchResponse.yaml'
-                - $ref: './components/schemas/TransactionRequestsPostRequest.yaml'
-                - $ref: './components/schemas/TransactionState.yaml'
+                - $ref: './components/schemas/ParticipantsPostRequest.yaml'
+                - $ref: './components/schemas/QuotesPostRequest.yaml'
       responses:
         200:
           description: Ok

package/thirdparty/{openapi3 → v1_0/openapi3}/paths/accounts_ID_error.yaml

@@ -27,7 +27,7 @@ put:
     content:
       application/json:
         schema:
-          $ref: '../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml'
+          $ref: '../../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml'
   responses:
     200:
       $ref: ../components/responses/200.yaml

package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consentRequests_ID.yaml

@@ -15,8 +15,8 @@ get:
   operationId: GetConsentRequestsById
   summary: GetConsentRequestsById
   description: |
-    The HTTP request `GET /consentRequests/{ID}` is used to get information about a previously 
-    requested consent. The *{ID}* in the URI should contain the consentRequestId that was assigned to the 
+    The HTTP request `GET /consentRequests/{ID}` is used to get information about a previously
+    requested consent. The *{ID}* in the URI should contain the consentRequestId that was assigned to the
     request by the PISP when the PISP originated the request.
   tags:
     - consentRequests
@@ -49,14 +49,14 @@ put:
   operationId: UpdateConsentRequest
   summary: UpdateConsentRequest
   description: |
-    A DFSP uses this callback to (1) inform the PISP that the consentRequest has been accepted, 
+    A DFSP uses this callback to (1) inform the PISP that the consentRequest has been accepted,
     and (2) communicate to the PISP which `authChannel` it should use to authenticate their user
     with.
 
-    When a PISP requests a series of permissions from a DFSP on behalf of a DFSP’s customer, not all 
-    the permissions requested may be granted by the DFSP. Conversely, the out-of-band authorization 
+    When a PISP requests a series of permissions from a DFSP on behalf of a DFSP’s customer, not all
+    the permissions requested may be granted by the DFSP. Conversely, the out-of-band authorization
     process  may result in additional privileges being granted by the account holder to the PISP. The
-    **PUT /consentRequests/**_{ID}_ resource returns the current state of the permissions relating to a 
+    **PUT /consentRequests/**_{ID}_ resource returns the current state of the permissions relating to a
     particular authorization request.
   parameters:
     - $ref: ../components/parameters/Content-Length.yaml

package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consentRequests_ID_error.yaml

@@ -26,7 +26,7 @@ put:
     content:
       application/json:
         schema:
-          $ref: '../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml'
+          $ref: '../../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml'
   responses:
     200:
       $ref: ../components/responses/200.yaml

package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consents_ID.yaml

@@ -13,7 +13,7 @@ parameters:
   - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
 get:
   description: >
-    The **GET /consents/**_{ID}_ resource allows a party to enquire after the status of a consent. The 
+    The **GET /consents/**_{ID}_ resource allows a party to enquire after the status of a consent. The
     *{ID}* used in the URI of the request should be the consent request ID which was used to identify
     the consent when it was created.
   tags:
@@ -138,7 +138,7 @@ delete:
     Used by PISP, DFSP
 
     The **DELETE /consents/**_{ID}_ request is used to request the revocation of a previously agreed consent.
-    For tracing and auditing purposes, the switch should be sure not to delete the consent physically; 
+    For tracing and auditing purposes, the switch should be sure not to delete the consent physically;
     instead, information relating to the consent should be marked as deleted and requests relating to the
     consent should not be honoured.
   operationId: DeleteConsentByID

package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consents_ID_error.yaml

@@ -26,7 +26,7 @@ put:
     content:
       application/json:
         schema:
-          $ref: '../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml'
+          $ref: '../../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml'
   responses:
     200:
       $ref: ../components/responses/200.yaml

package/thirdparty/{openapi3 → v1_0/openapi3}/paths/participants_ID_error.yaml

@@ -30,7 +30,7 @@ put:
     content:
       application/json:
         schema:
-          $ref: ../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml
+          $ref: ../../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml
   responses:
     '200':
       $ref: ../components/responses/200.yaml

package/thirdparty/{openapi3 → v1_0/openapi3}/paths/participants_Type_ID_error.yaml

@@ -30,7 +30,7 @@ put:
     content:
       application/json:
         schema:
-          $ref: ../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml
+          $ref: ../../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml
   responses:
     '200':
       $ref: ../components/responses/200.yaml

package/thirdparty/{openapi3 → v1_0/openapi3}/paths/services_ServiceType_error.yaml

@@ -28,7 +28,7 @@ put:
     content:
       application/json:
         schema:
-          $ref: '../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml'
+          $ref: '../../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml'
   responses:
     200:
       $ref: ../components/responses/200.yaml

package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_authorizations.yaml

@@ -33,7 +33,7 @@ post:
       $ref: ../components/responses/202.yaml
     400:
       $ref: ../components/responses/400.yaml
-    401: 
+    401:
       $ref: ../components/responses/401.yaml
     403:
       $ref: ../components/responses/403.yaml

package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_authorizations_ID.yaml

@@ -13,8 +13,8 @@ parameters:
   - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
 get:
   description: |
-    The HTTP request **GET /thirdpartyRequests/authorizations/**_{ID}_ is used to get information relating 
-    to a previously issued authorization request. The *{ID}* in the request should match the 
+    The HTTP request **GET /thirdpartyRequests/authorizations/**_{ID}_ is used to get information relating
+    to a previously issued authorization request. The *{ID}* in the request should match the
     `authorizationRequestId` which was given when the authorization request was created.
   operationId: GetThirdpartyRequestsAuthorizationsById
   summary: GetThirdpartyRequestsAuthorizationsById
@@ -43,7 +43,7 @@ get:
       $ref: ../components/responses/503.yaml
 put:
   description: |
-    After receiving the **POST /thirdpartyRequests/authorizations**, the PISP will present the details of the 
+    After receiving the **POST /thirdpartyRequests/authorizations**, the PISP will present the details of the
     transaction to their user, and request that the client sign the `challenge` field using the credential
     they previously registered.
 

package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_authorizations_ID_error.yaml

@@ -34,7 +34,7 @@ put:
     content:
       application/json:
         schema:
-          $ref: '../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml'
+          $ref: '../../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml'
   responses:
     200:
       $ref: ../components/responses/200.yaml

package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_transactions.yaml

@@ -44,4 +44,4 @@ post:
     501:
       $ref: ../components/responses/501.yaml
     503:
-      $ref: ../components/responses/503.yaml
+      $ref: ../components/responses/503.yaml

package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_transactions_ID_error.yaml

@@ -31,7 +31,7 @@ put:
     content:
       application/json:
         schema:
-          $ref: '../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml'
+          $ref: '../../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml'
   responses:
     200:
       $ref: ../components/responses/200.yaml

package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_verifications_ID_error.yaml

@@ -28,7 +28,7 @@ put:
     content:
       application/json:
         schema:
-          $ref: '../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml'
+          $ref: '../../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformationObject.yaml'
   responses:
     200:
       $ref: ../components/responses/200.yaml