Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

explanation improvements #73

Merged
merged 6 commits into from
Jan 22, 2024
Merged

explanation improvements #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
23d91b9
explanation improvements
svenbiellmann Dec 27, 2023
c092b13
Endpoint documentation improvements
svenbiellmann Dec 29, 2023
7ea7ef6
Further explanation alignments
svenbiellmann Jan 8, 2024
db24ac1
Explanation improvements
svenbiellmann Jan 8, 2024
f5b1111
Description adaption
svenbiellmann Jan 8, 2024
6ba477e
AIS - Adjustment in the description of the usage for /balance and /tr…
svenbiellmann Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 16 additions & 19 deletions accountAPI.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,9 @@

tags:
- name: accounts
description: |
**Account Information**
Account Information Service - third party access to bank account data.
description: Third party access to bank account service considering account information and transaction data operations (JSON).
- name: iso20022
description: Third party access to bank account service considering camt.053 operations (XML).

paths:
/accounts:
Expand Down Expand Up @@ -79,7 +78,7 @@
tags:
- accounts
summary: Retrieve information about a single specific account
description: Return the accounts details of the requested account.
description: Returns the accounts details of the specified account.
parameters:
- $ref: '#/components/parameters/path_accountId'
- $ref: '#/components/parameters/authorization_in_header'
Expand All @@ -91,7 +90,7 @@
- $ref: '#/components/parameters/optional_psu_user_agent_in_header'
responses:
'200':
description: Account details of the requested account.
description: Account details of the specified account.
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
Expand Down Expand Up @@ -122,10 +121,9 @@
- accounts
summary: Retrieve account balance information
description: |
Account data of the specified account.
* Returns the intraday booked balance (ITBD), if called without a date.
* Returns the closing booked balance (CLBD), if called for a past date. In case the
specified day has not yet been finalized, the response will be a 404 error.
Returns account balance information of the specified account.
* Returns the intraday booked balance (ITBD) for the current day, if called without a date.
* Returns the closing booked balance (CLBD) for a specific day, if called for a past date (i.e. the closing booked balance (CLBD) of that day). In case the specified day has not yet been finalized, the response code will be 202.
parameters:
- $ref: '#/components/parameters/authorization_in_header'
- $ref: '#/components/parameters/path_accountId'
Expand All @@ -138,7 +136,7 @@
- $ref: '#/components/parameters/optional_psu_user_agent_in_header'
responses:
'200':
description: Account details of the requested account.
description: Account balance information of the specified account.
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
Expand Down Expand Up @@ -173,10 +171,9 @@
- accounts
summary: Retrieve transactions of a specific account
description: |
Transactions to and from the specified account.
Returns the transaction list of the specified account. Only postings with status booked will be returned.
* Returns the transaction list of the current day, if called without a date.
* Returns the transaction list for a specific day, if called for a past date.
In case the specified day has not yet been finalized, the response will be a 404 error.
* Returns the transaction list for a specific day, if called for a past date (i.e. all transactions from that day). In case the specified day is not yet finalized, the response code will be 202.
parameters:
- $ref: '#/components/parameters/authorization_in_header'
- $ref: '#/components/parameters/path_accountId'
Expand Down Expand Up @@ -283,9 +280,9 @@
get:
tags:
- iso20022
summary: Retrieve a list of resource links to account statements (CAMT.053)
summary: Retrieve a list of resource links to account statements (camt.053)
description: >
Get the resources links to available account statements (CAMT.053).
Get the resources links to available account statements (camt.053).
The returned account statements must be conform to the XML schema and
implementation guidelines defined by Swiss Payment Standards.
parameters:
Expand All @@ -298,7 +295,7 @@
- $ref: '#/components/parameters/optional_psu_user_agent_in_header'
responses:
'200':
description: Returns a list of resource links to ISO20022 XML CAMT.053 messages.
description: Returns a list of resource links to ISO20022 XML camt.053 messages.
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
Expand Down Expand Up @@ -332,7 +329,7 @@
get:
tags:
- iso20022
summary: Retrieves the designated ISO20022 XML CAMT.053 document.
summary: Retrieves the designated ISO20022 XML camt.053 document.
parameters:
- $ref: '#/components/parameters/path_reportId'
- $ref: '#/components/parameters/authorization_in_header'
Expand All @@ -344,7 +341,7 @@
- $ref: '#/components/parameters/optional_psu_user_agent_in_header'
responses:
'200':
description: Returns the requested ISO20022 XML CAMT.053 message.
description: Returns the requested ISO20022 XML camt.053 message.
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
Expand Down Expand Up @@ -970,7 +967,7 @@
type: string
format: date-time
example: 2018-04-13T11:11:11Z
# --------

Check warning on line 970 in accountAPI.yaml

View workflow job for this annotation

GitHub Actions / yaml-lint / lint 

970:5 [comments-indentation] comment not indented like content

# ---- Global Common Header Parameters ----
parameters:
Expand All @@ -995,7 +992,7 @@
path_reportId:
name: reportId
in: path
description: Unique ID of the requested ISO20022 XML CAMT.053 document.
description: Unique ID of the requested ISO20022 XML camt.053 document.
required: true
schema:
maxLength: 35
Expand Down Expand Up @@ -1151,17 +1148,17 @@
description: |
Bad Request - The format of the request was invalid.

