Document the confirm option on the generated invoke APIs #1521
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
Signed-off-by: Peter Broadhurst <peter.broadhurst@kaleido.io>
EnriqueL8
approved these changes
Jun 10, 2024
| @@ -5069,7 +5069,8 @@ paths: | |||
| description: Invokes a method on a smart contract. Performs a blockchain transaction. | |||
| operationId: postContractInvoke | |||
| parameters: | |||
| - description: When true the HTTP request blocks until the message is confirmed | |||
| - description: When true the HTTP request blocks until the blockchain transaction | |||
| is confirmed | |||
There was a problem hiding this comment.
Not sure why there is an end line here?
There was a problem hiding this comment.
Sorry @EnriqueL8 - I'm being slow. What's the problem with the string?
"When true the HTTP request blocks until the blockchain transaction is confirmed"
There was a problem hiding this comment.
oh, sorry - I see you're asking about the YAML formatting.
That's just a choice of the YAML serializer when the string exceeds a certain length, to use an indented newline to continue the string
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.
/invokeAPIs/contracts/invokeAPI