Skip to content

Commit

Permalink
docs: update based on feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
melissahenderson committed Nov 7, 2024
1 parent a3fca70 commit c884630
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 22 deletions.
4 changes: 2 additions & 2 deletions packages/backend/src/openapi/specs/webhooks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
}
Expand All @@ -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"
}
}
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ The first retry is after 10 seconds. Additional retries occur after 20 more seco

</Disclosure>

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.

Expand Down

0 comments on commit c884630

Please sign in to comment.