Skip to content

Commit

Permalink
chore: add accounts to party and fix references (#51)
Browse files Browse the repository at this point in the history
  • Loading branch information
kleyow authored Feb 15, 2021
1 parent d265a5a commit 5b8991d
Show file tree
Hide file tree
Showing 42 changed files with 564 additions and 1,445 deletions.
1,298 changes: 519 additions & 779 deletions docs/thirdparty-openapi3-snippets.yaml

Large diffs are not rendered by default.

12 changes: 1 addition & 11 deletions thirdparty/openapi3/components/schemas/Amount.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1 @@
title: Amount
type: string
pattern: '^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$'
description: |
The API data type Amount is a JSON String in a canonical format that is
restricted by a regular expression for interoperability reasons.
This pattern does not allow any trailing zeroes at all, but allows an amount
without a minor currency unit. It also only allows four digits in the minor
currency unit; a negative value is not allowed. Using more than 18 digits
in the major currency unit is not allowed.
example: 123.45
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/Amount.yaml'
13 changes: 1 addition & 12 deletions thirdparty/openapi3/components/schemas/AmountType.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1 @@
title: AmountType
type: string
enum:
- SEND
- RECEIVE
description: |
Below are the allowed values for the enumeration AmountType.
- SEND - Amount the Payer would like to send, that is, the amount that should
be withdrawn from the Payer account including any fees.
- RECEIVE - Amount the Payer would like the Payee to receive, that is,
the amount that should be sent to the receiver exclusive of any fees.
example: RECEIVE
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/AmountType.yaml'
11 changes: 1 addition & 10 deletions thirdparty/openapi3/components/schemas/AuthenticationType.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1 @@
title: AuthenticationType
type: string
enum:
- OTP
- QRCODE
description: |
Below are the allowed values for the enumeration AuthenticationType.
- OTP - One-time password generated by the Payer FSP.
- QRCODE - QR code used as One Time Password.
example: OTP
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/AuthenticationType.yaml'
9 changes: 1 addition & 8 deletions thirdparty/openapi3/components/schemas/BinaryString.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1 @@
type: string
pattern: '^[A-Za-z0-9-_]+[=]{0,2}$'
description: |
The API data type BinaryString is a JSON String.
The string is a base64url encoding of a string of raw bytes,
where padding (character ‘=’) is added at the end of the data if
needed to ensure that the string is a multiple of 4 characters.
The length restriction indicates the allowed number of characters.
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/BinaryString.yaml'
17 changes: 1 addition & 16 deletions thirdparty/openapi3/components/schemas/CorrelationId.yaml
Original file line number Diff line number Diff line change
@@ -1,16 +1 @@
title: CorrelationId
type: string
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
description: >
Identifier that correlates all messages of the same sequence.
The API data type UUID (Universally Unique Identifier) is a JSON String
in canonical format, conforming to [RFC
4122](https://tools.ietf.org/html/rfc4122),
that is restricted by a regular expression for interoperability reasons.
A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes
(‘-‘).
example: b51ec534-ee48-4575-b6a9-ead2955b8069
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml'
176 changes: 1 addition & 175 deletions thirdparty/openapi3/components/schemas/Currency.yaml
Original file line number Diff line number Diff line change
@@ -1,175 +1 @@
title: Currency
description: >
The currency codes defined in
[ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)
as three-letter alphabetic codes are used as the standard naming
representation for currencies.
type: string
minLength: 3
maxLength: 3
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GGP
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- IMP
- INR
- IQD
- IRR
- ISK
- JEP
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SPL
- SRD
- STD
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TVD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XCD
- XDR
- XOF
- XPF
- YER
- ZAR
- ZMW
- ZWD
example: USD
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/Currency.yaml'
7 changes: 1 addition & 6 deletions thirdparty/openapi3/components/schemas/DateOfBirth.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
title: DateofBirth (type Date)
type: string
pattern: >-
^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
description: Date of Birth of the Party.
example: '1966-06-16'
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/DateOfBirth.yaml'
15 changes: 1 addition & 14 deletions thirdparty/openapi3/components/schemas/DateTime.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1 @@
title: DateTime
type: string
pattern: >-
^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
description: |
The API data type DateTime is a JSON String in a lexical format that is
restricted by a regular expression for interoperability reasons.
The format is according to
[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html),
expressed in a combined date, time and time zone format.
A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM].
Examples are \"2016-05-24T08:38:08.699-04:00\", \"2016-05-24T08:38:08.699Z\"
(where Z indicates Zulu time zone, same as UTC).
example: '2016-05-24T08:38:08.699-04:00'
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/DateTime.yaml'
13 changes: 1 addition & 12 deletions thirdparty/openapi3/components/schemas/ErrorCode.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1 @@
title: ErrorCode
type: string
pattern: '^[1-9]\d{3}$'
description: |
The API data type ErrorCode is a JSON String of four characters,
consisting of digits only. Negative numbers are not allowed.
A leading zero is not allowed. Each error code in the API is a
four-digit number, for example, 1234, where the first number
(1 in the example) represents the high-level error category,
the second number (2 in the example) represents the low-level error category,
and the last two numbers (34 in the example) represent the specific error.
example: 5100
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/ErrorCode.yaml'
7 changes: 1 addition & 6 deletions thirdparty/openapi3/components/schemas/ErrorDescription.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
title: ErrorDescription
type: string
minLength: 1
maxLength: 128
description: Error description string.
example: This is an error description.
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/ErrorDescription.yaml'
14 changes: 1 addition & 13 deletions thirdparty/openapi3/components/schemas/ErrorInformation.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1 @@
title: ErrorInformation
type: object
description: Data model for the complex type ErrorInformation.
properties:
errorCode:
$ref: ./ErrorCode.yaml
errorDescription:
$ref: ./ErrorDescription.yaml
extensionList:
$ref: ./ExtensionList.yaml
required:
- errorCode
- errorDescription
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/ErrorInformation.yaml'
12 changes: 1 addition & 11 deletions thirdparty/openapi3/components/schemas/Extension.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1 @@
title: Extension
type: object
description: Data model for the complex type Extension.
properties:
key:
$ref: ./ExtensionKey.yaml
value:
$ref: ./ExtensionValue.yaml
required:
- key
- value
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/Extension.yaml'
6 changes: 1 addition & 5 deletions thirdparty/openapi3/components/schemas/ExtensionKey.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
title: ExtensionKey
type: string
minLength: 1
maxLength: 32
description: Extension key.
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/ExtensionKey.yaml'
16 changes: 1 addition & 15 deletions thirdparty/openapi3/components/schemas/ExtensionList.yaml
Original file line number Diff line number Diff line change
@@ -1,15 +1 @@
title: ExtensionList
type: object
description: |
Data model for the complex type ExtensionList.
An optional list of extensions, specific to deployment.
properties:
extension:
type: array
items:
$ref: ./Extension.yaml
minItems: 1
maxItems: 16
description: Number of Extension elements.
required:
- extension
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/ExtensionList.yaml'
6 changes: 1 addition & 5 deletions thirdparty/openapi3/components/schemas/ExtensionValue.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
title: ExtensionValue
type: string
minLength: 1
maxLength: 128
description: Extension value.
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/ExtensionValue.yaml'
8 changes: 1 addition & 7 deletions thirdparty/openapi3/components/schemas/FirstName.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1 @@
title: FirstName
type: string
minLength: 1
maxLength: 128
pattern: '^(?!\s*$)[\w .,''-]{1,128}$'
description: First name of the Party (Name Type).
example: Henrik
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/FirstName.yaml'
7 changes: 1 addition & 6 deletions thirdparty/openapi3/components/schemas/FspId.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
title: FspId
type: string
minLength: 1
maxLength: 32
description: FSP identifier.
example: 1234
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/FspId.yaml'
14 changes: 1 addition & 13 deletions thirdparty/openapi3/components/schemas/GeoCode.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1 @@
title: GeoCode
type: object
description: |
Data model for the complex type GeoCode.
Indicates the geographic location from where the transaction was initiated.
properties:
latitude:
$ref: ./Latitude.yaml
longitude:
$ref: ./Longitude.yaml
required:
- latitude
- longitude
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/GeoCode.yaml'
7 changes: 1 addition & 6 deletions thirdparty/openapi3/components/schemas/IlpCondition.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
title: IlpCondition
type: string
pattern: '^[A-Za-z0-9-_]{43}$'
maxLength: 48
description: Condition that must be attached to the transfer by the Payer.
example: f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/IlpCondition.yaml'
7 changes: 1 addition & 6 deletions thirdparty/openapi3/components/schemas/IlpFulfilment.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1 @@
title: IlpFulfilment
type: string
pattern: '^[A-Za-z0-9-_]{43}$'
maxLength: 48
description: Fulfilment that must be attached to the transfer by the Payee.
example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
$ref: '../../../../fspiop/v1_1/openapi3/components/schemas/IlpFulfilment.yaml'
Loading

0 comments on commit 5b8991d

Please sign in to comment.