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

Jump to bottom

refactor/tweaked the docs for BGv1.3 SigningBasket #2424

Merged
merged 1 commit into from
Sep 11, 2024
Merged

refactor/tweaked the docs for BGv1.3 SigningBasket #2424

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions obp-api/src/main/scala/code/api/berlin/group/v1_3/SigningBasketsApi.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ object APIMethods_SigningBasketsApi extends RestHelper {
"POST",
"/signing-baskets",
"Create a signing basket resource",
s"""${mockedDataText(true)}
s"""${mockedDataText(false)}
Create a signing basket resource for authorising several transactions with one SCA method.
The resource identifications of these transactions are contained in the payload of this access method
""",
Expand Down Expand Up @@ -136,7 +136,7 @@ The resource identifications of these transactions are contained in the payload
"DELETE",
"/signing-baskets/BASKETID",
"Delete the signing basket",
s"""${mockedDataText(true)}
s"""${mockedDataText(false)}
Delete the signing basket structure as long as no (partial) authorisation has yet been applied.
The undlerying transactions are not affected by this deletion.

Expand Down Expand Up @@ -173,7 +173,7 @@ Nevertheless, single transactions might be cancelled on an individual basis on t
"GET",
"/signing-baskets/BASKETID",
"Returns the content of an signing basket object.",
s"""${mockedDataText(true)}
s"""${mockedDataText(false)}
Returns the content of an signing basket object.""",
emptyObjectJson,
json.parse("""{
Expand Down Expand Up @@ -209,7 +209,7 @@ Returns the content of an signing basket object.""",
"GET",
"/signing-baskets/BASKETID/authorisations",
"Get Signing Basket Authorisation Sub-Resources Request",
s"""${mockedDataText(true)}
s"""${mockedDataText(false)}
Read a list of all authorisation subresources IDs which have been created.

This function returns an array of hyperlinks to all generated authorisation sub-resources.
Expand Down Expand Up @@ -242,7 +242,7 @@ This function returns an array of hyperlinks to all generated authorisation sub-
"GET",
"/signing-baskets/BASKETID/authorisations/AUTHORISATIONID",
"Read the SCA status of the signing basket authorisation",
s"""${mockedDataText(true)}
s"""${mockedDataText(false)}
This method returns the SCA status of a signing basket's authorisation sub-resource.
""",
emptyObjectJson,
Expand Down Expand Up @@ -278,7 +278,7 @@ This method returns the SCA status of a signing basket's authorisation sub-resou
"GET",
"/signing-baskets/BASKETID/status",
"Read the status of the signing basket",
s"""${mockedDataText(true)}
s"""${mockedDataText(false)}
Returns the status of a signing basket object.
""",
emptyObjectJson,
Expand Down Expand Up @@ -312,7 +312,7 @@ Returns the status of a signing basket object.
"POST",
"/signing-baskets/BASKETID/authorisations",
"Start the authorisation process for a signing basket",
s"""${mockedDataText(true)}
s"""${mockedDataText(false)}
Create an authorisation sub-resource and start the authorisation process of a signing basket.
The message might in addition transmit authentication and authorisation related data.

Expand Down Expand Up @@ -409,7 +409,7 @@ This applies in the following scenarios:
"PUT",
"/signing-baskets/BASKETID/authorisations/AUTHORISATIONID",
"Update PSU Data for signing basket",
s"""${mockedDataText(true)}
s"""${mockedDataText(false)}
This method update PSU data on the signing basket resource if needed.
It may authorise a igning basket within the Embedded SCA Approach where needed.

Expand Down
Loading