Add clarity to request fields in reindex.md #9381
Conversation
I noticed that the tabular format for the request fields made it confusing when reading the documentation. From what it looks like, several fields needed to show that they are inside of the object(s) rather than directly in the request object. This is only one possible solution to the problem, but I could also see it as confusing since things like index settings use dot-separated object keys (though they also seem to support actual objects rather than just the dot-separated key notation for the most part) and I'm not certain if it will accept that same flat-object, dot-separated key notation for these requests, either. Signed-off-by: Samuel Skeen <[email protected]>
cwadrupldijjit
requested review from
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable and
epugh
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. |
|
@cwadrupldijjit: This will likely be addressed once we've merged more API automation based on the Spec. Going to keep this open for now and might loop back around to add the automation markers once we merge in #9385 is merged. |
I noticed that the tabular format for the request fields made it confusing when reading the documentation. From what it looks like, several fields needed to show that they are inside of the object(s) rather than directly in the request object.
This is only one possible solution to the problem, but I could also see it as confusing since things like index settings use dot-separated object keys (though they also seem to support actual objects rather than just the dot-separated key notation for the most part) and I'm not certain if it will accept that same flat-object, dot-separated key notation for these requests, either.
Description
Fixes confusing documentation structure
Issues Resolved
N/A
Version
2.19 (at least)
Frontend features
N/A
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.