Fixes for OpenAPI (RPC) documents and QA docs restructuring#472
Merged
Fixes for OpenAPI (RPC) documents and QA docs restructuring#472
Conversation
thanethomson
reviewed
Mar 6, 2023
thanethomson
approved these changes
Mar 20, 2023
Contributor
thanethomson
left a comment
There was a problem hiding this comment.
Overall LGTM, just a couple of minor things to address before merging.
Co-authored-by: Thane Thomson <connect@thanethomson.com>
Co-authored-by: Thane Thomson <connect@thanethomson.com>
mergify bot
pushed a commit
that referenced
this pull request
Mar 20, 2023
* openapi doc fixes and QA docs fixes * rename title Co-authored-by: Thane Thomson <connect@thanethomson.com> * fix text Co-authored-by: Thane Thomson <connect@thanethomson.com> * add backquotes Co-authored-by: Thane Thomson <connect@thanethomson.com> * update contact --------- Co-authored-by: Thane Thomson <connect@thanethomson.com> (cherry picked from commit 3cd1037) # Conflicts: # rpc/openapi/openapi.yaml
mergify bot
pushed a commit
that referenced
this pull request
Mar 20, 2023
* openapi doc fixes and QA docs fixes * rename title Co-authored-by: Thane Thomson <connect@thanethomson.com> * fix text Co-authored-by: Thane Thomson <connect@thanethomson.com> * add backquotes Co-authored-by: Thane Thomson <connect@thanethomson.com> * update contact --------- Co-authored-by: Thane Thomson <connect@thanethomson.com> (cherry picked from commit 3cd1037) # Conflicts: # docs/qa/CometBFT-QA-37.md # docs/qa/README.md # docs/qa/TMCore-QA-37.md # docs/qa/img37/200nodes_cmt037/all_experiments.png # docs/qa/img37/200nodes_cmt037/avg_mempool_size.png # docs/qa/img37/200nodes_cmt037/block_rate.png # docs/qa/img37/200nodes_cmt037/cpu.png # docs/qa/img37/200nodes_cmt037/e_75cb89a8-f876-4698-82f3-8aaab0b361af.png # docs/qa/img37/200nodes_cmt037/memory.png # docs/qa/img37/200nodes_cmt037/mempool_size.png # docs/qa/img37/200nodes_cmt037/peers.png # docs/qa/img37/200nodes_cmt037/rounds.png # docs/qa/img37/200nodes_cmt037/total_txs_rate.png # docs/qa/img37/200nodes_tm037/avg_mempool_size.png # docs/qa/img37/200nodes_tm037/block_rate_regular.png # docs/qa/img37/200nodes_tm037/cpu.png # docs/qa/img37/200nodes_tm037/memory.png # docs/qa/img37/200nodes_tm037/mempool_size.png # docs/qa/img37/200nodes_tm037/peers.png # docs/qa/img37/200nodes_tm037/rounds.png # docs/qa/img37/200nodes_tm037/total_txs_rate_regular.png # docs/qa/img37/200nodes_tm037/v037_200node_latencies.png # docs/qa/img37/200nodes_tm037/v037_latency_throughput.png # docs/qa/img37/200nodes_tm037/v037_r200c2_heights.png # docs/qa/img37/200nodes_tm037/v037_r200c2_load1.png # docs/qa/img37/200nodes_tm037/v037_r200c2_mempool_size.png # docs/qa/img37/200nodes_tm037/v037_r200c2_mempool_size_avg.png # docs/qa/img37/200nodes_tm037/v037_r200c2_peers.png # docs/qa/img37/200nodes_tm037/v037_r200c2_rounds.png # docs/qa/img37/200nodes_tm037/v037_r200c2_rss.png # docs/qa/img37/200nodes_tm037/v037_r200c2_rss_avg.png # docs/qa/img37/200nodes_tm037/v037_r200c2_total-txs.png # docs/qa/img37/200nodes_tm037/v037_report_tabbed.txt # docs/qa/img37/200nodes_tm037/v037_rotating_heights.png # docs/qa/img37/200nodes_tm037/v037_rotating_heights_ephe.png # docs/qa/img37/200nodes_tm037/v037_rotating_latencies.png # docs/qa/img37/200nodes_tm037/v037_rotating_load1.png # docs/qa/img37/200nodes_tm037/v037_rotating_peers.png # docs/qa/img37/200nodes_tm037/v037_rotating_rss_avg.png # docs/qa/img37/200nodes_tm037/v037_rotating_total-txs.png # rpc/openapi/openapi.yaml
andynog
added a commit
that referenced
this pull request
Mar 21, 2023
…472) (#561) * Fixes for OpenAPI (RPC) documents and QA docs restructuring (#472) * openapi doc fixes and QA docs fixes * rename title Co-authored-by: Thane Thomson <connect@thanethomson.com> * fix text Co-authored-by: Thane Thomson <connect@thanethomson.com> * add backquotes Co-authored-by: Thane Thomson <connect@thanethomson.com> * update contact --------- Co-authored-by: Thane Thomson <connect@thanethomson.com> (cherry picked from commit 3cd1037) # Conflicts: # docs/qa/CometBFT-QA-37.md # docs/qa/README.md # docs/qa/TMCore-QA-37.md # docs/qa/img37/200nodes_cmt037/all_experiments.png # docs/qa/img37/200nodes_cmt037/avg_mempool_size.png # docs/qa/img37/200nodes_cmt037/block_rate.png # docs/qa/img37/200nodes_cmt037/cpu.png # docs/qa/img37/200nodes_cmt037/e_75cb89a8-f876-4698-82f3-8aaab0b361af.png # docs/qa/img37/200nodes_cmt037/memory.png # docs/qa/img37/200nodes_cmt037/mempool_size.png # docs/qa/img37/200nodes_cmt037/peers.png # docs/qa/img37/200nodes_cmt037/rounds.png # docs/qa/img37/200nodes_cmt037/total_txs_rate.png # docs/qa/img37/200nodes_tm037/avg_mempool_size.png # docs/qa/img37/200nodes_tm037/block_rate_regular.png # docs/qa/img37/200nodes_tm037/cpu.png # docs/qa/img37/200nodes_tm037/memory.png # docs/qa/img37/200nodes_tm037/mempool_size.png # docs/qa/img37/200nodes_tm037/peers.png # docs/qa/img37/200nodes_tm037/rounds.png # docs/qa/img37/200nodes_tm037/total_txs_rate_regular.png # docs/qa/img37/200nodes_tm037/v037_200node_latencies.png # docs/qa/img37/200nodes_tm037/v037_latency_throughput.png # docs/qa/img37/200nodes_tm037/v037_r200c2_heights.png # docs/qa/img37/200nodes_tm037/v037_r200c2_load1.png # docs/qa/img37/200nodes_tm037/v037_r200c2_mempool_size.png # docs/qa/img37/200nodes_tm037/v037_r200c2_mempool_size_avg.png # docs/qa/img37/200nodes_tm037/v037_r200c2_peers.png # docs/qa/img37/200nodes_tm037/v037_r200c2_rounds.png # docs/qa/img37/200nodes_tm037/v037_r200c2_rss.png # docs/qa/img37/200nodes_tm037/v037_r200c2_rss_avg.png # docs/qa/img37/200nodes_tm037/v037_r200c2_total-txs.png # docs/qa/img37/200nodes_tm037/v037_report_tabbed.txt # docs/qa/img37/200nodes_tm037/v037_rotating_heights.png # docs/qa/img37/200nodes_tm037/v037_rotating_heights_ephe.png # docs/qa/img37/200nodes_tm037/v037_rotating_latencies.png # docs/qa/img37/200nodes_tm037/v037_rotating_load1.png # docs/qa/img37/200nodes_tm037/v037_rotating_peers.png # docs/qa/img37/200nodes_tm037/v037_rotating_rss_avg.png # docs/qa/img37/200nodes_tm037/v037_rotating_total-txs.png # rpc/openapi/openapi.yaml * mergify conflic fixes for v0.34 (#561) --------- Co-authored-by: Andy Nogueira <me@andynogueira.dev>
andynog
added a commit
that referenced
this pull request
Mar 21, 2023
…472) (#560) * Fixes for OpenAPI (RPC) documents and QA docs restructuring (#472) * openapi doc fixes and QA docs fixes * rename title Co-authored-by: Thane Thomson <connect@thanethomson.com> * fix text Co-authored-by: Thane Thomson <connect@thanethomson.com> * add backquotes Co-authored-by: Thane Thomson <connect@thanethomson.com> * update contact --------- Co-authored-by: Thane Thomson <connect@thanethomson.com> (cherry picked from commit 3cd1037) # Conflicts: # rpc/openapi/openapi.yaml * fixing mergify conflicts (#560) --------- Co-authored-by: Andy Nogueira <me@andynogueira.dev>
roy-dydx
pushed a commit
to dydxprotocol/cometbft
that referenced
this pull request
Jul 11, 2023
…ometbft#472) (cometbft#560) * Fixes for OpenAPI (RPC) documents and QA docs restructuring (cometbft#472) * openapi doc fixes and QA docs fixes * rename title Co-authored-by: Thane Thomson <connect@thanethomson.com> * fix text Co-authored-by: Thane Thomson <connect@thanethomson.com> * add backquotes Co-authored-by: Thane Thomson <connect@thanethomson.com> * update contact --------- Co-authored-by: Thane Thomson <connect@thanethomson.com> (cherry picked from commit 3cd1037) # Conflicts: # rpc/openapi/openapi.yaml * fixing mergify conflicts (cometbft#560) --------- Co-authored-by: Andy Nogueira <me@andynogueira.dev>
3 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 fixes:
Outaded and wrong information on OpenAPI documentation (RPC)
wswebsocket client (not updated anymore) withwebsocat(maintained)/subscribe)Refactor the structure of the QA documents (
/docs/qa) in order to properly display in the navigation (see below):