Skip to content

Commit

Permalink
Merge pull request #100 from ConsumerDataStandardsAustralia/feature/1…
Browse files Browse the repository at this point in the history
….1.1

Feature/1.1.1
  • Loading branch information
vadkor authored Feb 3, 2020
2 parents 23f3907 + 6c65885 commit a57cb1d
Show file tree
Hide file tree
Showing 396 changed files with 23,592 additions and 5,413 deletions.
2 changes: 1 addition & 1 deletion api-model/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<parent>
<groupId>au.org.consumerdatastandards</groupId>
<artifactId>cds-java-artefacts</artifactId>
<version>1.1.0-SNAPSHOT</version>
<version>1.1.1-SNAPSHOT</version>
</parent>
<artifactId>api-model</artifactId>
<name>API Model</name>
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
package au.org.consumerdatastandards.api.banking;
package au.org.consumerdatastandards.api.v1_0_0.banking;

import au.org.consumerdatastandards.api.banking.models.RequestAccountIds;
import au.org.consumerdatastandards.api.banking.models.ResponseBankingDirectDebitAuthorisationList;
import au.org.consumerdatastandards.api.common.models.ResponseErrorList;
import au.org.consumerdatastandards.api.banking.models.ParamProductCategory;
import au.org.consumerdatastandards.api.banking.models.ParamAccountOpenStatus;
import au.org.consumerdatastandards.api.v1_0_0.banking.models.RequestAccountIds;
import au.org.consumerdatastandards.api.v1_0_0.banking.models.ResponseBankingDirectDebitAuthorisationList;
import au.org.consumerdatastandards.api.v1_0_0.common.models.ResponseErrorList;
import au.org.consumerdatastandards.api.v1_0_0.banking.models.ParamProductCategory;
import au.org.consumerdatastandards.api.v1_0_0.banking.models.ParamAccountOpenStatus;
import au.org.consumerdatastandards.support.data.*;
import au.org.consumerdatastandards.support.*;

