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 -> main] updated trace_api openapi documentation [docs] #240

Merged
merged 6 commits into from
Sep 27, 2022
Merged

[3.1 -> main] updated trace_api openapi documentation [docs] #240

merged 6 commits into from
Sep 27, 2022

Conversation

ericpassmore
Copy link
Contributor

@ericpassmore ericpassmore commented Sep 27, 2022 •
edited by lparisc
Loading

sibling of #224

  • added trace_transaction 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 docs for openapi /v1/trace_api
6393c07 
- updated description with notes on options needed at startup
- updated json returns for 400,404, and 500
- added get_transaction_trace method
@ericpassmore
updated trace_api openapi docs
8827ce3 
- updated return schema for get_block
- updated description for get_transaction_trace
@ericpassmore
updated schema for trace_api openapi
fa87b15 
- Added new component schemas
   - ERROR_DETAILS
   - TRACE
   - TRANSACTION_HEADER
   - TRANSACTION_TRACE
   - BLOCK_TRACE
- updated 4xx errors with shared ERROR_DETAILS component
- verification and updates for schema returned for get_block
- verifcation and updates for schema returned for get_transaction
@ericpassmore
Saying in sync. Merge 'origin/main' into docs-openapi-trace_api
5c76188
@ericpassmore
trace_api docs show all schemas returned
dfbc9cd 
- 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/main' into docs-openapi-trace_api
dd3e6e0
@ericpassmore ericpassmore added the documentation Improvements or additions to documentation label Sep 27, 2022
@ericpassmore ericpassmore self-assigned this Sep 27, 2022
@lparisc lparisc changed the title [main] updated trace_api openapi documentation [3.1 -> main] updated trace_api openapi documentation Sep 27, 2022
@spoonincode
Copy link
Member

How are you creating these 3.1->main merges? I would have expected to see the 3.1 merge commit e0da467 as part of this history.

@ericpassmore ericpassmore merged commit de8e625 into main Sep 27, 2022
@ericpassmore ericpassmore deleted the docs-openapi-trace_api branch September 27, 2022 19:06
@ericpassmore
Copy link
Contributor Author

How are you creating these 3.1->main merges? I would have expected to see the 3.1 merge commit e0da467 as part of this history.

I am better informed now, @spoonincode are you ok if I revert, and resubmit the PR?

@ericpassmore ericpassmore mentioned this pull request Sep 27, 2022
Merged
@lparisc lparisc changed the title [3.1 -> main] updated trace_api openapi documentation [3.1 -> main] 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

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.
3 participants
@ericpassmore @spoonincode @lparisc