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

package/fspiop/v2_0/openapi3/paths/transfers_ID_error.yaml

@@ -0,0 +1,49 @@
+put:
+  description: >-
+    If the server is unable to find or create a transfer, or another processing
+    error occurs, the error callback `PUT /transfers/{ID}/error` is used. The
+    `{ID}` in the URI should contain the `transferId` that was used for the
+    creation of the transfer, or the `{ID}` that was used in the `GET
+    /transfers/{ID}`.
+  summary: Return transfer information error
+  tags:
+    - transfers
+  operationId: TransfersByIDAndError
+  parameters:
+    - $ref: ../components/parameters/ID.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+    - $ref: ../components/parameters/Content-Type.yaml
+    - $ref: ../components/parameters/Date.yaml
+    - $ref: ../components/parameters/X-Forwarded-For.yaml
+    - $ref: ../components/parameters/FSPIOP-Source.yaml
+    - $ref: ../components/parameters/FSPIOP-Destination.yaml
+    - $ref: ../components/parameters/FSPIOP-Encryption.yaml
+    - $ref: ../components/parameters/FSPIOP-Signature.yaml
+    - $ref: ../components/parameters/FSPIOP-URI.yaml
+    - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
+  requestBody:
+    description: Details of the error returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/ErrorInformationObject.yaml
+  responses:
+    '200':
+      $ref: ../components/responses/200.yaml
+    '400':
+      $ref: ../components/responses/400.yaml
+    '401':
+      $ref: ../components/responses/401.yaml
+    '403':
+      $ref: ../components/responses/403.yaml
+    '404':
+      $ref: ../components/responses/404.yaml
+    '405':
+      $ref: ../components/responses/405.yaml
+    '406':
+      $ref: ../components/responses/406.yaml
+    '501':
+      $ref: ../components/responses/501.yaml
+    '503':
+      $ref: ../components/responses/503.yaml

package/lib/fspiop/v1_0/openapi.d.ts

@@ -1168,7 +1168,6 @@ export interface components {
          * @description The object sent in the PUT /parties/{Type}/{ID} callback.
          */
         PartiesTypeIDPutResponse: {
-            /** @description Information regarding the requested Party. */
             party: components["schemas"]["Party"];
         };
         /**
@@ -1948,9 +1947,9 @@ export interface components {
         "FSPIOP-Encryption"?: string;
         /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
         "FSPIOP-Signature"?: string;
-        /** @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). */
+        /** @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). */
         "FSPIOP-URI"?: string;
-        /** @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). */
+        /** @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). */
         "FSPIOP-HTTP-Method"?: string;
         /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
         Accept: string;

package/lib/fspiop/v1_1/openapi.d.ts

@@ -1365,9 +1365,9 @@ export interface components {
         "FSPIOP-Encryption"?: string;
         /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
         "FSPIOP-Signature"?: string;
-        /** @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). */
+        /** @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). */
         "FSPIOP-URI"?: string;
-        /** @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). */
+        /** @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). */
         "FSPIOP-HTTP-Method"?: string;
         /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
         Accept: string;