8000 Fixes for OpenAPI (RPC) documents and QA docs restructuring by andynog · Pull Request #472 · cometbft/cometbft · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fixes for OpenAPI (RPC) documents and QA docs restructuring #472

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
Merged
merged 8 commits into from
Mar 20, 2023
Merged

Fixes for OpenAPI (RPC) documents and QA docs restructuring #472

merged 8 commits into from
Mar 20, 2023

Conversation

andynog
Copy link
Contributor
@andynog andynog commented Mar 6, 2023

This PR fixes:

  • Outaded and wrong information on OpenAPI documentation (RPC)

    • Added information about CORS
    • Replace old ws websocket client (not updated anymore) with websocat (maintained)
    • Replace old rpc endpoint with one from the Cosmos registry
    • Remove all http endpoints information about websockets subscription (e.g. /subscribe)

  • Refactor the structure of the QA documents (/docs/qa) in order to properly display in the navigation (see below):

image

@andynog andynog added bug Something isn't working documentation Improvements or additions to documentation backport-to-v0.34.x Tell Mergify to backport the PR to v0.34.x backport-to-v0.37.x Tell Mergify to backport the PR to v0.37.x labels Mar 6, 2023
@andynog andynog requested a review from a team as a code owner March 6, 2023 16:38
@andynog andynog self-assigned this Mar 6, 2023
thanethomson
thanethomson reviewed Mar 6, 2023
View reviewed changes
@andynog andynog requested review from thanethomson and a team March 17, 2023 15:12
thanethomson
thanethomson approved these changes Mar 20, 2023
View reviewed changes
Copy link
Contributor
@thanethomson thanethomson left a comment

Choose a reason for hiding this comment

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

Overall LGTM, just a couple of minor things to address before merging.

andynog and others added 5 commits March 20, 2023 17:13
@andynog @thanethomson
rename title
74b7562 
Co-authored-by: Thane Thomson <connect@thanethomson.com>
@andynog @thanethomson
fix text
9a0d52a 
Co-authored-by: Thane Thomson <connect@thanethomson.com>
@andynog @thanethomson
add backquotes
a3967b8 
Co-authored-by: Thane Thomson <connect@thanethomson.com>
@andynog
update contact
e3e2801
@andynog
Merge branch 'main' into andy/qa-rpc-docs-fix
e6dbe47
@andynog andynog merged commit 3cd1037 into main Mar 20, 2023
@andynog andynog deleted the andy/qa-rpc-docs-fix branch March 20, 2023 21:32
mergify bot pushed a commit that referenced this pull request Mar 20, 2023
@andynog @mergify
Fixes for OpenAPI (RPC) documents and QA docs restructuring (#472)
6361b5b 
* 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 mergify bot mentioned this pull request Mar 20, 2023
Merged
mergify bot pushed a commit that referenced this pull request Mar 20, 2023
@andynog @mergify
Fixes for OpenAPI (RPC) documents and QA docs restructuring (#472)
d355f49 
* 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 mergify bot mentioned this pull request Mar 20, 2023
Merged
andynog added a commit that referenced this pull request Mar 21, 2023
@mergify @andynog
Fixes for OpenAPI (RPC) documents and QA docs restructuring (backport #…
f2591e2 
…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 thi 8000 s pull request Mar 21, 2023
@mergify @andynog
Fixes for OpenAPI (RPC) documents and QA docs restructuring (backport #…
9a9334b 
…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
@mergify @andynog @roy-dydx
Fixes for OpenAPI (RPC) documents and QA docs restructuring (backport c…
9da35f8 
…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>
@faddat faddat mentioned this pull request Jan 5, 2024
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thanethomson thanethomson thanethomson approved these changes

Assignees

@andynog andynog

Labels
backport-to-v0.34.x Tell Mergify to backport the PR to v0.34.x backport-to-v0.37.x Tell Mergify to backport the PR to v0.37.x bug Something isn't working documentation Improvements or additions to documentation
Projects
No open projects
CometBFT 2023
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@andynog @thanethomson
0