[Spec-Insert] Request and Response Body Tables [Beta] + Utilization Coverage #9385
Conversation
nhtruong
requested review from
AMoo-Miki,
Naarcha-AWS,
dlvenable,
epugh,
kolchfa-aws and
natebower
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
nhtruong
changed the title
spec-insert/lib/coverage/templates/utilization_coverage.mustache
Outdated
Show resolved
Hide resolved
|
@Naarcha-AWS seems like that last commit failed the DCO check. |
|
@nhtruong: Should be fixed now. |
Signed-off-by: Theo Truong <[email protected]>
Signed-off-by: Theo Truong <[email protected]>
spec-insert/spec/_fixtures/expected_output/body_params_tables.md
Outdated
Show resolved
Hide resolved
|
|
||
| The index settings to be updated. | ||
|
|
||
| The request body is __required__. It is a JSON object with the following fields. |
There was a problem hiding this comment.
Are request bodies always JSON objects? If not, do we need to call this out or can we switch it to what's in the template:
"The following table lists the available request body fields. The request body is required".
There was a problem hiding this comment.
It's a JSON object 90% of the time but an NDJSON (array of Jsons) the other time.
There was a problem hiding this comment.
Maybe we can change the description to this then:
"The request body is a JSON object and is required. The following table lists the available request body fields."
Thoughts?
Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Theo N. Truong <[email protected]>
…overage (opensearch-project#9385) * [Spec-Insert] Phase 2: Request and Response Body Tables Signed-off-by: Theo Truong <[email protected]> * # Rubocop'ed Signed-off-by: Theo Truong <[email protected]> * Update spec-insert/spec/_fixtures/expected_output/body_params_tables.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Theo N. Truong <[email protected]> * Update spec-insert/lib/renderers/body_parameters.rb Signed-off-by: Naarcha-AWS <[email protected]> * Update body_params_tables.md * Update body_params_tables.md * Fix one more request body missed in expected output --------- Signed-off-by: Theo Truong <[email protected]> Signed-off-by: Theo N. Truong <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Eric Pugh <[email protected]>
3 participants
This PR also includes refactoring of older components
Request and Response Body Tables [Beta Version]
Note that this is just a preview version to collect feedback on the language and layout of these components. There are also edge-cases yet to be handled (So, not all APIs will be rendered correctly for these new components). There will be follow-up PRs to address the feedback and the edge-cases.
Initial render:
After expanding a collapsible panel:
Utilization Coverage Report
I've also added a tool to generate a utilization report (in markdown) for spec-insert components. This will help us see which components of which APIs still need to be replaced by those generated from the spec. Check the new DEVELOPER_GUIDE.md on how to generate this report.
Initial render:
After expanding a component and a namespace:
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.