@mojaloop/api-snippets 17.2.3 → 17.2.5

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 (45) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +1 -1
  3. package/audit-ci.jsonc +8 -0
  4. package/docs/dist/openapi.yaml +2 -2
  5. package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml +2 -2
  6. package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml +4 -4
  7. package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +1 -1
  8. package/docs/thirdparty-openapi3-snippets.yaml +19 -19
  9. package/fspiop/v1_0/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +1 -1
  10. package/fspiop/v1_0/openapi3/components/parameters/FSPIOP-URI.yaml +1 -1
  11. package/fspiop/v1_1/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +1 -1
  12. package/fspiop/v1_1/openapi3/components/parameters/FSPIOP-URI.yaml +1 -1
  13. package/fspiop/v1_1/openapi3/openapi.yaml +2 -2
  14. package/lib/fspiop/v1_0/openapi.d.ts +3 -2
  15. package/lib/fspiop/v1_1/openapi.d.ts +3 -2
  16. package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +1 -0
  17. package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +1 -0
  18. package/lib/thirdparty/openapi.d.ts +19 -18
  19. package/package.json +18 -17
  20. package/sdk-bulk.yaml +1 -1
  21. package/sdk-outbound-old.yaml +1 -1
  22. package/sdk-scheme-adapter/v2_0_0/outbound/openapi.yaml +1 -1
  23. package/thirdparty/v1_0/openapi3/components/schemas/Account.yaml +1 -1
  24. package/thirdparty/v1_0/openapi3/components/schemas/AccountAddress.yaml +1 -1
  25. package/thirdparty/v1_0/openapi3/components/schemas/AccountList.yaml +1 -1
  26. package/thirdparty/v1_0/openapi3/components/schemas/AccountsIDPutResponse.yaml +1 -1
  27. package/thirdparty/v1_0/openapi3/components/schemas/AuthenticatorAssertionResponse.yaml +1 -1
  28. package/thirdparty/v1_0/openapi3/components/schemas/AuthenticatorAttestationResponse.yaml +1 -1
  29. package/thirdparty/v1_0/openapi3/components/schemas/ConsentRequestsIDPatchRequest.yaml +1 -1
  30. package/thirdparty/v1_0/openapi3/components/schemas/ConsentRequestsPostRequest.yaml +1 -1
  31. package/thirdparty/v1_0/openapi3/components/schemas/CredentialType.yaml +1 -1
  32. package/thirdparty/v1_0/openapi3/components/schemas/FIDOPublicKeyCredentialAssertion.yaml +1 -1
  33. package/thirdparty/v1_0/openapi3/components/schemas/Scope.yaml +1 -1
  34. package/thirdparty/v1_0/openapi3/components/schemas/ServiceType.yaml +1 -1
  35. package/thirdparty/v1_0/openapi3/components/schemas/ServicesServiceTypePutResponse.yaml +1 -1
  36. package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsAuthorizationsPostRequest.yaml +1 -1
  37. package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsTransactionsIDPatchResponse.yaml +1 -1
  38. package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsTransactionsIDPutResponse.yaml +1 -1
  39. package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsTransactionsPostRequest.yaml +1 -1
  40. package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsVerificationsIDPutResponse.yaml +1 -1
  41. package/thirdparty/v1_0/openapi3/openapi.yaml +1 -1
  42. package/thirdparty/v1_0/openapi3/thirdparty-dfsp-api.template.yaml +1 -1
  43. package/thirdparty/v1_0/openapi3/thirdparty-dfsp-api.yaml +17 -17
  44. package/thirdparty/v1_0/openapi3/thirdparty-pisp-api.template.yaml +1 -1
  45. package/thirdparty/v1_0/openapi3/thirdparty-pisp-api.yaml +17 -17
package/CHANGELOG.md CHANGED
@@ -1,4 +1,18 @@
1
1
  # Changelog: [mojaloop/api-snippets](https://github.com/mojaloop/api-snippets)
