Fix JSON schema output for custom contracts #1427
Merged
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: Nicko Guyer <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1427 +/- ##
=======================================
Coverage 99.99% 99.99%
=======================================
Files 321 321
Lines 23068 23088 +20
=======================================
+ Hits 23066 23086 +20
Misses 1 1
Partials 1 1 ☔ View full report in Codecov by Sentry. |
awrichar
reviewed
Nov 27, 2023
internal/apiserver/ffi2swagger.go
Outdated
| }, | ||
| // // TODO change to operation schema |
There was a problem hiding this comment.
Not sure I understand what's left for this TODO?
There was a problem hiding this comment.
I think I did it and forgot to remove the comment :) I will remove it
awrichar
reviewed
Nov 27, 2023
internal/apiserver/ffi2swagger.go
Outdated
| @@ -193,6 +192,40 @@ func contractJSONSchema(ctx context.Context, params *fftypes.FFIParams, hasLocat | |||
| return openapi3.NewSchemaRef("", s), nil | |||
| } | |||
|
|
|||
| /** | |||
| * Parse the FFI and build a corresponding JSON Schema to describe the response body for "invoke" or "query". | |||
There was a problem hiding this comment.
I think this response body is only for query outputs
There was a problem hiding this comment.
Yep. Good catch. Misleading comments are the worst kind of comments.
awrichar
approved these changes
Nov 27, 2023
Signed-off-by: Nicko Guyer <[email protected]>
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.
Previously we were generating an incorrect JSON Schema for the response body on custom contract endpoints. This PR fixes this so that:
/inovkeendpoints always return the correct schema for a FireFly Operation (which is the actual payload they return)/queryendpoints now return the correct schema based on the return value of the smart contract itselfoutput,output1,output2, etc. like ETH/EVMConnect name them