@mojaloop/api-snippets 17.3.0 → 17.5.0-snapshot.0

package/CHANGELOG.md

@@ -1,4 +1,11 @@
 # Changelog: [mojaloop/api-snippets](https://github.com/mojaloop/api-snippets)
+## [17.4.0](https://github.com/mojaloop/api-snippets/compare/v17.3.0...v17.4.0) (2023-12-06)
+
+
+### Features
+
+* **mojaloop/3573:** add fx to sdk ([#170](https://github.com/mojaloop/api-snippets/issues/170)) ([d3ffee5](https://github.com/mojaloop/api-snippets/commit/d3ffee5d60dc5cc339f7b520d527a27d86da0334))
+
 ## [17.3.0](https://github.com/mojaloop/api-snippets/compare/v17.2.5...v17.3.0) (2023-12-05)
 
 

package/README.md

@@ -184,3 +184,15 @@ the `npm run build:dto` script is already executing linting with auto-fixing
 there is pre-commit hook setup witch do a linting for staged files.
 ### DTO testing
 - testing of DTO declarations
+
+### Comparing openapi specification - useful commands
+
+For difference:
+```
+docker run --rm -t -v $(pwd)/docs:/docs:ro tufin/oasdiff diff /docs/fspiop-rest-v1.1-openapi3-snippets.yaml /docs/fspiop-rest-v2.0-openapi3-snippets.yaml -f text
+```
+
+For changelog:
+```
+docker run --rm -t -v $(pwd)/docs:/docs:ro tufin/oasdiff changelog /docs/fspiop-rest-v1.1-openapi3-snippets.yaml /docs/fspiop-rest-v2.0-openapi3-snippets.yaml
+```

package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml

@@ -2007,7 +2007,7 @@ components:
     CorrelationId:
       title: CorrelationId
       type: string
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       description: Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
     Currency:
       title: Currency
@@ -2852,7 +2852,6 @@ components:
       properties:
         party:
           $ref: '#/components/schemas/Party'
-          description: Information regarding the requested Party.
       required:
         - party
     GeoCode:

package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml

@@ -2358,7 +2358,7 @@ components:
       title: CorrelationId
       type: string
       pattern: >-
-        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       description: >-
         Identifier that correlates all messages of the same sequence. The API
         data type UUID (Universally Unique Identifier) is a JSON String in

package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml

@@ -2918,7 +2918,7 @@ components:
       title: CorrelationId
       type: string
       pattern: >-
-        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       description: >-
         Identifier that correlates all messages of the same sequence. The API
         data type UUID (Universally Unique Identifier) is a JSON String in

package/docs/index.html

@@ -44,6 +44,10 @@
           {url: "fspiop-rest-v1.1-openapi3-snippets.yaml", name: "v1.1"},
           {url: "fspiop-rest-v2.0-openapi3-snippets.yaml", name: "v2.0"},
           {url: "thirdparty-openapi3-snippets.yaml", name: "thirdparty"},
+          {url: "sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml", name: "SDK Backend v2.0.0"},
+          {url: "sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml", name: "SDK Outbound v2.0.0"},
+          {url: "sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml", name: "SDK Backend v2.1.0"},
+          {url: "sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml", name: "SDK Outbound v2.1.0"},
         ],
         dom_id: '#swagger-ui',
         deepLinking: true,

package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml

@@ -618,7 +618,7 @@ components:
       type: string
     bulkQuoteId:
       description: A Mojaloop API bulk quote identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     bulkQuoteRequest:
       description: A request for a bulk quote.
@@ -664,7 +664,7 @@ components:
       type: object
     bulkTransferId:
       description: A Mojaloop API transfer identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     bulkTransferRequest:
       properties:
@@ -1118,7 +1118,7 @@ components:
       type: string
     quoteId:
       description: A Mojaloop API quote identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     quoteRequest:
       description: A request for a quote for transfer from the DFSP backend.
@@ -1222,7 +1222,7 @@ components:
       type: string
     transactionId:
       description: ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote.
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     transactionRequest:
       description: A request for a pull based transfer.
@@ -1268,7 +1268,7 @@ components:
       type: object
     transactionRequestId:
       description: A Mojaloop API transaction request identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     transactionRequestResponse:
       description: A response to a request for a quote.
@@ -1360,7 +1360,7 @@ components:
       type: object
     transferId:
       description: A Mojaloop API transfer identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     transferParty:
       properties:
@@ -1496,7 +1496,7 @@ components:
     CorrelationId:
       title: CorrelationId
       type: string
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       description: Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
       example: b51ec534-ee48-4575-b6a9-ead2955b8069
     bulkTransactionStatus:
@@ -2038,7 +2038,7 @@ components:
       example: RESERVED
     transferError:
       type: object
-      description: This object represents a Mojaloop API error received at any time during the transfer process
+      description: This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.
       properties:
         httpStatusCode:
           type: integer