Skip to content

Commit

Permalink
chore: audit
Browse files Browse the repository at this point in the history
kleyow committed Jan 23, 2025
1 parent e0ea485 commit daa2960
Showing 3 changed files with 310 additions and 310 deletions.
292 changes: 146 additions & 146 deletions docs/fspiop-rest-v2.0-openapi3-snippets.yaml
Original file line number Diff line number Diff line change
@@ -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"
12 changes: 6 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit daa2960

Please sign in to comment.