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

feat: remove payment pointer from resource url #297

Closed
wants to merge 8 commits into from
Closed
Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions .changeset/moody-students-greet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@interledger/openapi': minor
---

Removed payment pointer/wallet address from resource urls
63 changes: 28 additions & 35 deletions openapi/resource-server.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,8 @@ info:
contact:
email: [email protected]
servers:
- url: '{walletAddress}'
description: 'Server for when Wallet Address has a pathname (ie https://openpayments.guide/alice)'
variables:
walletAddress:
default: https://openpayments.guide/alice
- url: '{walletAddress}/.well-known/pay'
description: 'Server for when Wallet Address has no pathname (ie https://openpayments.guide)'
variables:
walletAddress:
default: https://openpayments.guide
- url: '/'
description: 'Server for Payment Pointer subresources or Connection resources (ie https://openpayments.guide/alice)'
tags:
- name: wallet-address
description: wallet address operations
Expand Down Expand Up @@ -119,7 +111,7 @@ paths:
examples:
New Incoming Payment for $25:
value:
id: 'https://openpayments.guide/alice/incoming-payments/08394f02-7b7b-45e2-b645-51d04e7c330c'
id: 'https://openpayments.guide/incoming-payments/08394f02-7b7b-45e2-b645-51d04e7c330c'
walletAddress: 'https://openpayments.guide/alice/'
incomingAmount:
value: '2500'
Expand Down Expand Up @@ -218,7 +210,7 @@ paths:
hasPreviousPage: false
hasNextPage: true
result:
- id: 'https://openpayments.guide/alice/incoming-payments/016da9d5-c9a4-4c80-a354-86b915a04ff8'
- id: 'https://openpayments.guide/incoming-payments/016da9d5-c9a4-4c80-a354-86b915a04ff8'
walletAddress: 'https://openpayments.guide/alice/'
incomingAmount:
value: '250'
Expand All @@ -236,7 +228,7 @@ paths:
description: 'Hi Mo, this is for the cappuccino I bought for you the other day.'
externalRef: Coffee w/ Mo on 10 March 22
completed: true
- id: 'https://openpayments.guide/alice/incoming-payments/32abc219-3dc3-44ec-a225-790cacfca8fa'
- id: 'https://openpayments.guide/incoming-payments/32abc219-3dc3-44ec-a225-790cacfca8fa'
walletAddress: 'https://openpayments.guide/alice/'
receivedAmount:
value: '100'
Expand All @@ -257,7 +249,7 @@ paths:
hasPreviousPage: true
hasNextPage: false
result:
- id: 'https://openpayments.guide/alice/incoming-payments/32abc219-3dc3-44ec-a225-790cacfca8fa'
- id: 'https://openpayments.guide/incoming-payments/32abc219-3dc3-44ec-a225-790cacfca8fa'
walletAddress: 'https://openpayments.guide/alice/'
receivedAmount:
value: '100'
Expand All @@ -270,7 +262,7 @@ paths:
updatedAt: '2022-04-01T10:24:36.11Z'
metadata:
description: 'I love your website, Alice! Thanks for the great content'
- id: 'https://openpayments.guide/alice/incoming-payments/016da9d5-c9a4-4c80-a354-86b915a04ff8'
- id: 'https://openpayments.guide/incoming-payments/016da9d5-c9a4-4c80-a354-86b915a04ff8'
walletAddress: 'https://openpayments.guide/alice/'
incomingAmount:
value: '250'
Expand Down Expand Up @@ -317,7 +309,7 @@ paths:
examples:
New Fixed Send Outgoing Payment for $25:
value:
id: 'https://openpayments.guide/alice/outgoing-payments/8c68d3cc-0a0f-4216-98b4-4fa44a6c88cf'
id: 'https://openpayments.guide/outgoing-payments/8c68d3cc-0a0f-4216-98b4-4fa44a6c88cf'
walletAddress: 'https://openpayments.guide/alice/'
failed: false
receiver: 'https://openpayments.guide/bob/incoming-payments/48884225-b393-4872-90de-1b737e2491c2'
Expand Down Expand Up @@ -347,7 +339,7 @@ paths:
examples:
Create an outgoing payment based on a quote:
value:
quoteId: 'https://openpayments.guide/alice/quotes/ab03296b-0c8b-4776-b94e-7ee27d868d4d'
quoteId: 'https://openpayments.guide/quotes/ab03296b-0c8b-4776-b94e-7ee27d868d4d'
metadata:
externalRef: INV2022-02-0137
schema:
Expand Down Expand Up @@ -403,7 +395,7 @@ paths:
hasPreviousPage: false
hasNextPage: true
result:
- id: 'https://openpayments.guide/alice/outgoing-payments/8c68d3cc-0a0f-4216-98b4-4fa44a6c88cf'
- id: 'https://openpayments.guide/outgoing-payments/8c68d3cc-0a0f-4216-98b4-4fa44a6c88cf'
walletAddress: 'https://openpayments.guide/alice/'
failed: false
receiver: 'https://openpayments.guide/aplusvideo/incoming-payments/45d495ad-b763-4882-88d7-aa14d261686e'
Expand All @@ -424,7 +416,7 @@ paths:
metadata:
description: APlusVideo subscription
externalRef: 'customer: 847458475'
- id: 'https://openpayments.guide/alice/outgoing-payments/0cffa5a4-58fd-4cc8-8e01-7145c72bf07c'
- id: 'https://openpayments.guide/outgoing-payments/0cffa5a4-58fd-4cc8-8e01-7145c72bf07c'
walletAddress: 'https://openpayments.guide/alice/'
failed: false
receiver: 'https://openpayments.guide/shoeshop/incoming-payments/2fe92c6f-ef0d-487c-8759-3784eae6bce9'
Expand Down Expand Up @@ -453,7 +445,7 @@ paths:
hasPreviousPage: true
hasNextPage: false
result:
- id: 'https://openpayments.guide/alice/outgoing-payments/0cffa5a4-58fd-4cc8-8e01-7145c72bf07c'
- id: 'https://openpayments.guide/outgoing-payments/0cffa5a4-58fd-4cc8-8e01-7145c72bf07c'
walletAddress: 'https://openpayments.guide/alice/'
failed: false
receiver: 'https://openpayments.guide/shoeshop/incoming-payments/2fe92c6f-ef0d-487c-8759-3784eae6bce9'
Expand All @@ -474,7 +466,7 @@ paths:
metadata:
description: Thank you for your purchase at ShoeShop!
externalRef: INV2022-8943756
- id: 'https://openpayments.guide/alice/outgoing-payments/8c68d3cc-0a0f-4216-98b4-4fa44a6c88cf'
- id: 'https://openpayments.guide/outgoing-payments/8c68d3cc-0a0f-4216-98b4-4fa44a6c88cf'
walletAddress: 'https://openpayments.guide/alice/'
failed: false
receiver: 'https://openpayments.guide/aplusvideo/incoming-payments/45d495ad-b763-4882-88d7-aa14d261686e'
Expand Down Expand Up @@ -524,7 +516,7 @@ paths:
examples:
New Fixed Send Quote for $25:
value:
id: 'https://openpayments.guide/alice/quotes/8c68d3cc-0a0f-4216-98b4-4fa44a6c88cf'
id: 'https://openpayments.guide/quotes/8c68d3cc-0a0f-4216-98b4-4fa44a6c88cf'
walletAddress: 'https://openpayments.guide/alice/'
receiver: 'https://openpayments.guide/aplusvideo/incoming-payments/45d495ad-b763-4882-88d7-aa14d261686e'
debitAmount:
Expand Down Expand Up @@ -556,7 +548,7 @@ paths:
assetScale: 2
Create fixed-receive-amount quote for $25:
value:
receiver: 'https://openpayments.guide/alice/incoming-payments/37a0d0ee-26dc-4c66-89e0-01fbf93156f7'
receiver: 'https://openpayments.guide/incoming-payments/37a0d0ee-26dc-4c66-89e0-01fbf93156f7'
receiveAmount:
value: '2500'
assetCode: USD
Expand Down Expand Up @@ -620,7 +612,7 @@ paths:
examples:
Incoming Payment for $25 with $12.34 received so far:
value:
id: 'https://openpayments.guide/alice/incoming-payments/2f1b0150-db73-49e8-8713-628baa4a17ff'
id: 'https://openpayments.guide/incoming-payments/2f1b0150-db73-49e8-8713-628baa4a17ff'
walletAddress: 'https://openpayments.guide/alice/'
incomingAmount:
value: '2500'
Expand Down Expand Up @@ -672,7 +664,7 @@ paths:
examples:
Completed Incoming Payment:
value:
id: 'https://openpayments.guide/alice/incoming-payments/016da9d5-c9a4-4c80-a354-86b915a04ff8'
id: 'https://openpayments.guide/incoming-payments/016da9d5-c9a4-4c80-a354-86b915a04ff8'
walletAddress: 'https://openpayments.guide/alice/'
incomingAmount:
value: '250'
Expand Down Expand Up @@ -723,7 +715,7 @@ paths:
id: 'https://openpayments.guide/bob/outgoing-payments/3859b39e-4666-4ce5-8745-72f1864c5371'
walletAddress: 'https://openpayments.guide/bob/'
failed: false
receiver: 'https://openpayments.guide/alice/incoming-payments/2f1b0150-db73-49e8-8713-628baa4a17ff'
receiver: 'https://openpayments.guide/incoming-payments/2f1b0150-db73-49e8-8713-628baa4a17ff'
debitAmount:
value: '2500'
assetCode: USD
Expand Down Expand Up @@ -771,7 +763,7 @@ paths:
value:
id: 'https://openpayments.guide/bob/quotes/3859b39e-4666-4ce5-8745-72f1864c5371'
walletAddress: 'https://openpayments.guide/bob/'
receiver: 'https://openpayments.guide/alice/incoming-payments/2f1b0150-db73-49e8-8713-628baa4a17ff'
receiver: 'https://openpayments.guide/incoming-payments/2f1b0150-db73-49e8-8713-628baa4a17ff'
debitAmount:
value: '2500'
assetCode: USD
Expand Down Expand Up @@ -893,7 +885,7 @@ components:
description: 'An **incoming payment** resource represents a payment that will be, is currently being, or has been received by the account.'
type: object
examples:
- id: 'https://openpayments.guide/alice/incoming-payments/016da9d5-c9a4-4c80-a354-86b915a04ff8'
- id: 'https://openpayments.guide/incoming-payments/016da9d5-c9a4-4c80-a354-86b915a04ff8'
walletAddress: 'https://openpayments.guide/alice/'
incomingAmount:
value: '250'
Expand All @@ -910,8 +902,9 @@ components:
metadata:
description: 'Hi Mo, this is for the cappuccino I bought for you the other day.'
externalRef: Coffee w/ Mo on 10 March 22
- id: 'https://openpayments.guide/alice/incoming-payments/456da9d5-c9a4-4c80-a354-86b915a04ff8'
- id: 'https://openpayments.guide/incoming-payments/456da9d5-c9a4-4c80-a354-86b915a04ff8'
walletAddress: 'https://openpayments.guide/alice/'
paymentPointer: 'https://openpayments.guide/alice/'
incomingAmount:
value: '2500'
assetCode: USD
Expand Down Expand Up @@ -971,7 +964,7 @@ components:
description: An **incoming payment** resource with the Interledger STREAM Connection to use to pay into the wallet address under this incoming payment.
type: object
examples:
- id: 'https://openpayments.guide/alice/incoming-payments/016da9d5-c9a4-4c80-a354-86b915a04ff8'
- id: 'https://openpayments.guide/incoming-payments/016da9d5-c9a4-4c80-a354-86b915a04ff8'
walletAddress: 'https://openpayments.guide/alice/'
incomingAmount:
value: '250'
Expand Down Expand Up @@ -1004,7 +997,7 @@ components:
description: An **incoming payment** resource with the url for the Interledger STREAM Connection resource to use to pay into the wallet address under this incoming payment.
type: object
examples:
- id: 'https://openpayments.guide/alice/incoming-payments/456da9d5-c9a4-4c80-a354-86b915a04ff8'
- id: 'https://openpayments.guide/incoming-payments/456da9d5-c9a4-4c80-a354-86b915a04ff8'
walletAddress: 'https://openpayments.guide/alice/'
incomingAmount:
value: '2500'
Expand Down Expand Up @@ -1047,7 +1040,7 @@ components:
description: 'An **outgoing payment** resource represents a payment that will be, is currently being, or has previously been, sent from the wallet address.'
type: object
examples:
- id: 'https://openpayments.guide/alice/outgoing-payments/8c68d3cc-0a0f-4216-98b4-4fa44a6c88cf'
- id: 'https://openpayments.guide/outgoing-payments/8c68d3cc-0a0f-4216-98b4-4fa44a6c88cf'
walletAddress: 'https://openpayments.guide/alice/'
failed: false
receiver: 'https://openpayments.guide/aplusvideo/incoming-payments/45d495ad-b763-4882-88d7-aa14d261686e'
Expand All @@ -1068,7 +1061,7 @@ components:
metadata:
description: APlusVideo subscription
externalRef: 'customer: 847458475'
- id: 'https://openpayments.guide/alice/outgoing-payments/0cffa5a4-58fd-4cc8-8e01-7145c72bf07c'
- id: 'https://openpayments.guide/outgoing-payments/0cffa5a4-58fd-4cc8-8e01-7145c72bf07c'
walletAddress: 'https://openpayments.guide/alice/'
failed: false
receiver: 'https://openpayments.guide/shoeshop/2fe92c6f-ef0d-487c-8759-3784eae6bce9'
Expand Down Expand Up @@ -1143,7 +1136,7 @@ components:
description: A **quote** resource represents the quoted amount details with which an Outgoing Payment may be created.
type: object
examples:
- id: 'https://openpayments.guide/alice/quotes/ab03296b-0c8b-4776-b94e-7ee27d868d4d'
- id: 'https://openpayments.guide/quotes/ab03296b-0c8b-4776-b94e-7ee27d868d4d'
walletAddress: 'https://openpayments.guide/alice/'
receiver: 'https://openpayments.guide/shoeshop/incoming-payments/2fe92c6f-ef0d-487c-8759-3784eae6bce9'
receiveAmount:
Expand All @@ -1160,7 +1153,7 @@ components:
assetScale: 2
createdAt: '2022-03-12T23:20:50.52Z'
expiresAt: '2022-04-12T23:20:50.52Z'
- id: 'https://openpayments.guide/alice/quotes/8c68d3cc-0a0f-4216-98b4-4fa44a6c88cf'
- id: 'https://openpayments.guide/quotes/8c68d3cc-0a0f-4216-98b4-4fa44a6c88cf'
walletAddress: 'https://openpayments.guide/alice/'
receiver: 'https://openpayments.guide/aplusvideo/incoming-payments/45d495ad-b763-4882-88d7-aa14d261686e'
debitAmount:
Expand Down
2 changes: 1 addition & 1 deletion openapi/schemas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,5 @@ components:
format: uri
pattern: '^https://(.+)/(incoming-payments|connections)/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
examples:
- 'https://openpayments.guide/alice/incoming-payments/08394f02-7b7b-45e2-b645-51d04e7c330c'
- 'https://openpayments.guide/incoming-payments/08394f02-7b7b-45e2-b645-51d04e7c330c'
- 'https://openpayments.guide/connections/016da9d5-c9a4-4c80-a354-86b915a04ff8'
Loading
Loading