@mojaloop/api-snippets 17.3.0 → 17.4.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

@@ -2852,7 +2852,6 @@ components:
       properties:
         party:
           $ref: '#/components/schemas/Party'
-          description: Information regarding the requested Party.
       required:
         - party
     GeoCode:

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

@@ -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