@mojaloop/api-snippets 18.3.1 → 18.4.0

package/thirdparty/v2_0/openapi3/paths/tppConsentRequests_ID.yaml

@@ -0,0 +1,123 @@
+parameters:
+  #Path
+  - $ref: ../components/parameters/ID.yaml
+  #Headers
+  - $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
+get:
+  operationId: GetConsentRequestsById
+  summary: GetConsentRequestsById
+  description: |
+    The HTTP request `GET /tppConsentRequests/{ID}` is used to get information about a previously
+    requested consent. The *{ID}* in the URI should contain the consentRequestId that was assigned to the
+    request by the PISP when the PISP originated the request.
+  tags:
+    - consentRequests
+  parameters:
+    - $ref: ../components/parameters/Accept.yaml
+  responses:
+    202:
+      $ref: ../components/responses/202.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
+put:
+  tags:
+    - consentRequests
+  operationId: UpdateConsentRequest
+  summary: UpdateConsentRequest
+  description: |
+    A DFSP uses this callback to (1) inform the PISP that the consentRequest has been accepted,
+    and (2) communicate to the PISP which `authChannel` it should use to authenticate their user
+    with.
+
+    When a PISP requests a series of permissions from a DFSP on behalf of a DFSP’s customer, not all
+    the permissions requested may be granted by the DFSP. Conversely, the out-of-band authorization
+    process  may result in additional privileges being granted by the account holder to the PISP. The
+    **PUT /consentRequests/**_{ID}_ resource returns the current state of the permissions relating to a
+    particular authorization request.
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          oneOf:
+            - $ref: ../components/schemas/ConsentRequestsIDPutResponseWeb.yaml
+            - $ref: ../components/schemas/ConsentRequestsIDPutResponseOTP.yaml
+  responses:
+    202:
+      $ref: ../components/responses/202.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
+patch:
+  tags:
+    - consentRequests
+  operationId: PatchConsentRequest
+  summary: PatchConsentRequest
+  description: >
+    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.
+  parameters:
+    - $ref: ../components/parameters/Accept.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/ConsentRequestsIDPatchRequest.yaml
+  responses:
+    202:
+      $ref: ../components/responses/202.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/thirdparty/v2_0/openapi3/paths/tppConsentRequests_ID_error.yaml

@@ -0,0 +1,48 @@
+parameters:
+  #Path
+  - $ref: ../components/parameters/ID.yaml
+  #Headers
+  - $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
+put:
+  tags:
+    - consentRequests
+  operationId: NotifyErrorConsentRequests
+  summary: NotifyErrorConsentRequests
+  description: |
+    DFSP responds to the PISP if something went wrong with validating an OTP or secret.
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Error information returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../../../../fspiop/v2_0/openapi3/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/thirdparty/v2_0/openapi3/paths/tppConsents.yaml

@@ -0,0 +1,49 @@
+parameters:
+  #Headers
+  - $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
+post:
+  tags:
+    - consents
+  operationId: PostConsents
+  summary: PostConsents
+  description: >
+    The **POST /tppConsents** request is used to request the creation of a consent for interactions between
+    a PISP and the DFSP who owns the account which a PISP’s customer wants to allow the PISP access to.
+  parameters:
+    - $ref: ../components/parameters/Accept.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          oneOf:
+            - $ref: ../components/schemas/ConsentsPostRequestAUTH.yaml
+            - $ref: ../components/schemas/ConsentsPostRequestPISP.yaml
+  responses:
+    202:
+      $ref: ../components/responses/202.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/thirdparty/v2_0/openapi3/paths/tppConsents_ID.yaml

@@ -0,0 +1,165 @@
+parameters:
+  #Path
+  - $ref: ../components/parameters/ID.yaml
+  #Headers
+  - $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
+get:
+  description: >
+    The **GET /tppConsents/**_{ID}_ resource allows a party to enquire after the status of a consent. The
+    *{ID}* used in the URI of the request should be the consent request ID which was used to identify
+    the consent when it was created.
+  tags:
+    - consents
+  operationId: GetConsent
+  summary: GetConsent
+  parameters:
+    #Headers
+    - $ref: ../components/parameters/Accept.yaml
+  responses:
+    202:
+      $ref: ../components/responses/202.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
+patch:
+  description: |
+    The HTTP request `PATCH /consents/{ID}` is used
+
+    - In account linking in the Credential Registration phase. Used by a DFSP
+      to notify a PISP a credential has been verified and registered with an
+      Auth service.
+
+    - In account unlinking by a hub hosted auth service and by DFSPs
+      in non-hub hosted scenarios to notify participants of a consent being revoked.
+
+      Called by a `auth-service` to notify a PISP and DFSP of consent status in hub hosted scenario.
+      Called by a `DFSP` to notify a PISP of consent status in non-hub hosted scenario.
+  tags:
+    - consents
+  operationId: PatchConsentByID
+  summary: PatchConsentByID
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          oneOf:
+            - $ref: ../components/schemas/ConsentsIDPatchResponseVerified.yaml
+            - $ref: ../components/schemas/ConsentsIDPatchResponseRevoked.yaml
+  parameters:
+    - $ref: ../components/parameters/Accept.yaml
+    - $ref: ../components/parameters/Content-Length.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
+put:
+  description: |
+    The HTTP request `PUT /consents/{ID}` is used by the PISP and Auth Service.
+
+    - Called by a `PISP` to after signing a challenge. Sent to an DFSP for verification.
+    - Called by a `auth-service` to notify a DFSP that a credential has been verified and registered.
+  tags:
+    - consents
+  operationId: PutConsentByID
+  summary: PutConsentByID
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          oneOf:
+            - $ref: ../components/schemas/ConsentsIDPutResponseSigned.yaml
+            - $ref: ../components/schemas/ConsentsIDPutResponseVerified.yaml
+  parameters:
+    #Headers
+    - $ref: ../components/parameters/Content-Length.yaml
+  responses:
+    200:
+      $ref: ../components/responses/200.yaml
+    202:
+      $ref: ../components/responses/202.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
+delete:
+  description: |
+    Used by PISP, DFSP
+
+    The **DELETE /consents/**_{ID}_ request is used to request the revocation of a previously agreed consent.
+    For tracing and auditing purposes, the switch should be sure not to delete the consent physically;
+    instead, information relating to the consent should be marked as deleted and requests relating to the
+    consent should not be honoured.
+  operationId: DeleteConsentByID
+  parameters:
+    - $ref: ../components/parameters/Accept.yaml
+  tags:
+    - consents
+  responses:
+    202:
+      $ref: ../components/responses/202.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/thirdparty/v2_0/openapi3/paths/tppConsents_ID_error.yaml

@@ -0,0 +1,48 @@
+parameters:
+    #Path
+    - $ref: ../components/parameters/ID.yaml
+    #Headers
+    - $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
+put:
+  tags:
+    - consents
+  operationId: NotifyErrorConsents
+  summary: NotifyErrorConsents
+  description: |
+    DFSP responds to the PISP if something went wrong with validating or storing consent.
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Error information returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../../../../fspiop/v2_0/openapi3/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/thirdparty/v2_0/openapi3/paths/tppTransactionRequests.yaml

@@ -0,0 +1,48 @@
+parameters:
+  #Headers
+  - $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
+post:
+  operationId: tppTransactionsPost
+  summary: tppTransactionsPost
+  description: |
+    The `/tppTransactionRequests` resource is analogous to the `/transactionRequests` resource described fspiop API. The PISP uses it to request the owner of the PISP's customer's account to transfer a specified amount from the customer's account with the DFSP to a named Payee, or a request to pay request from a named payer into the customer's account.
+  tags:
+    - transaction Requests
+  parameters:
+    #Headers
+    - $ref: ../components/parameters/Accept.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Transaction request to be created.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/tppTransactionRequestPostRequest.yaml
+  responses:
+    202:
+      $ref: ../components/responses/202.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/thirdparty/v2_0/openapi3/paths/tppTransactionRequests_ID.yaml

@@ -0,0 +1,83 @@
+parameters:
+  #Path
+  - $ref: ../components/parameters/ID.yaml
+  #Headers
+  - $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
+get:
+  tags:
+    - transaction Requests
+  operationId: GetThirdpartyTransactionRequests
+  summary: GetThirdpartyTransactionRequests
+  description: |
+    The HTTP request `GET /tppTransactionRequests/{ID}` is used to request the
+    retrieval of a third party transaction request.
+  parameters:
+    #Headers
+    - $ref: ../components/parameters/Accept.yaml
+  responses:
+    202:
+      $ref: ../components/responses/202.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
+
+put:
+  tags:
+    - transaction Requests
+  operationId: tppUpdateTransactionRequests
+  summary: tppUpdateTransactionRequests
+  description: |
+    The HTTP request `PUT /tppTransactionRequests/{ID}` is used by the DFSP to inform the client about
+    the status of a previously requested thirdparty transaction request.
+
+    Switch(Thirdparty API Adapter) -> PISP
+  parameters:
+    #Headers
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/tppTransactionRequestPutResponse.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/thirdparty/v2_0/openapi3/paths/tppTransactionRequests_ID_error.yaml

@@ -0,0 +1,52 @@
+parameters:
+  #Path
+  - $ref: ../components/parameters/ID.yaml
+  #Headers
+  - $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
+put:
+  tags:
+    - transaction Requests
+  operationId: tppTransactionRequestsError
+  summary: tppTransactionRequestsError
+  description: |
+    If the server is unable to find the transaction request, or another processing error occurs,
+    the error callback `PUT /tppTransactionRequests/{ID}/error` is used.
+    The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of
+    the thirdparty transaction request.
+  parameters:
+    #Headers
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Error information returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../../../../fspiop/v2_0/openapi3/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/thirdparty/v2_0/openapi3/paths/tppTransfers.yaml

@@ -0,0 +1,47 @@
+parameters:
+  #Headers
+  - $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
+post:
+  operationId: tppPostTransfers
+  summary: tppPostTransfers
+  description: The HTTP request POST `/tppTransfers` is used by a PISP to initiate a 3rd party Transaction request with a DFSP
+  tags:
+    - transfers
+  parameters:
+    #Headers
+    - $ref: ../components/parameters/Accept.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: Transaction request to be created.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../components/schemas/tppTransfersPostRequest.yaml'
+  responses:
+    202:
+      $ref: ../components/responses/202.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