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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml +1 -1
  3. package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml +1 -1
  4. package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml +1 -1
  5. package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +7 -7
  6. package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +7 -7
  7. package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +1 -1
  8. package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +1 -1
  9. package/docs/thirdparty-openapi3-snippets.yaml +1 -1
  10. package/fspiop/v1_0/openapi3/components/schemas/CorrelationId.yaml +1 -1
  11. package/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml +1 -1
  12. package/fspiop/v2_0/openapi3/components/schemas/CorrelationId.yaml +1 -1
  13. package/lib/fspiop/v2_0/index.d.ts +3 -0
  14. package/lib/fspiop/v2_0/index.js +9 -0
  15. package/lib/fspiop/v2_0/index.js.map +1 -0
  16. package/lib/fspiop/v2_0/json-schemas.json +19549 -0
  17. package/lib/fspiop/v2_0/schemas.d.ts +7914 -0
  18. package/lib/fspiop/v2_0/schemas.js +113 -0
  19. package/lib/fspiop/v2_0/schemas.js.map +1 -0
  20. package/lib/fspiop/v2_0/types.d.ts +106 -0
  21. package/lib/fspiop/v2_0/types.js +4 -0
  22. package/lib/fspiop/v2_0/types.js.map +1 -0
  23. package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json +55 -55
  24. package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json +55 -55
  25. package/lib/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json +66 -66
  26. package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +72 -72
  27. package/package.json +8 -7
  28. package/sdk-bulk.yaml +1 -1
  29. package/sdk-scheme-adapter/v2_0_0/backend/openapi.yaml +6 -6
  30. package/sdk-scheme-adapter/v2_0_0/components/schemas/CorrelationId.yaml +1 -1
  31. package/sdk-scheme-adapter/v2_1_0/backend/openapi.yaml +6 -6
  32. package/sdk-scheme-adapter/v2_1_0/components/schemas/CorrelationId.yaml +1 -1
package/CHANGELOG.md CHANGED
@@ -1,4 +1,11 @@
1
1
  # Changelog: [mojaloop/api-snippets](https://github.com/mojaloop/api-snippets)
