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

224/mk/post quote update #230

Merged
merged 18 commits into from
Dec 9, 2022
Merged

224/mk/post quote update #230

Changes from 17 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
29e14ad
test: attempt to make POST quote amounts oneOf
mkurapov Dec 8, 2022
8576164
feat: another oneOf attempt
mkurapov Dec 8, 2022
b1a5ea6
feat: proper format
mkurapov Dec 8, 2022
bf0c725
remove properties from oneOf
mkurapov Dec 8, 2022
65d3c30
attempting nested property
mkurapov Dec 8, 2022
c900f35
convert oneOf to array
mkurapov Dec 8, 2022
11b3690
move oneOf outside of properties
mkurapov Dec 8, 2022
35ea6d7
remove extraneous property
mkurapov Dec 8, 2022
f1f960f
move receiver into oneOf
mkurapov Dec 8, 2022
5f3b19e
oneOf schema instead
mkurapov Dec 8, 2022
37aa427
named schema
mkurapov Dec 8, 2022
bb47ef0
no labelled schema
mkurapov Dec 8, 2022
eb401e6
Single receiver possibility
mkurapov Dec 8, 2022
0309165
simplify by using oneOf required
mkurapov Dec 8, 2022
8f704ed
Revert "simplify by using oneOf required"
mkurapov Dec 8, 2022
5515c24
Update descriptions
mkurapov Dec 8, 2022
8b74a0c
update send and receiveAmount descriptions for quote creation
mkurapov Dec 9, 2022
a1f363d
more description updates
mkurapov Dec 9, 2022
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
42 changes: 31 additions & 11 deletions openapi/resource-server.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -576,17 +576,37 @@ paths:
assetCode: USD
assetScale: 2
schema:
type: object
additionalProperties: false
properties:
receiver:
$ref: ./schemas.yaml#/components/schemas/receiver
receiveAmount:
$ref: ./schemas.yaml#/components/schemas/amount
sendAmount:
$ref: ./schemas.yaml#/components/schemas/amount
required:
- receiver
oneOf:
- description: Create quote for an `receiver` that is an Incoming Payment with an `incomingAmount`
properties:
receiver:
$ref: ./schemas.yaml#/components/schemas/receiver
required:
- receiver
additionalProperties: false
- description: Create a quote with a fixed-receive amount
properties:
receiver:
$ref: ./schemas.yaml#/components/schemas/receiver
receiveAmount:
description: The maximum amount that should be paid into the receiving payment pointer.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
description: The maximum amount that should be paid into the receiving payment pointer.
description: The fixed amount that would be paid into the receiving payment pointer.

with maybe some caveat about assuming a successful subsequent outgoing payment.

$ref: ./schemas.yaml#/components/schemas/amount
required:
- receiver
- receiveAmount
additionalProperties: false
- description: Create a quote with a fixed send amount
properties:
receiver:
$ref: ./schemas.yaml#/components/schemas/receiver
sendAmount:
description: The maximum amount that should be sent from the sending payment pointer.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
description: The maximum amount that should be sent from the sending payment pointer.
description: The fixed amount that would be sent from the sending payment pointer.

$ref: ./schemas.yaml#/components/schemas/amount
required:
- receiver
- sendAmount
additionalProperties: false

description: |-
A subset of the quotes schema is accepted as input to create a new quote.

Expand Down