From 64b56e5f48d2867eadc2fbfcafeb4330415811cc Mon Sep 17 00:00:00 2001 From: Nathan Lie Date: Wed, 27 Sep 2023 08:06:23 -0700 Subject: [PATCH] feat: add changeset --- .changeset/clean-mice-sparkle.md | 5 +++ .../generated/resource-server-types.ts | 34 +++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 .changeset/clean-mice-sparkle.md diff --git a/.changeset/clean-mice-sparkle.md b/.changeset/clean-mice-sparkle.md new file mode 100644 index 00000000..6ad5938d --- /dev/null +++ b/.changeset/clean-mice-sparkle.md @@ -0,0 +1,5 @@ +--- +'@interledger/open-payments': minor +--- + +Added "walletAddress" field to resource POST request bodies, added "wallet-address" query parameter to resource GET requests. diff --git a/packages/open-payments/src/openapi/generated/resource-server-types.ts b/packages/open-payments/src/openapi/generated/resource-server-types.ts index d1c95758..86ab9956 100644 --- a/packages/open-payments/src/openapi/generated/resource-server-types.ts +++ b/packages/open-payments/src/openapi/generated/resource-server-types.ts @@ -60,6 +60,10 @@ export interface paths { /** Sub-resource identifier */ id: components["parameters"]["id"]; }; + query: { + /** URL of a wallet address hosted by a Rafiki instance. */ + "wallet-address"?: components["parameters"]["wallet-address"]; + }; }; }; "/incoming-payments/{id}/complete": { @@ -84,6 +88,10 @@ export interface paths { /** Sub-resource identifier */ id: components["parameters"]["id"]; }; + query: { + /** URL of a wallet address hosted by a Rafiki instance. */ + "wallet-address"?: components["parameters"]["wallet-address"]; + }; }; }; "/quotes/{id}": { @@ -302,6 +310,8 @@ export interface components { last: number; /** @description Sub-resource identifier */ id: string; + /** @description URL of a wallet address hosted by a Rafiki instance. */ + "wallet-address": string; /** @description The signature generated based on the Signature-Input, using the signing algorithm specified in the "alg" field of the JWK. */ signature: components["parameters"]["optional-signature"]; /** @description The Signature-Input field is a Dictionary structured field containing the metadata for one or more message signatures generated from components within the HTTP message. Each member describes a single message signature. The member's key is the label that uniquely identifies the message signature within the context of the HTTP message. The member's value is the serialization of the covered components Inner List plus all signature metadata parameters identified by the label. The following components MUST be included: - "@method" - "@target-uri" - "authorization". When the message contains a request body, the covered components MUST also include the following: - "content-digest" The keyid parameter of the signature MUST be set to the kid value of the JWK. See [ietf-httpbis-message-signatures](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-message-signatures#section-4.1) for more details. */ @@ -350,6 +360,8 @@ export interface operations { "list-incoming-payments": { parameters: { query: { + /** URL of a wallet address hosted by a Rafiki instance. */ + "wallet-address"?: components["parameters"]["wallet-address"]; /** The cursor key to list from. */ cursor?: components["parameters"]["cursor"]; /** The number of items to return after the cursor. */ @@ -413,6 +425,8 @@ export interface operations { requestBody: { content: { "application/json": { + /** @description The URL of the wallet address that should receive the incoming payment. */ + walletAddress?: string; /** @description The maximum amount that should be paid into the wallet address under this incoming payment. */ incomingAmount?: external["schemas.yaml"]["components"]["schemas"]["amount"]; /** @@ -430,6 +444,8 @@ export interface operations { "list-outgoing-payments": { parameters: { query: { + /** URL of a wallet address hosted by a Rafiki instance. */ + "wallet-address"?: components["parameters"]["wallet-address"]; /** The cursor key to list from. */ cursor?: components["parameters"]["cursor"]; /** The number of items to return after the cursor. */ @@ -490,6 +506,8 @@ export interface operations { requestBody: { content: { "application/json": { + /** @description The URL of the wallet address that should receive the outgoing payment. */ + walletAddress?: string; /** * Format: uri * @description The URL of the quote defining this payment's amounts. @@ -557,6 +575,10 @@ export interface operations { /** Sub-resource identifier */ id: components["parameters"]["id"]; }; + query: { + /** URL of a wallet address hosted by a Rafiki instance. */ + "wallet-address"?: components["parameters"]["wallet-address"]; + }; header: { /** The Signature-Input field is a Dictionary structured field containing the metadata for one or more message signatures generated from components within the HTTP message. Each member describes a single message signature. The member's key is the label that uniquely identifies the message signature within the context of the HTTP message. The member's value is the serialization of the covered components Inner List plus all signature metadata parameters identified by the label. The following components MUST be included: - "@method" - "@target-uri" - "authorization". When the message contains a request body, the covered components MUST also include the following: - "content-digest" The keyid parameter of the signature MUST be set to the kid value of the JWK. See [ietf-httpbis-message-signatures](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-message-signatures#section-4.1) for more details. */ "Signature-Input"?: components["parameters"]["optional-signature-input"]; @@ -610,6 +632,14 @@ export interface operations { /** Incoming Payment Not Found */ 404: unknown; }; + requestBody: { + content: { + "application/json": { + /** @description The URL of the wallet address that should receive the incoming payment. */ + walletAddress?: string; + }; + }; + }; }; /** A client can fetch the latest state of an outgoing payment. */ "get-outgoing-payment": { @@ -618,6 +648,10 @@ export interface operations { /** Sub-resource identifier */ id: components["parameters"]["id"]; }; + query: { + /** URL of a wallet address hosted by a Rafiki instance. */ + "wallet-address"?: components["parameters"]["wallet-address"]; + }; header: { /** The Signature-Input field is a Dictionary structured field containing the metadata for one or more message signatures generated from components within the HTTP message. Each member describes a single message signature. The member's key is the label that uniquely identifies the message signature within the context of the HTTP message. The member's value is the serialization of the covered components Inner List plus all signature metadata parameters identified by the label. The following components MUST be included: - "@method" - "@target-uri" - "authorization". When the message contains a request body, the covered components MUST also include the following: - "content-digest" The keyid parameter of the signature MUST be set to the kid value of the JWK. See [ietf-httpbis-message-signatures](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-message-signatures#section-4.1) for more details. */ "Signature-Input": components["parameters"]["signature-input"];