2
+ ### [17.2.5](https://github.com/mojaloop/api-snippets/compare/v17.2.4...v17.2.5) (2023-09-20)
3
+
4
+
5
+ ### Maintenance
6
+
7
+ * master to main migration ([#168](https://github.com/mojaloop/api-snippets/issues/168)) ([0e20935](https://github.com/mojaloop/api-snippets/commit/0e20935a3c4acb0aff4627bbfef5139f823dc471))
8
+
9
+ ### [17.2.4](https://github.com/mojaloop/api-snippets/compare/v17.2.3...v17.2.4) (2023-08-23)
10
+
11
+
12
+ ### CI/CD
13
+
14
+ * **mojaloop/#3454:** remove unneeded configs ([#166](https://github.com/mojaloop/api-snippets/issues/166)) ([29f792f](https://github.com/mojaloop/api-snippets/commit/29f792fa6a7a221a57d3d5bca36f0e57316c9360)), closes [mojaloop/#3454](https://github.com/mojaloop/api-snippets/issues/3454) [mojaloop/#3454](https://github.com/mojaloop/api-snippets/issues/3454)
15
+
2
16
  ### [17.2.3](https://github.com/mojaloop/api-snippets/compare/v17.2.2...v17.2.3) (2023-08-17)
3
17
 
4
18
 
package/README.md CHANGED
@@ -42,7 +42,7 @@ Validate the result file.
42
42
  ## Swagger-UI
43
43
 
44
44
  The snippets specification is previewable using swagger-ui. Swagger-UI files
45
- are found in `docs/dist/`. Github pages uses the master branch `docs/` folder
45
+ are found in `docs/dist/`. Github pages uses the main branch `docs/` folder
46
46
  to build the page found at https://docs.mojaloop.io/api-snippets/
47
47
 
48
48
  ## Dev Tools
package/audit-ci.jsonc ADDED
@@ -0,0 +1,8 @@
1
+ {
2
+ "$schema": "https://github.com/IBM/audit-ci/raw/main/docs/schema.json",
3
+ // audit-ci supports reading JSON, JSONC, and JSON5 config files.
4
+ // Only use one of ["low": true, "moderate": true, "high": true, "critical": true]
5
+ "moderate": true,
6
+ "allowlist": [
7
+ ]
8
+ }
@@ -1356,7 +1356,7 @@ components:
1356
1356
  schema:
1357
1357
  type: string
1358
1358
  required: false
1359
- description: 'The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).'
1359
+ description: 'The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).'
1360
1360
  FSPIOP-Signature:
1361
1361
  name: FSPIOP-Signature
1362
1362
  in: header
@@ -1377,7 +1377,7 @@ components:
1377
1377
  schema:
1378
1378
  type: string
1379
1379
  required: false
1380
- description: 'The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).'
1380
+ description: 'The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).'
1381
1381
  ID:
1382
1382
  name: ID
1383
1383
  in: path
@@ -4177,7 +4177,7 @@ components:
4177
4177
  API for signature verification, should contain the service URI. Required
4178
4178
  if signature verification is used, for more information, see [the API
4179
4179
  Signature
4180
- document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).
4180
+ document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
4181
4181
  FSPIOP-HTTP-Method:
4182
4182
  name: FSPIOP-HTTP-Method
4183
4183
  in: header
@@ -4189,7 +4189,7 @@ components:
4189
4189
  by the API for signature verification, should contain the service HTTP
4190
4190
  method. Required if signature verification is used, for more
4191
4191
  information, see [the API Signature
4192
- document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).
4192
+ document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
4193
4193
  Accept:
4194
4194
  name: Accept
4195
4195
  in: header
@@ -4,14 +4,14 @@ info:
4
4
  title: Open API for FSP Interoperability (FSPIOP)
5
5
  description: >-
6
6
  Based on [API Definition updated on 2020-05-19 Version
7
- 1.1](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/v1.1-document-set/API%20Definition_v1.1.pdf).
7
+ 1.1](https://github.com/mojaloop/mojaloop-specification/blob/main/documents/v1.1-document-set/API%20Definition_v1.1.pdf).
8
8
 
9
9
 
10
10
  **Note:** The API supports a maximum size of 65536 bytes (64 Kilobytes) in
11
11
  the HTTP header.
12
12
  license:
13
13
  name: CC BY-ND 4.0
14
- url: https://github.com/mojaloop/mojaloop-specification/blob/master/LICENSE.md
14
+ url: https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md
15
15
  contact:
16
16
  name: Sam Kummary
17
17
  url: https://github.com/mojaloop/mojaloop-specification/issues
@@ -3730,7 +3730,7 @@ components:
3730
3730
  API for signature verification, should contain the service URI. Required
3731
3731
  if signature verification is used, for more information, see [the API
3732
3732
  Signature
3733
- document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).
3733
+ document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
3734
3734
  FSPIOP-HTTP-Method:
3735
3735
  name: FSPIOP-HTTP-Method
3736
3736
  in: header
@@ -3742,7 +3742,7 @@ components:
3742
3742
  by the API for signature verification, should contain the service HTTP
3743
3743
  method. Required if signature verification is used, for more
3744
3744
  information, see [the API Signature
3745
- document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).
3745
+ document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
3746
3746
  Accept:
3747
3747
  name: Accept
3748
3748
  in: header
@@ -17,7 +17,7 @@ info:
17
17
  the term "FSP" is equal to the term "DFSP".
18
18
  license:
19
19
  name: Apache License Version 2.0, January 2004
20
- url: https://github.com/mojaloop/documentation/blob/master/LICENSE.md
20
+ url: https://github.com/mojaloop/documentation/blob/main/LICENSE.md
21
21
  version: 1.0.0
22
22
  paths:
23
23
  /:
@@ -4,7 +4,7 @@ info:
4
4
  title: Thirdparty Snippets
5
5
  description: |
6
6
  Based on sequence diagrams
7
- (https://github.com/mojaloop/pisp/tree/master/docs/out).
7
+ (https://github.com/mojaloop/pisp/tree/main/docs/out).
8
8
  This is a work in progress.
9
9
  license:
10
10
  name: TBD
@@ -2619,7 +2619,7 @@ components:
2619
2619
  which was originally used by the PISP to identify the transaction
2620
2620
  request.
2621
2621
 
2622
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
2622
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
2623
2623
  properties:
2624
2624
  completedTimestamp:
2625
2625
  $ref: '#/components/schemas/DateTime'
@@ -2710,7 +2710,7 @@ components:
2710
2710
  features enabled. - PISP - Enum used to query for PISPs. - AUTH_SERVICE
2711
2711
  - Participants which provide Authentication Services.
2712
2712
 
2713
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3229-servicetype
2713
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3229-servicetype
2714
2714
  enum:
2715
2715
  - THIRD_PARTY_DFSP
2716
2716
  - PISP
@@ -3021,7 +3021,7 @@ components:
3021
3021
  is at the discretion of the address space owner (the payer DFSP in this
3022
3022
  case).
3023
3023
 
3024
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
3024
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
3025
3025
  pattern: ^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$
3026
3026
  minLength: 1
3027
3027
  maxLength: 1023
@@ -3031,7 +3031,7 @@ components:
3031
3031
  description: >-
3032
3032
  Data model for the complex type Account.
3033
3033
 
3034
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
3034
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
3035
3035
  properties:
3036
3036
  accountNickname:
3037
3037
  $ref: '#/components/schemas/Name'
@@ -3050,7 +3050,7 @@ components:
3050
3050
  The AccountList data model is used to hold information about the
3051
3051
  accounts that a party controls.
3052
3052
 
3053
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
3053
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
3054
3054
  items:
3055
3055
  $ref: '#/components/schemas/Account'
3056
3056
  minItems: 1
@@ -3068,7 +3068,7 @@ components:
3068
3068
  result of a request for accounts information. The identifier ID given in
3069
3069
  the call are the values given in the original request.
3070
3070
 
3071
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
3071
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
3072
3072
  properties:
3073
3073
  accounts:
3074
3074
  $ref: '#/components/schemas/AccountList'
@@ -3116,7 +3116,7 @@ components:
3116
3116
  DFSP, an account on which access types can be requested or granted. It
3117
3117
  also defines the access types which are requested or granted.
3118
3118
 
3119
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
3119
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
3120
3120
  properties:
3121
3121
  address:
3122
3122
  $ref: '#/components/schemas/AccountAddress'
@@ -3163,7 +3163,7 @@ components:
3163
3163
  Callback: PUT /consentRequests/{ID} Error callback: PUT
3164
3164
  /consentRequests/{ID}/error Data model - see below url
3165
3165
 
3166
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
3166
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
3167
3167
  properties:
3168
3168
  consentRequestId:
3169
3169
  $ref: '#/components/schemas/CorrelationId'
@@ -3299,7 +3299,7 @@ components:
3299
3299
  PISP will receive a token which they can use to prove to the DFSP that
3300
3300
  the user trusts this PISP.
3301
3301
 
3302
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
3302
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
3303
3303
  properties:
3304
3304
  authToken:
3305
3305
  $ref: '#/components/schemas/BinaryString'
@@ -3319,7 +3319,7 @@ components:
3319
3319
  "GENERIC" - The credential is based on a simple public key validation.
3320
3320
  Its payload is a GenericCredential object.
3321
3321
 
3322
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
3322
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
3323
3323
  CredentialStatusPending:
3324
3324
  title: CredentialStatusPending
3325
3325
  type: string
@@ -3685,7 +3685,7 @@ components:
3685
3685
  Callback - PUT /services/{ServiceType} Error Callback - PUT
3686
3686
  /services/{ServiceType}/error Data Model - Empty body
3687
3687
 
3688
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype
3688
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype
3689
3689
  properties:
3690
3690
  providers:
3691
3691
  type: array
@@ -3714,7 +3714,7 @@ components:
3714
3714
  PUT /thirdpartyRequests/transactions/{ID}/error Data Model - See link
3715
3715
  below
3716
3716
 
3717
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
3717
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
3718
3718
  properties:
3719
3719
  transactionRequestId:
3720
3720
  allOf:
@@ -3778,7 +3778,7 @@ components:
3778
3778
  /thirdpartyRequests/transactions/{ID}), the DFSP will send this
3779
3779
  callback.
3780
3780
 
3781
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
3781
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
3782
3782
  properties:
3783
3783
  transactionId:
3784
3784
  $ref: '#/components/schemas/CorrelationId'
@@ -3804,7 +3804,7 @@ components:
3804
3804
  PUT /thirdpartyRequests/authorizations/{ID}/error Data Model - See below
3805
3805
  url
3806
3806
 
3807
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
3807
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
3808
3808
  type: object
3809
3809
  properties:
3810
3810
  authorizationRequestId:
@@ -3914,7 +3914,7 @@ components:
3914
3914
  For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
3915
3915
 
3916
3916
 
3917
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
3917
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
3918
3918
  properties:
3919
3919
  id:
3920
3920
  type: string
@@ -4125,7 +4125,7 @@ components:
4125
4125
  request the check, or the {ID} that was used in the GET
4126
4126
  /thirdpartyRequests/verifications/{ID}.
4127
4127
 
4128
- https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
4128
+ https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
4129
4129
  properties:
4130
4130
  authenticationResponse:
4131
4131
  $ref: '#/components/schemas/AuthenticationResponse'
@@ -4229,7 +4229,7 @@ components:
4229
4229
  API for signature verification, should contain the service URI. Required
4230
4230
  if signature verification is used, for more information, see [the API
4231
4231
  Signature
4232
- document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).
4232
+ document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
4233
4233
  FSPIOP-HTTP-Method:
4234
4234
  name: FSPIOP-HTTP-Method
4235
4235
  in: header
@@ -4241,7 +4241,7 @@ components:
4241
4241
  by the API for signature verification, should contain the service HTTP
4242
4242
  method. Required if signature verification is used, for more
4243
4243
  information, see [the API Signature
4244
- document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).
4244
+ document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
4245
4245
  Accept:
4246
4246
  name: Accept
4247
4247
  in: header
@@ -8,4 +8,4 @@ description: >-
8
8
  API for signature verification, should contain the service HTTP method.
9
9
  Required if signature verification is used, for more information, see [the API
10
10
  Signature
11
- document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).
11
+ document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
@@ -7,4 +7,4 @@ description: >-
7
7
  The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for
8
8
  signature verification, should contain the service URI. Required if signature
9
9
  verification is used, for more information, see [the API Signature
10
- document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).
10
+ document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
@@ -8,4 +8,4 @@ description: >-
8
8
  API for signature verification, should contain the service HTTP method.
9
9
  Required if signature verification is used, for more information, see [the API
10
10
  Signature
11
- document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).
11
+ document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
@@ -7,4 +7,4 @@ description: >-
7
7
  The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for
8
8
  signature verification, should contain the service URI. Required if signature
9
9
  verification is used, for more information, see [the API Signature
10
- document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set).
10
+ document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
@@ -4,14 +4,14 @@ info:
4
4
  title: Open API for FSP Interoperability (FSPIOP)
5
5
  description: >-
6
6
  Based on [API Definition updated on 2020-05-19 Version
7
- 1.1](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/v1.1-document-set/API%20Definition_v1.1.pdf).
7
+ 1.1](https://github.com/mojaloop/mojaloop-specification/blob/main/documents/v1.1-document-set/API%20Definition_v1.1.pdf).
8
8
 
9
9
 
10
10
  **Note:** The API supports a maximum size of 65536 bytes (64 Kilobytes) in
11
11
  the HTTP header.
12
12
  license:
13
13
  name: CC BY-ND 4.0
14
- url: 'https://github.com/mojaloop/mojaloop-specification/blob/master/LICENSE.md'
14
+ url: 'https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md'
15
15
  contact:
16
16
  name: Sam Kummary
17
17
  url: 'https://github.com/mojaloop/mojaloop-specification/issues'
@@ -1948,9 +1948,9 @@ export interface components {
1948
1948
  "FSPIOP-Encryption"?: string;
1949
1949
  /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
1950
1950
  "FSPIOP-Signature"?: string;
1951
- /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
1951
+ /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
1952
1952
  "FSPIOP-URI"?: string;
1953
- /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
1953
+ /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
1954
1954
  "FSPIOP-HTTP-Method"?: string;
1955
1955
  /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
1956
1956
  Accept: string;
@@ -1976,6 +1976,7 @@ export interface components {
1976
1976
  };
1977
1977
  pathItems: never;
1978
1978
  }
1979
+ export type $defs = Record<string, never>;
1979
1980
  export type external = Record<string, never>;
1980
1981
  export interface operations {
1981
1982
  /** @description Essential path to include schema components that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
@@ -1365,9 +1365,9 @@ export interface components {
1365
1365
  "FSPIOP-Encryption"?: string;
1366
1366
  /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
1367
1367
  "FSPIOP-Signature"?: string;
1368
- /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
1368
+ /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
1369
1369
  "FSPIOP-URI"?: string;
1370
- /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
1370
+ /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
1371
1371
  "FSPIOP-HTTP-Method"?: string;
1372
1372
  /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
1373
1373
  Accept: string;
@@ -1393,6 +1393,7 @@ export interface components {
1393
1393
  };
1394
1394
  pathItems: never;
1395
1395
  }
1396
+ export type $defs = Record<string, never>;
1396
1397
  export type external = Record<string, never>;
1397
1398
  export interface operations {
1398
1399
  /** @description Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
@@ -874,6 +874,7 @@ export interface components {
874
874
  headers: never;
875
875
  pathItems: never;
876
876
  }
877
+ export type $defs = Record<string, never>;
877
878
  export type external = Record<string, never>;
878
879
  export interface operations {
879
880
  /** Health check endpoint. */
@@ -1542,6 +1542,7 @@ export interface components {
1542
1542
  headers: never;
1543
1543
  pathItems: never;
1544
1544
  }
1545
+ export type $defs = Record<string, never>;
1545
1546
  export type external = Record<string, never>;
1546
1547
  export interface operations {
1547
1548
  /**
@@ -1003,7 +1003,7 @@ export interface components {
1003
1003
  * The issuing PISP will expect a response to their request for a transfer which describes the finalized state of the requested transfer.
1004
1004
  * This response will be given by a PATCH call on the /thirdpartyRequests/transactions/{ID} resource.
1005
1005
  * The {ID} given in the query string should be the transactionRequestId which was originally used by the PISP to identify the transaction request.
1006
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
1006
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
1007
1007
  */
1008
1008
  ThirdpartyRequestsTransactionsIDPatchResponse: {
1009
1009
  completedTimestamp?: components["schemas"]["DateTime"];
@@ -1066,7 +1066,7 @@ export interface components {
1066
1066
  * ServiceType
1067
1067
  * @description The ServiceType enumeration describes the types of role for which a DFSP may query using the /services resource.
1068
1068
  * Below are the allowed values for the enumeration ServiceType - THIRD_PARTY_DFSP - Enum used to query for DFSPs that have thirdparty features enabled. - PISP - Enum used to query for PISPs. - AUTH_SERVICE - Participants which provide Authentication Services.
1069
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3229-servicetype
1069
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3229-servicetype
1070
1070
  * @enum {string}
1071
1071
  */
1072
1072
  ServiceType: "THIRD_PARTY_DFSP" | "PISP" | "AUTH_SERVICE";
@@ -1241,13 +1241,13 @@ export interface components {
1241
1241
  * - Underscore (_) - Tilde (~) - Hyphen (-) - Period (.) Addresses MUST NOT end in a period (.) character
1242
1242
  * An entity providing accounts to parties (i.e. a participant) can provide any value for an AccountAddress that is meaningful to that entity. It does not need to provide an address that makes the account identifiable outside the entity's domain.
1243
1243
  * IMPORTANT: The policy for defining addresses and the life-cycle of these is at the discretion of the address space owner (the payer DFSP in this case).
1244
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
1244
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
1245
1245
  */
1246
1246
  AccountAddress: string;
1247
1247
  /**
1248
1248
  * Account
1249
1249
  * @description Data model for the complex type Account.
1250
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
1250
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
1251
1251
  */
1252
1252
  Account: {
1253
1253
  accountNickname: components["schemas"]["Name"];
@@ -1257,7 +1257,7 @@ export interface components {
1257
1257
  /**
1258
1258
  * AccountList
1259
1259
  * @description The AccountList data model is used to hold information about the accounts that a party controls.
1260
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
1260
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
1261
1261
  */
1262
1262
  AccountList: components["schemas"]["Account"][];
1263
1263
  /**
@@ -1265,7 +1265,7 @@ export interface components {
1265
1265
  * @description Callback and data model information for GET /accounts/{ID}:
1266
1266
  * Callback - PUT /accounts/{ID} Error Callback - PUT /accounts/{ID}/error Data Model - Empty body
1267
1267
  * The PUT /accounts/{ID} response is used to inform the requester of the result of a request for accounts information. The identifier ID given in the call are the values given in the original request.
1268
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
1268
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
1269
1269
  */
1270
1270
  AccountsIDPutResponse: {
1271
1271
  accounts: components["schemas"]["AccountList"];
@@ -1294,7 +1294,7 @@ export interface components {
1294
1294
  /**
1295
1295
  * Scope
1296
1296
  * @description The Scope element contains an identifier defining, in the terms of a DFSP, an account on which access types can be requested or granted. It also defines the access types which are requested or granted.
1297
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
1297
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
1298
1298
  */
1299
1299
  Scope: {
1300
1300
  address: components["schemas"]["AccountAddress"];
@@ -1320,7 +1320,7 @@ export interface components {
1320
1320
  * The HTTP request POST /consentRequests is used to request a DFSP to grant access to one or more accounts owned by a customer of the DFSP for the PISP who sends the request.
1321
1321
  * Callback and data model for POST /consentRequests:
1322
1322
  * Callback: PUT /consentRequests/{ID} Error callback: PUT /consentRequests/{ID}/error Data model - see below url
1323
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
1323
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
1324
1324
  */
1325
1325
  ConsentRequestsPostRequest: {
1326
1326
  consentRequestId: components["schemas"]["CorrelationId"];
@@ -1379,7 +1379,7 @@ export interface components {
1379
1379
  * ConsentRequestsIDPatchRequest
1380
1380
  * @description Used by: PISP
1381
1381
  * After the user completes an out-of-band authorization with the DFSP, the PISP will receive a token which they can use to prove to the DFSP that the user trusts this PISP.
1382
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
1382
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
1383
1383
  */
1384
1384
  ConsentRequestsIDPatchRequest: {
1385
1385
  authToken: components["schemas"]["BinaryString"];
@@ -1388,7 +1388,7 @@ export interface components {
1388
1388
  /**
1389
1389
  * CredentialType
1390
1390
  * @description The type of the Credential. - "FIDO" - The credential is based on a FIDO challenge. Its payload is a FIDOPublicKeyCredentialAttestation object. - "GENERIC" - The credential is based on a simple public key validation. Its payload is a GenericCredential object.
1391
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
1391
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
1392
1392
  * @enum {string}
1393
1393
  */
1394
1394
  CredentialType: "FIDO" | "GENERIC";
@@ -1594,7 +1594,7 @@ export interface components {
1594
1594
  * The callback PUT /services/{ServiceType} is used to inform the client of a successful result of the service information lookup.
1595
1595
  * Callback and data model information for GET /services/{ServiceType}:
1596
1596
  * Callback - PUT /services/{ServiceType} Error Callback - PUT /services/{ServiceType}/error Data Model - Empty body
1597
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype
1597
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype
1598
1598
  */
1599
1599
  ServicesServiceTypePutResponse: {
1600
1600
  providers: components["schemas"]["FspId"][];
@@ -1606,7 +1606,7 @@ export interface components {
1606
1606
  * The HTTP request POST /thirdpartyRequests/transactions is used to request the creation of a transaction request on the server for the transfer described in the request.
1607
1607
  * Callback and data model information for POST /thirdpartyRequests/transactions:
1608
1608
  * Callback - PUT /thirdpartyRequests/transactions/{ID} Error Callback - PUT /thirdpartyRequests/transactions/{ID}/error Data Model - See link below
1609
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
1609
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
1610
1610
  */
1611
1611
  ThirdpartyRequestsTransactionsPostRequest: {
1612
1612
  /** @description Common ID between the PISP and the Payer DFSP for the transaction request object. The ID should be reused for resends of the same transaction request. A new ID should be generated for each new transaction request. */
@@ -1635,7 +1635,7 @@ export interface components {
1635
1635
  * ThirdpartyRequestsTransactionsIDPutResponse
1636
1636
  * @description Used by: DFSP
1637
1637
  * After a PISP requests the creation of a Third Party Transaction request (POST /thirdpartyRequests/transactions) or the status of a previously created Third Party Transaction request (GET /thirdpartyRequests/transactions/{ID}), the DFSP will send this callback.
1638
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
1638
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
1639
1639
  */
1640
1640
  ThirdpartyRequestsTransactionsIDPutResponse: {
1641
1641
  transactionId?: components["schemas"]["CorrelationId"];
@@ -1648,7 +1648,7 @@ export interface components {
1648
1648
  * The HTTP request POST /thirdpartyRequests/authorizations is used to request the validation by a customer for the transfer described in the request.
1649
1649
  * Callback and data model information for POST /thirdpartyRequests/authorizations:
1650
1650
  * Callback - PUT /thirdpartyRequests/authorizations/{ID} Error Callback - PUT /thirdpartyRequests/authorizations/{ID}/error Data Model - See below url
1651
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
1651
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
1652
1652
  */
1653
1653
  ThirdpartyRequestsAuthorizationsPostRequest: {
1654
1654
  authorizationRequestId: components["schemas"]["CorrelationId"];
@@ -1707,7 +1707,7 @@ export interface components {
1707
1707
  * Javascript ArrayBuffer.
1708
1708
  * For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
1709
1709
  *
1710
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
1710
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
1711
1711
  */
1712
1712
  FIDOPublicKeyCredentialAssertion: {
1713
1713
  /**
@@ -1816,7 +1816,7 @@ export interface components {
1816
1816
  * ThirdpartyRequestsVerificationsIDPutResponse
1817
1817
  * @description Used by: Auth Service
1818
1818
  * The callback PUT /thirdpartyRequests/verifications/{ID} is used to inform the client of the result of an authorization check. The {ID} in the URI should contain the authorizationRequestId which was used to request the check, or the {ID} that was used in the GET /thirdpartyRequests/verifications/{ID}.
1819
- * https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
1819
+ * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
1820
1820
  */
1821
1821
  ThirdpartyRequestsVerificationsIDPutResponse: {
1822
1822
  authenticationResponse: components["schemas"]["AuthenticationResponse"];
@@ -1934,9 +1934,9 @@ export interface components {
1934
1934
  "FSPIOP-Encryption"?: string;
1935
1935
  /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
1936
1936
  "FSPIOP-Signature"?: string;
1937
- /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
1937
+ /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
1938
1938
  "FSPIOP-URI"?: string;
1939
- /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/master/Specification%20Document%20Set). */
1939
+ /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
1940
1940
  "FSPIOP-HTTP-Method"?: string;
1941
1941
  /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
1942
1942
  Accept: string;
@@ -1964,6 +1964,7 @@ export interface components {
1964
1964
  };
1965
1965
  pathItems: never;
1966
1966
  }
1967
+ export type $defs = Record<string, never>;
1967
1968
  export type external = Record<string, never>;
1968
1969
  export interface operations {
1969
1970
  /** @description Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */