@mojaloop/api-snippets 17.7.8 → 17.7.10

package/CHANGELOG.md

@@ -1,4 +1,19 @@
 # Changelog: [mojaloop/api-snippets](https://github.com/mojaloop/api-snippets)
+### [17.7.10](https://github.com/mojaloop/api-snippets/compare/v17.7.9...v17.7.10) (2025-01-31)
+
+
+### Bug Fixes
+
+* **csi-1156:** remove character length limit for ExtensionKey in sdk outbound spec ([#190](https://github.com/mojaloop/api-snippets/issues/190)) ([6c1dc95](https://github.com/mojaloop/api-snippets/commit/6c1dc95f860f62e8246c1d2280497c704669c81f))
+
+### [17.7.9](https://github.com/mojaloop/api-snippets/compare/v17.7.8...v17.7.9) (2025-01-23)
+
+
+### Maintenance
+
+* audit ([daa2960](https://github.com/mojaloop/api-snippets/commit/daa2960f1ee9f67d46e3f0e32ba9828ce7fd6f94))
+* reorder endpoints ([e0ea485](https://github.com/mojaloop/api-snippets/commit/e0ea485827ba9843f43f05f99b2ec421d9b822ed))
+
 ### [17.7.8](https://github.com/mojaloop/api-snippets/compare/v17.7.7...v17.7.8) (2024-12-16)
 
 ### [17.7.7](https://github.com/mojaloop/api-snippets/compare/v17.7.6...v17.7.7) (2024-12-13)

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

@@ -34,6 +34,152 @@ servers:
           - https
         default: https
 paths:
+  /participants:
+    post:
+      description: >-
+        The HTTP request `POST /participants` is used to create information in
+        the server regarding the provided list of identities. This request
+        should be used for bulk creation of FSP information for more than one
+        Party. The optional currency parameter should indicate that each
+        provided Party supports the currency.
+      summary: Create bulk participant information
+      tags:
+        - participants
+      operationId: Participants1
+      parameters:
+        - $ref: "#/components/parameters/Accept"
+        - $ref: "#/components/parameters/Content-Length"
+        - $ref: "#/components/parameters/Content-Type"
+        - $ref: "#/components/parameters/Date"
+        - $ref: "#/components/parameters/X-Forwarded-For"
+        - $ref: "#/components/parameters/FSPIOP-Source"
+        - $ref: "#/components/parameters/FSPIOP-Destination"
+        - $ref: "#/components/parameters/FSPIOP-Encryption"
+        - $ref: "#/components/parameters/FSPIOP-Signature"
+        - $ref: "#/components/parameters/FSPIOP-URI"
+        - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
+      requestBody:
+        description: Participant information to be created.
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ParticipantsPostRequest"
+      responses:
+        "202":
+          $ref: "#/components/responses/202"
+        "400":
+          $ref: "#/components/responses/400"
+        "401":
+          $ref: "#/components/responses/401"
+        "403":
+          $ref: "#/components/responses/403"
+        "404":
+          $ref: "#/components/responses/404"
+        "405":
+          $ref: "#/components/responses/405"
+        "406":
+          $ref: "#/components/responses/406"
+        "501":
+          $ref: "#/components/responses/501"
+        "503":
+          $ref: "#/components/responses/503"
+  /participants/{ID}:
+    put:
+      description: >-
+        The callback `PUT /participants/{ID}` is used to inform the client of
+        the result of the creation of the provided list of identities.
+      summary: Return bulk participant information
+      tags:
+        - participants
+      operationId: putParticipantsByID
+      parameters:
+        - $ref: "#/components/parameters/ID"
+        - $ref: "#/components/parameters/Content-Length"
+        - $ref: "#/components/parameters/Content-Type"
+        - $ref: "#/components/parameters/Date"
+        - $ref: "#/components/parameters/X-Forwarded-For"
+        - $ref: "#/components/parameters/FSPIOP-Source"
+        - $ref: "#/components/parameters/FSPIOP-Destination"
+        - $ref: "#/components/parameters/FSPIOP-Encryption"
+        - $ref: "#/components/parameters/FSPIOP-Signature"
+        - $ref: "#/components/parameters/FSPIOP-URI"
+        - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
+      requestBody:
+        description: Participant information returned.
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ParticipantsIDPutResponse"
+      responses:
+        "200":
+          $ref: "#/components/responses/200"
+        "400":
+          $ref: "#/components/responses/400"
+        "401":
+          $ref: "#/components/responses/401"
+        "403":
+          $ref: "#/components/responses/403"
+        "404":
+          $ref: "#/components/responses/404"
+        "405":
+          $ref: "#/components/responses/405"
+        "406":
+          $ref: "#/components/responses/406"
+        "501":
+          $ref: "#/components/responses/501"
+        "503":
+          $ref: "#/components/responses/503"
+  /participants/{ID}/error:
+    put:
+      description: >-
+        If there is an error during FSP information creation in the server, the
+        error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the
+        URI should contain the requestId that was used for the creation of the
+        participant information.
+      summary: Return bulk participant information error
+      tags:
+        - participants
+      operationId: ParticipantsByIDAndError
+      parameters:
+        - $ref: "#/components/parameters/ID"
+        - $ref: "#/components/parameters/Content-Length"
+        - $ref: "#/components/parameters/Content-Type"
+        - $ref: "#/components/parameters/Date"
+        - $ref: "#/components/parameters/X-Forwarded-For"
+        - $ref: "#/components/parameters/FSPIOP-Source"
+        - $ref: "#/components/parameters/FSPIOP-Destination"
+        - $ref: "#/components/parameters/FSPIOP-Encryption"
+        - $ref: "#/components/parameters/FSPIOP-Signature"
+        - $ref: "#/components/parameters/FSPIOP-URI"
+        - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
+      requestBody:
+        description: Details of the error returned.
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ErrorInformationObject"
+      responses:
+        "200":
+          $ref: "#/components/responses/200"
+        "400":
+          $ref: "#/components/responses/400"
+        "401":
+          $ref: "#/components/responses/401"
+        "403":
+          $ref: "#/components/responses/403"
+        "404":
+          $ref: "#/components/responses/404"
+        "405":
+          $ref: "#/components/responses/405"
+        "406":
+          $ref: "#/components/responses/406"
+        "501":
+          $ref: "#/components/responses/501"
+        "503":
+          $ref: "#/components/responses/503"
   /participants/{Type}/{ID}:
     parameters:
       - $ref: "#/components/parameters/Type"
@@ -474,152 +620,6 @@ paths:
           $ref: "#/components/responses/501"
         "503":
           $ref: "#/components/responses/503"
-  /participants:
-    post:
-      description: >-
-        The HTTP request `POST /participants` is used to create information in
-        the server regarding the provided list of identities. This request
-        should be used for bulk creation of FSP information for more than one
-        Party. The optional currency parameter should indicate that each
-        provided Party supports the currency.
-      summary: Create bulk participant information
-      tags:
-        - participants
-      operationId: Participants1
-      parameters:
-        - $ref: "#/components/parameters/Accept"
-        - $ref: "#/components/parameters/Content-Length"
-        - $ref: "#/components/parameters/Content-Type"
-        - $ref: "#/components/parameters/Date"
-        - $ref: "#/components/parameters/X-Forwarded-For"
-        - $ref: "#/components/parameters/FSPIOP-Source"
-        - $ref: "#/components/parameters/FSPIOP-Destination"
-        - $ref: "#/components/parameters/FSPIOP-Encryption"
-        - $ref: "#/components/parameters/FSPIOP-Signature"
-        - $ref: "#/components/parameters/FSPIOP-URI"
-        - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
-      requestBody:
-        description: Participant information to be created.
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/ParticipantsPostRequest"
-      responses:
-        "202":
-          $ref: "#/components/responses/202"
-        "400":
-          $ref: "#/components/responses/400"
-        "401":
-          $ref: "#/components/responses/401"
-        "403":
-          $ref: "#/components/responses/403"
-        "404":
-          $ref: "#/components/responses/404"
-        "405":
-          $ref: "#/components/responses/405"
-        "406":
-          $ref: "#/components/responses/406"
-        "501":
-          $ref: "#/components/responses/501"
-        "503":
-          $ref: "#/components/responses/503"
-  /participants/{ID}:
-    put:
-      description: >-
-        The callback `PUT /participants/{ID}` is used to inform the client of
-        the result of the creation of the provided list of identities.
-      summary: Return bulk participant information
-      tags:
-        - participants
-      operationId: putParticipantsByID
-      parameters:
-        - $ref: "#/components/parameters/ID"
-        - $ref: "#/components/parameters/Content-Length"
-        - $ref: "#/components/parameters/Content-Type"
-        - $ref: "#/components/parameters/Date"
-        - $ref: "#/components/parameters/X-Forwarded-For"
-        - $ref: "#/components/parameters/FSPIOP-Source"
-        - $ref: "#/components/parameters/FSPIOP-Destination"
-        - $ref: "#/components/parameters/FSPIOP-Encryption"
-        - $ref: "#/components/parameters/FSPIOP-Signature"
-        - $ref: "#/components/parameters/FSPIOP-URI"
-        - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
-      requestBody:
-        description: Participant information returned.
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/ParticipantsIDPutResponse"
-      responses:
-        "200":
-          $ref: "#/components/responses/200"
-        "400":
-          $ref: "#/components/responses/400"
-        "401":
-          $ref: "#/components/responses/401"
-        "403":
-          $ref: "#/components/responses/403"
-        "404":
-          $ref: "#/components/responses/404"
-        "405":
-          $ref: "#/components/responses/405"
-        "406":
-          $ref: "#/components/responses/406"
-        "501":
-          $ref: "#/components/responses/501"
-        "503":
-          $ref: "#/components/responses/503"
-  /participants/{ID}/error:
-    put:
-      description: >-
-        If there is an error during FSP information creation in the server, the
-        error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the
-        URI should contain the requestId that was used for the creation of the
-        participant information.
-      summary: Return bulk participant information error
-      tags:
-        - participants
-      operationId: ParticipantsByIDAndError
-      parameters:
-        - $ref: "#/components/parameters/ID"
-        - $ref: "#/components/parameters/Content-Length"
-        - $ref: "#/components/parameters/Content-Type"
-        - $ref: "#/components/parameters/Date"
-        - $ref: "#/components/parameters/X-Forwarded-For"
-        - $ref: "#/components/parameters/FSPIOP-Source"
-        - $ref: "#/components/parameters/FSPIOP-Destination"
-        - $ref: "#/components/parameters/FSPIOP-Encryption"
-        - $ref: "#/components/parameters/FSPIOP-Signature"
-        - $ref: "#/components/parameters/FSPIOP-URI"
-        - $ref: "#/components/parameters/FSPIOP-HTTP-Method"
-      requestBody:
-        description: Details of the error returned.
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/ErrorInformationObject"
-      responses:
-        "200":
-          $ref: "#/components/responses/200"
-        "400":
-          $ref: "#/components/responses/400"
-        "401":
-          $ref: "#/components/responses/401"
-        "403":
-          $ref: "#/components/responses/403"
-        "404":
-          $ref: "#/components/responses/404"
-        "405":
-          $ref: "#/components/responses/405"
-        "406":
-          $ref: "#/components/responses/406"
-        "501":
-          $ref: "#/components/responses/501"
-        "503":
-          $ref: "#/components/responses/503"
   /parties/{Type}/{ID}:
     parameters:
       - $ref: "#/components/parameters/Type"

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

@@ -1911,11 +1911,10 @@ components:
       minLength: 1
       maxLength: 128
       description: Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
-    ExtensionKey:
-      title: ExtensionKey
+    ExtensionKey_v2_1_0:
+      title: ExtensionKey_v2_1_0
       type: string
       minLength: 1
-      maxLength: 32
       description: Extension key.
     ExtensionValue:
       title: ExtensionValue
@@ -1923,19 +1922,19 @@ components:
       minLength: 1
       maxLength: 128
       description: Extension value.
-    Extension:
-      title: Extension
+    Extension_v2_1_0:
+      title: Extension_v2_1_0
       type: object
       description: Data model for the complex type Extension.
       properties:
         key:
-          $ref: '#/components/schemas/ExtensionKey'
+          $ref: '#/components/schemas/ExtensionKey_v2_1_0'
         value:
           $ref: '#/components/schemas/ExtensionValue'
       required:
         - key
         - value
-    ExtensionList:
+    ExtensionList_v2_1_0:
       title: ExtensionList
       type: object
       description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
@@ -1943,7 +1942,7 @@ components:
         extension:
           type: array
           items:
-            $ref: '#/components/schemas/Extension'
+            $ref: '#/components/schemas/Extension_v2_1_0'
           minItems: 1
           maxItems: 16
           description: Number of Extension elements.
@@ -1963,7 +1962,7 @@ components:
         fspId:
           $ref: '#/components/schemas/FspId'
         extensionList:
-          $ref: '#/components/schemas/ExtensionList'
+          $ref: '#/components/schemas/ExtensionList_v2_1_0'
       required:
         - partyIdType
         - partyIdentifier
@@ -2107,7 +2106,7 @@ components:
         errorDescription:
           $ref: '#/components/schemas/ErrorDescription'
         extensionList:
-          $ref: '#/components/schemas/ExtensionList'
+          $ref: '#/components/schemas/ExtensionList_v2_1_0'
       required:
         - errorCode
         - errorDescription
@@ -2145,7 +2144,7 @@ components:
         condition:
           $ref: '#/components/schemas/IlpCondition'
         extensionList:
-          $ref: '#/components/schemas/ExtensionList'
+          $ref: '#/components/schemas/ExtensionList_v2_1_0'
         lastError:
           $ref: '#/components/schemas/quoteError'
       required:
@@ -2191,7 +2190,7 @@ components:
         fulfilment:
           $ref: '#/components/schemas/IlpFulfilment'
         extensionList:
-          $ref: '#/components/schemas/ExtensionList'
+          $ref: '#/components/schemas/ExtensionList_v2_1_0'
         transferState:
           $ref: '#/components/schemas/TransferState'
         lastError:
@@ -2228,9 +2227,9 @@ components:
         fulfil:
           $ref: '#/components/schemas/individualTransferResult'
         quoteExtensions:
-          $ref: '#/components/schemas/ExtensionList'
+          $ref: '#/components/schemas/ExtensionList_v2_1_0'
         transferExtensions:
-          $ref: '#/components/schemas/ExtensionList'
+          $ref: '#/components/schemas/ExtensionList_v2_1_0'
         lastError:
           $ref: '#/components/schemas/transferError'
     bulkTransactionResponse:
@@ -2258,7 +2257,7 @@ components:
           items:
             $ref: '#/components/schemas/bulkTransactionIndividualTransferResult'
         extensions:
-          $ref: '#/components/schemas/ExtensionList'
+          $ref: '#/components/schemas/ExtensionList_v2_1_0'
     CurrencyConverter:
       title: CurrencyConverter
       type: string
@@ -2307,7 +2306,7 @@ components:
         transferState:
           $ref: '#/components/schemas/TransferState'
         extensionList:
-          $ref: '#/components/schemas/ExtensionList'
+          $ref: '#/components/schemas/ExtensionList_v2_1_0'
       required:
         - transferState
     TransfersPostRequest:
@@ -2330,7 +2329,7 @@ components:
         expiration:
           $ref: '#/components/schemas/DateTime'
         extensionList:
-          $ref: '#/components/schemas/ExtensionList'
+          $ref: '#/components/schemas/ExtensionList_v2_1_0'
       required:
         - transferId
         - payeeFsp
@@ -2361,7 +2360,7 @@ components:
         condition:
           $ref: '#/components/schemas/IlpCondition'
         extensionList:
-          $ref: '#/components/schemas/ExtensionList'
+          $ref: '#/components/schemas/ExtensionList_v2_1_0'
       required:
         - transferAmount
         - expiration
@@ -2493,7 +2492,7 @@ components:
         expiration:
           $ref: '#/components/schemas/DateTime'
         extensionList:
-          $ref: '#/components/schemas/ExtensionList'
+          $ref: '#/components/schemas/ExtensionList_v2_1_0'
       required:
         - quoteId
         - transactionId
@@ -2533,6 +2532,38 @@ components:
             - description: The amount of the charge which is being levied, expressed in the target currency.
       required:
         - chargeType
+    ExtensionKey:
+      title: ExtensionKey
+      type: string
+      minLength: 1
+      maxLength: 32
+      description: Extension key.
+    Extension:
+      title: Extension
+      type: object
+      description: Data model for the complex type Extension.
+      properties:
+        key:
+          $ref: '#/components/schemas/ExtensionKey'
+        value:
+          $ref: '#/components/schemas/ExtensionValue'
+      required:
+        - key
+        - value
+    ExtensionList:
+      title: ExtensionList
+      type: object
+      description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
+      properties:
+        extension:
+          type: array
+          items:
+            $ref: '#/components/schemas/Extension'
+          minItems: 1
+          maxItems: 16
+          description: Number of Extension elements.
+      required:
+        - extension
     FxConversion:
       title: FxConversion
       type: object