Skip to content
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

Add Render Template API #7219

Merged
merged 6 commits into from
Jul 1, 2024
Merged

Add Render Template API #7219

merged 6 commits into from
Jul 1, 2024

Conversation

Naarcha-AWS
Copy link
Collaborator

Closes #6046

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@Naarcha-AWS Naarcha-AWS added the 3 - Tech review PR: Tech review in progress label May 21, 2024
@Naarcha-AWS Naarcha-AWS self-assigned this May 21, 2024
@Naarcha-AWS Naarcha-AWS added backport 1.3 PR: Backport label for v1.3.x backport 2.14 PR: Backport label for 2.14 labels May 21, 2024
@Naarcha-AWS
Copy link
Collaborator Author

@rursprung: Let me know if you want any additional information that isn't capture in this PR.

@Naarcha-AWS
Add examples
89ec367 
Signed-off-by: Archer <[email protected]>
@Naarcha-AWS
Copy link
Collaborator Author

@msfroh: Mind looking at this one?

@Naarcha-AWS Naarcha-AWS added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels Jun 11, 2024
@Naarcha-AWS
Copy link
Collaborator Author

This PR passed tech review offline.

hdhalter
hdhalter reviewed Jun 12, 2024
View reviewed changes
Copy link
Contributor

@hdhalter hdhalter left a comment

Choose a reason for hiding this comment

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

A couple of nits.
Question: Should we group the search APIs under a "Search API" category?

_api-reference/render-template.md Outdated Show resolved Hide resolved
_api-reference/render-template.md Outdated Show resolved Hide resolved
_api-reference/render-template.md Outdated Show resolved Hide resolved
@Naarcha-AWS @hdhalter
Apply suggestions from code review
0979420 
Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS requested a review from hdhalter June 12, 2024 05:46
@Naarcha-AWS
Copy link
Collaborator Author

A couple of nits. Question: Should we group the search APIs under a "Search API" category?

Yes. However, should we wait until we have a method for canonical links first?

@hdhalter
Copy link
Contributor

A couple of nits. Question: Should we group the search APIs under a "Search API" category?

Yes. However, should we wait until we have a method for canonical links first?

I think this is ok since there is no change to a collection or permalink, but let's check with @kolchfa-aws.

@kolchfa-aws
Copy link
Collaborator

@Naarcha-AWS @hdhalter Go ahead with all the changes (and let me know what they are) until I implement this. It is easier to make all the changes beforehand. Thanks.

rursprung
rursprung reviewed Jun 14, 2024
View reviewed changes
_api-reference/render-template.md Outdated Show resolved Hide resolved
_api-reference/render-template.md Show resolved Hide resolved
_api-reference/render-template.md Show resolved Hide resolved
@Naarcha-AWS
Add example from source.
2db62ed 
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS requested a review from rursprung July 1, 2024 15:34
@Naarcha-AWS Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Jul 1, 2024
natebower
natebower reviewed Jul 1, 2024
View reviewed changes
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@Naarcha-AWS Just a few changes. Thanks!

_api-reference/render-template.md Outdated Show resolved Hide resolved
_api-reference/render-template.md Outdated Show resolved Hide resolved
_api-reference/render-template.md Outdated Show resolved Hide resolved
_api-reference/render-template.md Outdated Show resolved Hide resolved
@Naarcha-AWS @natebower
Apply suggestions from code review
35564c2 
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
natebower
natebower approved these changes Jul 1, 2024
View reviewed changes
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

LGTM

@Naarcha-AWS Naarcha-AWS added backport 2.15 and removed backport 2.14 PR: Backport label for 2.14 labels Jul 1, 2024
@Naarcha-AWS Naarcha-AWS merged commit d30d86e into main Jul 1, 2024
8 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 1, 2024
@github-actions @hdhalter @natebower
Add Render Template API (#7219)
c95ebee 
* Add render/template API

Signed-off-by: Archer <[email protected]>

* Add examples

Signed-off-by: Archer <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Add example from `source`.

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Archer <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit d30d86e)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Jul 1, 2024
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 1, 2024
@github-actions @hdhalter @natebower
Add Render Template API (#7219)
77f7fff 
* Add render/template API

Signed-off-by: Archer <[email protected]>

* Add examples

Signed-off-by: Archer <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Add example from `source`.

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Archer <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit d30d86e)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Jul 1, 2024
Merged
github-actions bot pushed a commit that referenced this pull request Jul 1, 2024
@opensearch-trigger-bot
Add Render Template API (#7219) (#7571)
559d415
github-actions bot pushed a commit that referenced this pull request Jul 1, 2024
@opensearch-trigger-bot
Add Render Template API (#7219) (#7572)
7524d2c
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Jul 24, 2024
@Naarcha-AWS @hdhalter
@natebower @leanneeliatra
Add Render Template API (opensearch-project#7219)
fd3a6ff 
* Add render/template API

Signed-off-by: Archer <[email protected]>

* Add examples

Signed-off-by: Archer <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Add example from `source`.

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Archer <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: [email protected] <[email protected]>
sandervandegeijn pushed a commit to sandervandegeijn/documentation-website that referenced this pull request Jul 30, 2024
@Naarcha-AWS @hdhalter
@natebower @sandervandegeijn
Add Render Template API (opensearch-project#7219)
dbbc4f7 
* Add render/template API

Signed-off-by: Archer <[email protected]>

* Add examples

Signed-off-by: Archer <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Add example from `source`.

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Archer <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Sander van de Geijn <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@natebower natebower natebower approved these changes

@kolchfa-aws kolchfa-aws Awaiting requested review from kolchfa-aws kolchfa-aws is a code owner

@vagimeli vagimeli Awaiting requested review from vagimeli

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@dlvenable dlvenable Awaiting requested review from dlvenable dlvenable is a code owner

@stephen-crawford stephen-crawford Awaiting requested review from stephen-crawford

@epugh epugh Awaiting requested review from epugh epugh is a code owner

@hdhalter hdhalter Awaiting requested review from hdhalter

@rursprung rursprung Awaiting requested review from rursprung

Assignees

@Naarcha-AWS Naarcha-AWS

Labels
5 - Editorial review PR: Editorial review in progress API backport 1.3 PR: Backport label for v1.3.x backport 2.15 Content gap
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] better documentation for /_render/template API
5 participants
@Naarcha-AWS @hdhalter @kolchfa-aws @rursprung @natebower