2
+ ## [17.5.0](https://github.com/mojaloop/api-snippets/compare/v17.4.0...v17.5.0) (2024-06-03)
3
+
4
+
5
+ ### Features
6
+
7
+ * enable schemas for fspiop 2 0 ([#172](https://github.com/mojaloop/api-snippets/issues/172)) ([284b397](https://github.com/mojaloop/api-snippets/commit/284b397b12e8b75b0fbc109488ca24e9b4cc5410))
8
+
2
9
  ## [17.4.0](https://github.com/mojaloop/api-snippets/compare/v17.3.0...v17.4.0) (2023-12-06)
3
10
 
4
11
 
package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml CHANGED
@@ -2007,7 +2007,7 @@ components:
2007
2007
  CorrelationId:
2008
2008
  title: CorrelationId
2009
2009
  type: string
2010
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2010
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2011
2011
  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 (‘-‘).
2012
2012
  Currency:
2013
2013
  title: Currency
package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml CHANGED
@@ -2358,7 +2358,7 @@ components:
2358
2358
  title: CorrelationId
2359
2359
  type: string
2360
2360
  pattern: >-
2361
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2361
+ ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2362
2362
  description: >-
2363
2363
  Identifier that correlates all messages of the same sequence. The API
2364
2364
  data type UUID (Universally Unique Identifier) is a JSON String in
package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml CHANGED
@@ -2918,7 +2918,7 @@ components:
2918
2918
  title: CorrelationId
2919
2919
  type: string
2920
2920
  pattern: >-
2921
- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2921
+ ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2922
2922
  description: >-
2923
2923
  Identifier that correlates all messages of the same sequence. The API
2924
2924
  data type UUID (Universally Unique Identifier) is a JSON String in
package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml CHANGED
@@ -618,7 +618,7 @@ components:
618
618
  type: string
619
619
  bulkQuoteId:
620
620
  description: A Mojaloop API bulk quote identifier (UUID).
621
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
621
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
622
622
  type: string
623
623
  bulkQuoteRequest:
624
624
  description: A request for a bulk quote.
@@ -664,7 +664,7 @@ components:
664
664
  type: object
665
665
  bulkTransferId:
666
666
  description: A Mojaloop API transfer identifier (UUID).
667
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
667
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
668
668
  type: string
669
669
  bulkTransferRequest:
670
670
  properties:
@@ -1118,7 +1118,7 @@ components:
1118
1118
  type: string
1119
1119
  quoteId:
1120
1120
  description: A Mojaloop API quote identifier (UUID).
1121
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1121
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1122
1122
  type: string
1123
1123
  quoteRequest:
1124
1124
  description: A request for a quote for transfer from the DFSP backend.
@@ -1222,7 +1222,7 @@ components:
1222
1222
  type: string
1223
1223
  transactionId:
1224
1224
  description: ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote.
1225
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1225
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1226
1226
  type: string
1227
1227
  transactionRequest:
1228
1228
  description: A request for a pull based transfer.
@@ -1268,7 +1268,7 @@ components:
1268
1268
  type: object
1269
1269
  transactionRequestId:
1270
1270
  description: A Mojaloop API transaction request identifier (UUID).
1271
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1271
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1272
1272
  type: string
1273
1273
  transactionRequestResponse:
1274
1274
  description: A response to a request for a quote.
@@ -1360,7 +1360,7 @@ components:
1360
1360
  type: object
1361
1361
  transferId:
1362
1362
  description: A Mojaloop API transfer identifier (UUID).
1363
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1363
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1364
1364
  type: string
1365
1365
  transferParty:
1366
1366
  properties:
@@ -1496,7 +1496,7 @@ components:
1496
1496
  CorrelationId:
1497
1497
  title: CorrelationId
1498
1498
  type: string
1499
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1499
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1500
1500
  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 (‘-‘).
1501
1501
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
1502
1502
  bulkTransactionStatus:
package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml CHANGED
@@ -674,7 +674,7 @@ components:
674
674
  type: string
675
675
  bulkQuoteId:
676
676
  description: A Mojaloop API bulk quote identifier (UUID).
677
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
677
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
678
678
  type: string
679
679
  bulkQuoteRequest:
680
680
  description: A request for a bulk quote.
@@ -720,7 +720,7 @@ components:
720
720
  type: object
721
721
  bulkTransferId:
722
722
  description: A Mojaloop API transfer identifier (UUID).
723
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
723
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
724
724
  type: string
725
725
  bulkTransferRequest:
726
726
  properties:
@@ -1163,7 +1163,7 @@ components:
1163
1163
  type: string
1164
1164
  quoteId:
1165
1165
  description: A Mojaloop API quote identifier (UUID).
1166
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1166
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1167
1167
  type: string
1168
1168
  quoteRequest:
1169
1169
  description: A request for a quote for transfer from the DFSP backend.
@@ -1275,7 +1275,7 @@ components:
1275
1275
  type: string
1276
1276
  transactionId:
1277
1277
  description: ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote.
1278
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1278
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1279
1279
  type: string
1280
1280
  transactionRequest:
1281
1281
  description: A request for a pull based transfer.
@@ -1321,7 +1321,7 @@ components:
1321
1321
  type: object
1322
1322
  transactionRequestId:
1323
1323
  description: A Mojaloop API transaction request identifier (UUID).
1324
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1324
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1325
1325
  type: string
1326
1326
  transactionRequestResponse:
1327
1327
  description: A response to a request for a quote.
@@ -1413,7 +1413,7 @@ components:
1413
1413
  type: object
1414
1414
  transferId:
1415
1415
  description: A Mojaloop API transfer identifier (UUID).
1416
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1416
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1417
1417
  type: string
1418
1418
  transferParty:
1419
1419
  properties:
@@ -1603,7 +1603,7 @@ components:
1603
1603
  CorrelationId:
1604
1604
  title: CorrelationId
1605
1605
  type: string
1606
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1606
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
1607
1607
  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 (‘-‘).
1608
1608
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
1609
1609
  bulkTransactionStatus:
package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml CHANGED
@@ -680,7 +680,7 @@ components:
680
680
  CorrelationId:
681
681
  title: CorrelationId
682
682
  type: string
683
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
683
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
684
684
  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 (‘-‘).
685
685
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
686
686
  errorResponse:
package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml CHANGED
@@ -762,7 +762,7 @@ components:
762
762
  CorrelationId:
763
763
  title: CorrelationId
764
764
  type: string
765
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
765
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
766
766
  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 (‘-‘).
767
767
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
768
768
  errorResponse:
package/docs/thirdparty-openapi3-snippets.yaml CHANGED
@@ -2419,7 +2419,7 @@ components:
2419
2419
  CorrelationId:
2420
2420
  title: CorrelationId
2421
2421
  type: string
2422
- pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2422
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
2423
2423
  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 (‘-‘).
2424
2424
  example: b51ec534-ee48-4575-b6a9-ead2955b8069
2425
2425
  ParticipantsPostRequest:
package/fspiop/v1_0/openapi3/components/schemas/CorrelationId.yaml CHANGED
@@ -1,6 +1,6 @@
1
1
  title: CorrelationId
2
2
  type: string
3
- pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
3
+ pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
4
4
  description: >-
5
5
  Identifier that correlates all messages of the same sequence. The API data
6
6
  type UUID (Universally Unique Identifier) is a JSON String in canonical
package/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml CHANGED
@@ -1,6 +1,6 @@
1
1
  title: CorrelationId
2
2
  type: string
3
- pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
3
+ pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
4
4
  description: >-
5
5
  Identifier that correlates all messages of the same sequence. The API data
6
6
  type UUID (Universally Unique Identifier) is a JSON String in canonical
package/fspiop/v2_0/openapi3/components/schemas/CorrelationId.yaml CHANGED
@@ -1,6 +1,6 @@
1
1
  title: CorrelationId
2
2
  type: string
3
- pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
3
+ pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
4
4
  description: >-
5
5
  Identifier that correlates all messages of the same sequence. The API data
6
6
  type UUID (Universally Unique Identifier) is a JSON String in canonical
package/lib/fspiop/v2_0/index.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ export * as openapi from './openapi';
2
+ export * from './schemas';
3
+ export * from './types';
package/lib/fspiop/v2_0/index.js ADDED
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ /* eslint-disable @typescript-eslint/no-namespace */
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.openapi = void 0;
5
+ const tslib_1 = require("tslib");
6
+ exports.openapi = tslib_1.__importStar(require("./openapi"));
7
+ tslib_1.__exportStar(require("./schemas"), exports);
8
+ tslib_1.__exportStar(require("./types"), exports);
9
+ //# sourceMappingURL=index.js.map
package/lib/fspiop/v2_0/index.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/fspiop/v2_0/index.ts"],"names":[],"mappings":";AAAA,oDAAoD;;;;AAEpD,6DAAoC;AACpC,oDAAyB;AACzB,kDAAuB"}