Examples:

Check warning on line 1151 in accountAPI.yaml

View workflow job for this annotation

GitHub Actions / yaml-lint / lint 

1151:18 [trailing-spaces] trailing spaces
- InvalidPayload:

Check warning on line 1152 in accountAPI.yaml

View workflow job for this annotation

GitHub Actions / yaml-lint / lint 

1152:26 [trailing-spaces] trailing spaces
type: /problems/INVALID_PAYLOAD

Check warning on line 1153 in accountAPI.yaml

View workflow job for this annotation

GitHub Actions / yaml-lint / lint 

1153:40 [trailing-spaces] trailing spaces
title: Payload does not comply with API specification

Check warning on line 1154 in accountAPI.yaml

View workflow job for this annotation

GitHub Actions / yaml-lint / lint 

1154:62 [trailing-spaces] trailing spaces
detail: Malformed JSON

Check warning on line 1155 in accountAPI.yaml

View workflow job for this annotation

GitHub Actions / yaml-lint / lint 

1155:31 [trailing-spaces] trailing spaces
instance: path/to/corresponding/resource

- InvalidParameter:

Check warning on line 1158 in accountAPI.yaml

View workflow job for this annotation

GitHub Actions / yaml-lint / lint 

1158:28 [trailing-spaces] trailing spaces
type: /problems/INVALID_PAYLOAD

Check warning on line 1159 in accountAPI.yaml

View workflow job for this annotation

GitHub Actions / yaml-lint / lint 

1159:40 [trailing-spaces] trailing spaces
title: Invalid parameter values have been detected

Check warning on line 1160 in accountAPI.yaml

View workflow job for this annotation

GitHub Actions / yaml-lint / lint 

1160:59 [trailing-spaces] trailing spaces
detail: Sent data could not processed

Check warning on line 1161 in accountAPI.yaml

View workflow job for this annotation

GitHub Actions / yaml-lint / lint 

1161:46 [trailing-spaces] trailing spaces
instance: path/to/corresponding/resource

- MissingId:
Expand Down
23 changes: 12 additions & 11 deletions paymentAPI.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,13 @@ security:
- write
tags:
- name: standing orders
description: Third party payment service considering standing order operations (JSON).
- name: payments
description: |
**Payment Initiation Submission**
Payment Submission Service - third party payment instruction submission
description: Third party payment service considering bulk payments operations (JSON). PUT operation can be used for both payment submission and payment initiation (PSS/PIS), depending on security implementation.
- name: single payments
description: Third party payment service considering single payments operations (JSON). PUT operation can be used for both payment submission and payment initiation (PSS/PIS), depending on security implementation.
- name: iso20022
description: Third party payment service considering pain.001 and pain.002 operations (XML). PUT operation can be used for both payment submission and payment initiation (PSS/PIS), depending on security implementation.

paths:
/standing-orders:
Expand Down Expand Up @@ -672,8 +673,8 @@ paths:
post:
tags:
- iso20022
summary: Submit ISO20022 XML payment instruction (PAIN.001)
description: Submit an XML PAIN.001 payment instruction according to the ISO20022 specification.
summary: Submit ISO20022 XML payment instruction (pain.001)
description: Submit an XML pain.001 payment instruction according to the ISO20022 specification.
parameters:
- $ref: '#/components/parameters/authorization_in_header'
- $ref: '#/components/parameters/clientid_in_header'
Expand All @@ -683,7 +684,7 @@ paths:
- $ref: '#/components/parameters/optional_psu_ip_in_header'
- $ref: '#/components/parameters/optional_psu_user_agent_in_header'
requestBody:
description: The XML PAIN.001.
description: The XML pain.001.
required: true
content:
application/xml:
Expand Down Expand Up @@ -718,7 +719,7 @@ paths:
get:
tags:
- iso20022
summary: Retrieve a submitted ISO20022 XML PAIN.001 message
summary: Retrieve a submitted ISO20022 XML pain.001 message
parameters:
- $ref: '#/components/parameters/path_submissionId'
- $ref: '#/components/parameters/authorization_in_header'
Expand All @@ -730,7 +731,7 @@ paths:
- $ref: '#/components/parameters/optional_psu_user_agent_in_header'
responses:
'200':
description: Returns the requested ISO20022 XML PAIN.001 message.
description: Returns the requested ISO20022 XML pain.001 message.
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
Expand Down Expand Up @@ -770,12 +771,12 @@ paths:
- $ref: '#/components/parameters/optional_psu_user_agent_in_header'
responses:
'200':
description: ISO20022 XML PAIN.001 message submission has been deleted.
description: ISO20022 XML pain.001 message submission has been deleted.
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
'201':
description: ISO20022 XML PAIN.001 message submission is marked for deletion.
description: ISO20022 XML pain.001 message submission is marked for deletion.
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
Expand Down Expand Up @@ -813,7 +814,7 @@ paths:
- $ref: '#/components/parameters/optional_psu_user_agent_in_header'
responses:
'200':
description: Returns the requested ISO20022 XML PAIN.002 message.
description: Returns the requested ISO20022 XML pain.002 message.
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
Expand Down