docs: fixes 3084 #3088
Open
docs: fixes 3084 #3088
+132
−278
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
pkg: backend
✅ Deploy Preview for brilliant-pasca-3e80ec ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Continue Grant POST is for the Open Payments Auth API, so shouldn't be in the IdP spec |
mkurapov
reviewed
Nov 6, 2024
Comment on lines
+271
to
+282
| { | ||
| "input": { | ||
| "jwk": { | ||
| "kid": "keyid-97a3a431-8ee1-48fc-ac85-70e2f5eba8e5", | ||
| "x": "ubqoInifJ5sssIPPnQR1gVPfmoZnJtPhTkyMXNoJF_8", | ||
| "alg": "EdDSA", | ||
| "kty": "OKP", | ||
| "crv": "Ed25519" | ||
| }, | ||
| "walletAddressId": "695e7546-1803-4b45-96b6-6a53f4082018" | ||
| } | ||
| } |
There was a problem hiding this comment.
Suggested change
| { | |
| "input": { | |
| "jwk": { | |
| "kid": "keyid-97a3a431-8ee1-48fc-ac85-70e2f5eba8e5", | |
| "x": "ubqoInifJ5sssIPPnQR1gVPfmoZnJtPhTkyMXNoJF_8", | |
| "alg": "EdDSA", | |
| "kty": "OKP", | |
| "crv": "Ed25519" | |
| }, | |
| "walletAddressId": "695e7546-1803-4b45-96b6-6a53f4082018" | |
| } | |
| } | |
| { | |
| "input": { | |
| "id": "e7532552-cff9-4ffe-883e-56613d3ae611" | |
| } | |
| } |
Comment on lines
+242
to
+261
| mutation RevokeWalletAddressKey($input: RevokeWalletAddressKeyInput!) { | ||
| revokeWalletAddressKey(input: $input) { | ||
| code | ||
| message | ||
| success | ||
| walletAddressKey { | ||
| id | ||
| walletAddressId | ||
| revoked | ||
| jwk { | ||
| alg | ||
| crv | ||
| kid | ||
| kty | ||
| x | ||
| } | ||
| createdAt | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Suggested change
| mutation RevokeWalletAddressKey($input: RevokeWalletAddressKeyInput!) { | |
| revokeWalletAddressKey(input: $input) { | |
| code | |
| message | |
| success | |
| walletAddressKey { | |
| id | |
| walletAddressId | |
| revoked | |
| jwk { | |
| alg | |
| crv | |
| kid | |
| kty | |
| x | |
| } | |
| createdAt | |
| } | |
| } | |
| } | |
| mutation RevokeWalletAddressKey ($input: RevokeWalletAddressKeyInput!) { | |
| revokeWalletAddressKey (input: $input) { | |
| walletAddressKey { | |
| id | |
| revoked | |
| walletAddressId | |
| createdAt | |
| } | |
| } | |
| } |
| @@ -11,113 +11,113 @@ webhooks: | |||
| incomingPaymentCreated: | |||
| post: | |||
| requestBody: | |||
| description: Notify account servicing entity that an incoming payment was created. | |||
| description: Notifies the account servicing entity that an incoming payment was created. This event is purely informational. | |||
There was a problem hiding this comment.
Suggested change
| 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. |
we can actually optionally action incoming payments now via approveIncomingPayment and cancelIncomingPayment, so we can leave out the informational bit
| assetCode: | ||
| type: string | ||
| description: The assetCode is a code that indicates the underlying asset. This SHOULD be an ISO4217 currency code. | ||
| description: A code that indicates the underlying asset. This SHOULD be an ISO4217 currency code. |
There was a problem hiding this comment.
Maybe we can mention that it should be an ISO4217 if possible. Kind of like we have in the docs page for assets:
"The asset code, generally an ISO 4217 currency code where available."
| @@ -194,11 +193,11 @@ Open Payments <LinkOut href="https://openpayments.dev/apis/wallet-address-server | |||
|
|
|||
| <div class="overflow-table"> | |||
|
|
|||
| | Parameter | Required value | Description | | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR covers doc issues that were discussed during a meeting with Max on Nov. 05, 2024.
@mkurapov Tagging you because of the YAML updates. Also, the OpenAPI spec for IdP is missing
Continue Grant POST /interact/{id}/{nonce}. Is that intentional or should I create an issue for it?