Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[3.1] updated trace_api openapi documentation [docs] #224

Merged
merged 4 commits into from
Sep 27, 2022
Merged

[3.1] updated trace_api openapi documentation [docs] #224

merged 4 commits into from
Sep 27, 2022

Conversation

ericpassmore
Copy link
Contributor

@ericpassmore ericpassmore commented Sep 23, 2022 •
edited
Loading

  • added trace_transcation method
  • updated return schema for both get_block and get_transaction_trace
    • New v2 schema for BLockTrace added to options for returned schema
    • New v2 and v3 schema for TransactionTrace added to options for returned schema
    • New sub-schemas ActionTraceV2 and BlockTRaceV2
  • added new component types
    • ERROR_DETAILS

@ericpassmore
updated trace_api openapi documentation
31e6314 
- added trace_transcation method
- added new component types
   - ERROR_DETAILS
   - TRACE
   - TRANSACTION_HEADER
   - TRANSACTION_TRACE
   - BLOCK_TRACE
- updated return schema for both get_block and get_transaction
@ericpassmore ericpassmore added the documentation Improvements or additions to documentation label Sep 23, 2022
@ericpassmore ericpassmore self-assigned this Sep 23, 2022
@ericpassmore ericpassmore mentioned this pull request Sep 23, 2022
Closed
@heifner heifner changed the title updated trace_api openapi documentation [3.1] updated trace_api openapi documentation Sep 24, 2022
lparisc
lparisc suggested changes Sep 26, 2022
View reviewed changes
plugins/trace_api_plugin/trace_api.swagger.yaml Outdated Show resolved Hide resolved
plugins/trace_api_plugin/trace_api.swagger.yaml Outdated Show resolved Hide resolved
@ericpassmore
trace_api docs show all schemas returned
c0efca0 
- shorted description refered back to developer docs
- allow return types for get_blocks any of BlockTraceV0, BlockTraceV1, BlockTraceV2
   - BlockTraceV2 can return either Transaction Type V1 or Transaction Type V2
- allow return types for get_transaction_trace any of TransactionTraceV0, TransactionTraceV1, TransactionTraceV2
@ericpassmore
Merge remote-tracking branch 'origin/release/3.1' into docs-openapi-t…
ba983db 
…race_api-3.1
@ericpassmore
Copy link
Contributor Author

Updated get_black and get_transaction_trace to support the multiple return schemas. Updated the sub-schemas as needed to support BlockTraceV3 and TransactionTraceV3.
Re-synced from release/3.1 branch to support merge

lparisc
lparisc approved these changes Sep 27, 2022
View reviewed changes
Copy link
Contributor

@lparisc lparisc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice

@ericpassmore ericpassmore merged commit e0da467 into release/3.1 Sep 27, 2022
@ericpassmore ericpassmore deleted the docs-openapi-trace_api-3.1 branch September 27, 2022 16:48
@lparisc lparisc mentioned this pull request Sep 27, 2022
Merged
@ericpassmore ericpassmore mentioned this pull request Sep 27, 2022
Merged
@lparisc lparisc changed the title [3.1] updated trace_api openapi documentation [3.1] updated trace_api openapi documentation [docs] Sep 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lparisc lparisc lparisc approved these changes

@heifner heifner Awaiting requested review from heifner

Assignees

@ericpassmore ericpassmore

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ericpassmore @lparisc