CAT API automation (Part II) #9060
Conversation
Signed-off-by: Archer <[email protected]>
Signed-off-by: Archer <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Archer <[email protected]>
Signed-off-by: Archer <[email protected]>
Signed-off-by: Archer <[email protected]>
Signed-off-by: Archer <[email protected]>
Signed-off-by: Archer <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Archer <[email protected]>
Signed-off-by: Archer <[email protected]>
|
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. |
Naarcha-AWS
requested review from
kolchfa-aws,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
|
|
||
| The following table lists the available query parameters. All query parameters are optional. | ||
|
|
||
| Parameter | Data type | Description | Default |
There was a problem hiding this comment.
The "Default" column is not populated for some rows so the table is not displayed correctly (in all these files).
Also, since the table is automatically generated, could we have consistency in pipe symbols: either no pipe symbols on either end of the row, or pipe symbols on both ends of the row (the latter is more extensible).
There was a problem hiding this comment.
It makes sense to add |'s at the end and the beginning to me. @nhtruong, would that be difficult to change in the workflow?
The pretty setting will add pipes but also add additional spacing. One solution is we could enable that by default, since the tables aren't going to be touched directly anyways.
There was a problem hiding this comment.
I would just add pipe symbols regardless of pretty. Also, there should be no empty cells in the table. Where there is no default, we should add N/A. However, it's strange that there was no default automatically provided for expand_wildcards. Is it missing from the spec?
There was a problem hiding this comment.
It's not difficult. Are you saying with pretty: false (the default), the pipes are never present and with pretty: true they are there? OR are you saying that with pretty: false the pipes are there sometimes (this inconsistency would be a bug)
There was a problem hiding this comment.
Regarding Default values not showing: Are they on the spec but not in the generated tables?
There was a problem hiding this comment.
I would go with adding pipes at the ends in any case (for pretty either true or false). This way, all tables are consistent (have pipes at either end at all times).
There was a problem hiding this comment.
Right now, according to the expected output, pretty: true does include pipes at the end and the beginning.
This PR also fixes the previous automation markers with the latest changes to
spec-inserttool..Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.