Expand Down Expand Up @@ -48,7 +48,7 @@ ResponseBankingDirectDebitAuthorisationList listDirectDebits(
in = ParamLocation.PATH
)
@CDSDataType(CustomDataType.ASCII)
String accountId,
String accountId,
@Param(
name = "page",
description = "Page of results to request (standard pagination)",
Expand All @@ -57,7 +57,7 @@ ResponseBankingDirectDebitAuthorisationList listDirectDebits(
reference = "ParamPage"
)
@CDSDataType(CustomDataType.PositiveInteger)
Integer page,
Integer page,
@Param(
name = "page-size",
description = "Page size to request. Default is 25 (standard pagination)",
Expand All @@ -80,36 +80,36 @@ ResponseBankingDirectDebitAuthorisationList listDirectDebits(
in = ParamLocation.HEADER,
reference = "RequestHeader_x-min-v"
)
String xMinV,
String xMinV,
@Param(
name = "x-fapi-interaction-id",
description = "An [RFC4122](https://tools.ietf.org/html/rfc4122) UID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-fapi-interaction-id"
)
String xFapiInteractionId,
String xFapiInteractionId,
@Param(
name = "x-fapi-auth-date",
description = "The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-fapi-auth-date"
)
String xFapiAuthDate,
String xFapiAuthDate,
@Param(
name = "x-fapi-customer-ip-address",
description = "The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-fapi-customer-ip-address"
)
String xFapiCustomerIpAddress,
String xFapiCustomerIpAddress,
@Param(
name = "x-cds-User-Agent",
description = "The customers original User Agent header if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. Base64 encoded contents which may included additional parameters.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-cds-User-Agent"
)
@CDSDataType(CustomDataType.Base64)
String xCdsUserAgent,
String xCdsUserAgent,
@Param(
name = "x-cds-subject",
description = "Subject identifier. Locally unique and never reassigned identifier within the Holder for the End-User. Mandatory for authenticated calls. Not required for unattended or unauthenticated calls.",
Expand Down Expand Up @@ -156,23 +156,23 @@ ResponseBankingDirectDebitAuthorisationList listDirectDebitsBulk(
in = ParamLocation.QUERY,
reference = "ParamProductCategory"
)
ParamProductCategory productCategory,
ParamProductCategory productCategory,
@Param(
name = "open-status",
description = "Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed",
in = ParamLocation.QUERY,
defaultValue = "ALL",
reference = "ParamAccountOpenStatus"
)
ParamAccountOpenStatus openStatus,
ParamAccountOpenStatus openStatus,
@Param(
name = "is-owned",
description = "Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts",
in = ParamLocation.QUERY,
reference = "ParamAccountIsOwned"
)
@CDSDataType(CustomDataType.Boolean)
Boolean isOwned,
Boolean isOwned,
@Param(
name = "page",
description = "Page of results to request (standard pagination)",
Expand All @@ -181,7 +181,7 @@ ResponseBankingDirectDebitAuthorisationList listDirectDebitsBulk(
reference = "ParamPage"
)
@CDSDataType(CustomDataType.PositiveInteger)
Integer page,
Integer page,
@Param(
name = "page-size",
description = "Page size to request. Default is 25 (standard pagination)",
Expand All @@ -204,36 +204,36 @@ ResponseBankingDirectDebitAuthorisationList listDirectDebitsBulk(
in = ParamLocation.HEADER,
reference = "RequestHeader_x-min-v"
)
String xMinV,
String xMinV,
@Param(
name = "x-fapi-interaction-id",
description = "An [RFC4122](https://tools.ietf.org/html/rfc4122) UID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-fapi-interaction-id"
)
String xFapiInteractionId,
String xFapiInteractionId,
@Param(
name = "x-fapi-auth-date",
description = "The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-fapi-auth-date"
)
String xFapiAuthDate,
String xFapiAuthDate,
@Param(
name = "x-fapi-customer-ip-address",
description = "The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-fapi-customer-ip-address"
)
String xFapiCustomerIpAddress,
String xFapiCustomerIpAddress,
@Param(
name = "x-cds-User-Agent",
description = "The customers original User Agent header if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. Base64 encoded contents which may included additional parameters.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-cds-User-Agent"
)
@CDSDataType(CustomDataType.Base64)
String xCdsUserAgent,
String xCdsUserAgent,
@Param(
name = "x-cds-subject",
description = "Subject identifier. Locally unique and never reassigned identifier within the Holder for the End-User. Mandatory for authenticated calls. Not required for unattended or unauthenticated calls.",
Expand Down Expand Up @@ -291,7 +291,7 @@ ResponseBankingDirectDebitAuthorisationList listDirectDebitsSpecificAccounts(
description = "Array of specific accountIds to obtain authorisations for",
in = ParamLocation.BODY
)
RequestAccountIds accountIds,
RequestAccountIds accountIds,
@Param(
name = "page",
description = "Page of results to request (standard pagination)",
Expand All @@ -300,7 +300,7 @@ ResponseBankingDirectDebitAuthorisationList listDirectDebitsSpecificAccounts(
reference = "ParamPage"
)
@CDSDataType(CustomDataType.PositiveInteger)
Integer page,
Integer page,
@Param(
name = "page-size",
description = "Page size to request. Default is 25 (standard pagination)",
Expand All @@ -323,36 +323,36 @@ ResponseBankingDirectDebitAuthorisationList listDirectDebitsSpecificAccounts(
in = ParamLocation.HEADER,
reference = "RequestHeader_x-min-v"
)
String xMinV,
String xMinV,
@Param(
name = "x-fapi-interaction-id",
description = "An [RFC4122](https://tools.ietf.org/html/rfc4122) UID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-fapi-interaction-id"
)
String xFapiInteractionId,
String xFapiInteractionId,
@Param(
name = "x-fapi-auth-date",
description = "The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-fapi-auth-date"
)
String xFapiAuthDate,
String xFapiAuthDate,
@Param(
name = "x-fapi-customer-ip-address",
description = "The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-fapi-customer-ip-address"
)
String xFapiCustomerIpAddress,
String xFapiCustomerIpAddress,
@Param(
name = "x-cds-User-Agent",
description = "The customers original User Agent header if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. Base64 encoded contents which may included additional parameters.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-cds-User-Agent"
)
@CDSDataType(CustomDataType.Base64)
String xCdsUserAgent,
String xCdsUserAgent,
@Param(
name = "x-cds-subject",
description = "Subject identifier. Locally unique and never reassigned identifier within the Holder for the End-User. Mandatory for authenticated calls. Not required for unattended or unauthenticated calls.",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package au.org.consumerdatastandards.api.banking;
package au.org.consumerdatastandards.api.v1_0_0.banking;

import au.org.consumerdatastandards.api.banking.models.ResponseBankingPayeeById;
import au.org.consumerdatastandards.api.banking.models.ResponseBankingPayeeList;
import au.org.consumerdatastandards.api.v1_0_0.banking.models.ResponseBankingPayeeById;
import au.org.consumerdatastandards.api.v1_0_0.banking.models.ResponseBankingPayeeList;
import au.org.consumerdatastandards.support.data.*;
import au.org.consumerdatastandards.support.*;

Expand Down Expand Up @@ -52,50 +52,50 @@ ResponseBankingPayeeById getPayeeDetail(
in = ParamLocation.PATH
)
@CDSDataType(CustomDataType.ASCII)
String payeeId,
String payeeId,
@Param(
name = "x-v",
description = "Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers)",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-v"
)
String xV,
String xV,
@Param(
name = "x-min-v",
description = "Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder should respond with a 406 Not Acceptable.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-min-v"
)
String xMinV,
String xMinV,
@Param(
name = "x-fapi-interaction-id",
description = "An [RFC4122](https://tools.ietf.org/html/rfc4122) UID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-fapi-interaction-id"
)
String xFapiInteractionId,
String xFapiInteractionId,
@Param(
name = "x-fapi-auth-date",
description = "The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-fapi-auth-date"
)
String xFapiAuthDate,
String xFapiAuthDate,
@Param(
name = "x-fapi-customer-ip-address",
description = "The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-fapi-customer-ip-address"
)
String xFapiCustomerIpAddress,
String xFapiCustomerIpAddress,
@Param(
name = "x-cds-User-Agent",
description = "The customers original User Agent header if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. Base64 encoded contents which may included additional parameters.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-cds-User-Agent"
)
@CDSDataType(CustomDataType.Base64)
String xCdsUserAgent,
String xCdsUserAgent,
@Param(
name = "x-cds-subject",
description = "Subject identifier. Locally unique and never reassigned identifier within the Holder for the End-User. Mandatory for authenticated calls. Not required for unattended or unauthenticated calls.",
Expand Down Expand Up @@ -142,7 +142,7 @@ ResponseBankingPayeeList listPayees(
in = ParamLocation.QUERY,
defaultValue = "ALL"
)
ParamType type,
ParamType type,
@Param(
name = "page",
description = "Page of results to request (standard pagination)",
Expand All @@ -151,7 +151,7 @@ ResponseBankingPayeeList listPayees(
reference = "ParamPage"
)
@CDSDataType(CustomDataType.PositiveInteger)
Integer page,
Integer page,
@Param(
name = "page-size",
description = "Page size to request. Default is 25 (standard pagination)",
Expand All @@ -174,36 +174,36 @@ ResponseBankingPayeeList listPayees(
in = ParamLocation.HEADER,
reference = "RequestHeader_x-min-v"
)
String xMinV,
String xMinV,
@Param(
name = "x-fapi-interaction-id",
description = "An [RFC4122](https://tools.ietf.org/html/rfc4122) UID used as a correlation id. If provided, the data holder must play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-fapi-interaction-id"
)
String xFapiInteractionId,
String xFapiInteractionId,
@Param(
name = "x-fapi-auth-date",
description = "The time when the customer last logged in to the data recipient. Required for all resource calls (customer present and unattended). Not to be included for unauthenticated calls.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-fapi-auth-date"
)
String xFapiAuthDate,
String xFapiAuthDate,
@Param(
name = "x-fapi-customer-ip-address",
description = "The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-fapi-customer-ip-address"
)
String xFapiCustomerIpAddress,
String xFapiCustomerIpAddress,
@Param(
name = "x-cds-User-Agent",
description = "The customers original User Agent header if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls. Base64 encoded contents which may included additional parameters.",
in = ParamLocation.HEADER,
reference = "RequestHeader_x-cds-User-Agent"
)
@CDSDataType(CustomDataType.Base64)
String xCdsUserAgent,
String xCdsUserAgent,
@Param(
name = "x-cds-subject",
description = "Subject identifier. Locally unique and never reassigned identifier within the Holder for the End-User. Mandatory for authenticated calls. Not required for unattended or unauthenticated calls.",
Expand Down
Loading

0 comments on commit a57cb1d

Please sign in to comment.