[ Jekyll ] [ SpecInsert ] omit_header #8766
Merged
Conversation
This file contains 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
A program that insert API Components generated from the OpenSearch OpenAPI Spec into markdown files Signed-off-by: Theo Truong <theotr@amazon.com>
Signed-off-by: Theo Truong <theotr@amazon.com>
Signed-off-by: Theo Truong <theotr@amazon.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Daniel (dB.) Doubrovkine <dblock@dblock.org> Signed-off-by: Theo N. Truong <theotr@amazon.com>
(Some minor refactoring to DRY the code as well) Signed-off-by: Theo Truong <theotr@amazon.com>
nhtruong
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
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. |
nhtruong
commented
Nov 15, 2024
| @@ -31,7 +32,7 @@ Edit your Markdown file and insert the following snippet where you want render a | |||
| <!-- spec_insert_start | |||
| api: <API_NAME> | |||
| component: <COMPONENT_NAME> | |||
| other_param: <OTHER_PARAM> | |||
| other_argument: <OTHER_ARGUMENT> | |||
There was a problem hiding this comment.
Calling this argument to match what the code is actually using and avoid confusion with the API path and query params.
nhtruong
changed the title
Naarcha-AWS
reviewed
Nov 15, 2024
Naarcha-AWS
reviewed
Nov 15, 2024
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
approved these changes
Nov 15, 2024
epugh
pushed a commit
to o19s/documentation-website
that referenced
this pull request
Nov 23, 2024
* Spec Insert A program that insert API Components generated from the OpenSearch OpenAPI Spec into markdown files Signed-off-by: Theo Truong <theotr@amazon.com> * # vale:reviewdog Signed-off-by: Theo Truong <theotr@amazon.com> * # Correction on cron job run time. Signed-off-by: Theo Truong <theotr@amazon.com> * Apply suggestions from code review Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Daniel (dB.) Doubrovkine <dblock@dblock.org> Signed-off-by: Theo N. Truong <theotr@amazon.com> * Added `omit_header` argument for Spec Insert components (Some minor refactoring to DRY the code as well) Signed-off-by: Theo Truong <theotr@amazon.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Theo Truong <theotr@amazon.com> Signed-off-by: Theo N. Truong <theotr@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Daniel (dB.) Doubrovkine <dblock@dblock.org> Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added omit_header argument for Spec Insert components along with minor refactoring to DRY the code base.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.