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.

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

[APIB-6207] Updates to xero_accounting.yaml #684

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
45 changes: 45 additions & 0 deletions xero_accounting.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1228,6 +1228,21 @@ paths:
type: integer
- $ref: '#/components/parameters/unitdp'
- $ref: '#/components/parameters/pageSize'
- in: query
name: IDs
x-snake: ids
description: Filter by a comma-separated list of BankTransactionIDs.
Copy link
Contributor Author

@ronnel-santiago-xero ronnel-santiago-xero Nov 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to be able to use $ref for this IDs but at the same time to supply a different description to make it clear what type of IDs are expected for each endpoints, it looks like it is not possible
"Any sibling elements of a $ref are ignored."

style: form
explode: false
example: '"00000000-0000-0000-0000-000000000000"'
x-example-java: Arrays.asList(UUID.fromString("00000000-0000-0000-0000-000000000000"))
x-example-php: '"00000000-0000-0000-0000-000000000000"'
x-example-csharp: new List<Guid>{Guid.Parse("00000000-0000-0000-0000-000000000000")};
schema:
type: array
items:
type: string
format: uuid
responses:
"200":
description: Success - return response of type BankTransactions array with 0 to n BankTransaction
Expand Down Expand Up @@ -11090,6 +11105,21 @@ paths:
type: integer
- $ref: '#/components/parameters/unitdp'
- $ref: '#/components/parameters/pageSize'
- in: query
name: IDs
x-snake: ids
description: Filter by a comma-separated list of OverpaymentIDs.
style: form
explode: false
example: '"00000000-0000-0000-0000-000000000000"'
x-example-java: Arrays.asList(UUID.fromString("00000000-0000-0000-0000-000000000000"))
x-example-php: '"00000000-0000-0000-0000-000000000000"'
x-example-csharp: new List<Guid>{Guid.Parse("00000000-0000-0000-0000-000000000000")};
schema:
type: array
items:
type: string
format: uuid
responses:
"200":
description: Success - return response of type Overpayments array with all Overpayments
Expand Down Expand Up @@ -12518,6 +12548,21 @@ paths:
type: integer
- $ref: '#/components/parameters/unitdp'
- $ref: '#/components/parameters/pageSize'
- in: query
name: IDs
x-snake: ids
description: Filter by a comma-separated list of PrepaymentIDs.
style: form
explode: false
example: '"00000000-0000-0000-0000-000000000000"'
x-example-java: Arrays.asList(UUID.fromString("00000000-0000-0000-0000-000000000000"))
x-example-php: '"00000000-0000-0000-0000-000000000000"'
x-example-csharp: new List<Guid>{Guid.Parse("00000000-0000-0000-0000-000000000000")};
schema:
type: array
items:
type: string
format: uuid
responses:
"200":
description: Success - return response of type Prepayments array for all Prepayment
Expand Down
Loading