From c884630a54bd47b611a85aa2fd6e5389210ff83c Mon Sep 17 00:00:00 2001 From: Melissa Henderson <57110301+melissahenderson@users.noreply.github.com> Date: Thu, 7 Nov 2024 08:24:54 -0500 Subject: [PATCH] docs: update based on feedback --- .../backend/src/openapi/specs/webhooks.yaml | 4 ++-- .../requirements/wallet-addresses.mdx | 21 ++----------------- .../requirements/webhook-events.mdx | 2 +- 3 files changed, 5 insertions(+), 22 deletions(-) diff --git a/packages/backend/src/openapi/specs/webhooks.yaml b/packages/backend/src/openapi/specs/webhooks.yaml index b533fb4e19..22c2a60212 100644 --- a/packages/backend/src/openapi/specs/webhooks.yaml +++ b/packages/backend/src/openapi/specs/webhooks.yaml @@ -11,7 +11,7 @@ webhooks: incomingPaymentCreated: post: requestBody: - description: Notifies the account servicing entity that an incoming payment was created. This event is purely informational. + description: Notifies the account servicing entity that an incoming payment was created. content: application/json: schema: @@ -361,7 +361,7 @@ components: description: 'An unsigned 64-bit integer amount, represented as a string.' assetCode: type: string - description: A code that indicates the underlying asset. This SHOULD be an ISO4217 currency code. + description: A code, generally an ISO 4217 currency code where available, representing the underlying asset assetScale: type: integer minimum: 0 diff --git a/packages/documentation/src/content/docs/integration/requirements/wallet-addresses.mdx b/packages/documentation/src/content/docs/integration/requirements/wallet-addresses.mdx index a264241625..50cb5247ce 100644 --- a/packages/documentation/src/content/docs/integration/requirements/wallet-addresses.mdx +++ b/packages/documentation/src/content/docs/integration/requirements/wallet-addresses.mdx @@ -241,20 +241,10 @@ Use the `revokeWalletAddressKey` GraphQL mutation to revoke a public key associa ```graphql mutation RevokeWalletAddressKey($input: RevokeWalletAddressKeyInput!) { revokeWalletAddressKey(input: $input) { - code - message - success walletAddressKey { id - walletAddressId revoked - jwk { - alg - crv - kid - kty - x - } + walletAddressId createdAt } } @@ -270,14 +260,7 @@ mutation RevokeWalletAddressKey($input: RevokeWalletAddressKeyInput!) { ```json { "input": { - "jwk": { - "kid": "keyid-97a3a431-8ee1-48fc-ac85-70e2f5eba8e5", - "x": "ubqoInifJ5sssIPPnQR1gVPfmoZnJtPhTkyMXNoJF_8", - "alg": "EdDSA", - "kty": "OKP", - "crv": "Ed25519" - }, - "walletAddressId": "695e7546-1803-4b45-96b6-6a53f4082018" + "id": "e7532552-cff9-4ffe-883e-56613d3ae611" } } ``` diff --git a/packages/documentation/src/content/docs/integration/requirements/webhook-events.mdx b/packages/documentation/src/content/docs/integration/requirements/webhook-events.mdx index 6140fc887e..b9e6328114 100644 --- a/packages/documentation/src/content/docs/integration/requirements/webhook-events.mdx +++ b/packages/documentation/src/content/docs/integration/requirements/webhook-events.mdx @@ -190,7 +190,7 @@ The first retry is after 10 seconds. Additional retries occur after 20 more seco -The `incoming_payment.created` event indicates an incoming payment was created. This event is purely informational because, at this point, the incoming payment has not received any funds and no actions around liquidity are required. You can use this event to display upcoming incoming payments to your users. +The `incoming_payment.created` event indicates an incoming payment was created. At this point, the incoming payment has not received any funds. The incoming payment will either complete or expire.