Add Index Template APIs #7635

Naarcha-AWS · 2024-07-05T19:22:53Z

Closes #5394
Closes #2113

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.

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

hdhalter · 2024-07-05T19:44:44Z

Thanks, @Naarcha-AWS! Does this also close #2115?

Naarcha-AWS · 2024-07-05T21:04:57Z

#2115 Looks like an additional API, though fairly short. I'll add it to this PR.

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

Naarcha-AWS · 2024-07-09T14:28:59Z

@gbbafna: Can you take a look at this one?

_api-reference/index-apis/component-template.md

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

_api-reference/index-apis/create-index-template.md

_api-reference/index-apis/component-template.md

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

_api-reference/index-apis/component-template.md

_api-reference/index-apis/delete-index-template.md

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

Naarcha-AWS · 2024-07-25T15:51:52Z

Few minor comments. Also, have we verified that the mention curl requests / jsons are working?

Yes, all of the examples in the doc I tested.

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

_api-reference/index-apis/create-index-template.md

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

hdhalter

Looks good, just a few suggestions. Thanks!

_api-reference/index-apis/component-template.md

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

_api-reference/index-apis/component-template.md

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

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

natebower

@Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!

_api-reference/index-apis/component-template.md

natebower · 2024-07-31T11:58:56Z

_api-reference/index-apis/get-index-template.md

+
+## Example requests
+
+The following example request gets information about an index template using a wildcard express:


Suggested change

The following example request gets information about an index template using a wildcard express:

The following example request gets information about an index template by using a wildcard expression:

natebower · 2024-07-31T12:00:40Z

_api-reference/index-apis/get-index-template.md

+
+## Example requests
+
+The following example request gets information about an index template using a wildcard express:


"by using"? (if the request is using the wildcard expression)

natebower · 2024-07-31T12:01:09Z

_api-reference/index-apis/get-index-template.md

+
+The following example request gets information about an index template using a wildcard express:
+
+```


Suggested change

```

```json

natebower · 2024-07-31T12:01:22Z

_api-reference/index-apis/get-index-template.md

+```
+{% include copy-curl.html %}
+
+The following example gets information about all index templates:


Suggested change

The following example gets information about all index templates:

The following example request gets information about all index templates:

natebower · 2024-07-31T12:01:33Z

_api-reference/index-apis/get-index-template.md

+
+The following example gets information about all index templates:
+
+```


Suggested change

```

```json

_api-reference/index-apis/component-template.md

_api-reference/index-apis/create-index-template.md

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

* Add Index Template APIs Signed-off-by: Archer <[email protected]> * Add Index Template APIs Signed-off-by: Archer <[email protected]> * Add Delete template API Signed-off-by: Archer <[email protected]> * Add delete API Signed-off-by: Archer <[email protected]> * Add component template. Signed-off-by: Archer <[email protected]> * Add missing parameter Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/create-index-template.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/create-index-template.md 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]> * Update _api-reference/index-apis/component-template.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Sarthak Aggarwal <[email protected]> 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]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update component-template.md Signed-off-by: Naarcha-AWS <[email protected]> * Update create-index-template.md Signed-off-by: Naarcha-AWS <[email protected]> * Update delete-index-template.md Signed-off-by: Naarcha-AWS <[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]> * 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]> * 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]> Signed-off-by: Heather Halter <[email protected]> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Sarthak Aggarwal <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit 47d64f8) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Add Index Template APIs Signed-off-by: Archer <[email protected]> * Add Index Template APIs Signed-off-by: Archer <[email protected]> * Add Delete template API Signed-off-by: Archer <[email protected]> * Add delete API Signed-off-by: Archer <[email protected]> * Add component template. Signed-off-by: Archer <[email protected]> * Add missing parameter Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/create-index-template.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _api-reference/index-apis/create-index-template.md 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]> * Update _api-reference/index-apis/component-template.md Signed-off-by: Heather Halter <[email protected]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Sarthak Aggarwal <[email protected]> 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]> * Apply suggestions from code review Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update component-template.md Signed-off-by: Naarcha-AWS <[email protected]> * Update create-index-template.md Signed-off-by: Naarcha-AWS <[email protected]> * Update delete-index-template.md Signed-off-by: Naarcha-AWS <[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]> * 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]> * 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]> Signed-off-by: Heather Halter <[email protected]> Co-authored-by: Heather Halter <[email protected]> Co-authored-by: Sarthak Aggarwal <[email protected]> Co-authored-by: Nathan Bower <[email protected]>

Naarcha-AWS added 2 commits July 5, 2024 12:19

Add Index Template APIs

dea625c

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

Add Index Template APIs

064289c

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

Naarcha-AWS requested review from hdhalter, kolchfa-aws, vagimeli, AMoo-Miki, natebower, dlvenable, stephen-crawford and epugh as code owners July 5, 2024 19:22

Naarcha-AWS self-assigned this Jul 5, 2024

Naarcha-AWS added 3 - Tech review PR: Tech review in progress API labels Jul 5, 2024

Naarcha-AWS changed the title ~~Add Index Template APIS~~ Add Index Template APIs Jul 5, 2024

Naarcha-AWS added 4 commits July 8, 2024 12:26

Add Delete template API

eb08766

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

Add delete API

e8d789e

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

Add component template.

59f656b

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

Add missing parameter

e211391

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

Naarcha-AWS commented Jul 9, 2024

View reviewed changes

_api-reference/index-apis/component-template.md Outdated Show resolved Hide resolved

Apply suggestions from code review

655e5e2

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

Naarcha-AWS commented Jul 9, 2024

View reviewed changes

_api-reference/index-apis/create-index-template.md Outdated Show resolved Hide resolved

Naarcha-AWS commented Jul 9, 2024

View reviewed changes

_api-reference/index-apis/create-index-template.md Outdated Show resolved Hide resolved

Naarcha-AWS commented Jul 9, 2024

View reviewed changes

_api-reference/index-apis/component-template.md Outdated Show resolved Hide resolved

Naarcha-AWS commented Jul 9, 2024

View reviewed changes

_api-reference/index-apis/component-template.md Outdated Show resolved Hide resolved

Apply suggestions from code review

4204c9c

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

Naarcha-AWS added the backport 2.15 label Jul 15, 2024

Naarcha-AWS commented Jul 15, 2024

View reviewed changes

_api-reference/index-apis/component-template.md Outdated Show resolved Hide resolved

Naarcha-AWS commented Jul 24, 2024

View reviewed changes

_api-reference/index-apis/delete-index-template.md Outdated Show resolved Hide resolved

Apply suggestions from code review

9678e1a

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

Naarcha-AWS added 3 commits July 29, 2024 12:23

Update component-template.md

5cf26a3

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

Update create-index-template.md

245a203

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

Update delete-index-template.md

4a08a0f

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

Naarcha-AWS added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels Jul 29, 2024

Merge branch 'main' into index-template-api

666c515

Naarcha-AWS commented Jul 29, 2024

View reviewed changes

_api-reference/index-apis/create-index-template.md Outdated Show resolved Hide resolved

Naarcha-AWS commented Jul 29, 2024

View reviewed changes

_api-reference/index-apis/create-index-template.md Outdated Show resolved Hide resolved

Apply suggestions from code review

88b3a7a

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

hdhalter approved these changes Jul 29, 2024

View reviewed changes

Apply suggestions from code review

3259f83

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

Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Jul 30, 2024

Naarcha-AWS commented Jul 30, 2024

View reviewed changes

_api-reference/index-apis/component-template.md Outdated Show resolved Hide resolved

Naarcha-AWS and others added 2 commits July 30, 2024 14:37

Apply suggestions from code review

93d9481

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

Apply suggestions from code review

3c46e86

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

natebower reviewed Jul 31, 2024

View reviewed changes

Naarcha-AWS commented Jul 31, 2024

View reviewed changes

_api-reference/index-apis/component-template.md Outdated Show resolved Hide resolved

Naarcha-AWS commented Jul 31, 2024

View reviewed changes

_api-reference/index-apis/component-template.md Outdated Show resolved Hide resolved

Naarcha-AWS commented Jul 31, 2024

View reviewed changes

_api-reference/index-apis/create-index-template.md Outdated Show resolved Hide resolved

Apply suggestions from code review

db2738b

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

Naarcha-AWS merged commit 47d64f8 into main Jul 31, 2024
6 checks passed

opensearch-trigger-bot bot mentioned this pull request Jul 31, 2024

[Backport 2.15] Add Index Template APIs #7883

Merged

github-actions bot pushed a commit that referenced this pull request Jul 31, 2024

Add Index Template APIs (#7635) (#7883)

7feb8ea

Naarcha-AWS deleted the index-template-api branch January 8, 2025 20:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Index Template APIs #7635

Add Index Template APIs #7635

Naarcha-AWS commented Jul 5, 2024 •

edited by hdhalter

Loading

hdhalter commented Jul 5, 2024

Naarcha-AWS commented Jul 5, 2024

Naarcha-AWS commented Jul 9, 2024

Naarcha-AWS commented Jul 25, 2024

hdhalter left a comment

natebower left a comment

natebower Jul 31, 2024 •

edited by Naarcha-AWS

Loading

natebower Jul 31, 2024

natebower Jul 31, 2024

natebower Jul 31, 2024

natebower Jul 31, 2024


		## Example requests

		The following example request gets information about an index template using a wildcard express:

	The following example gets information about all index templates:
	The following example request gets information about all index templates:

Add Index Template APIs #7635

Add Index Template APIs #7635

Conversation

Naarcha-AWS commented Jul 5, 2024 • edited by hdhalter Loading

Checklist

hdhalter commented Jul 5, 2024

Naarcha-AWS commented Jul 5, 2024

Naarcha-AWS commented Jul 9, 2024

Naarcha-AWS commented Jul 25, 2024

hdhalter left a comment

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

natebower Jul 31, 2024 • edited by Naarcha-AWS Loading

Choose a reason for hiding this comment

natebower Jul 31, 2024

Choose a reason for hiding this comment

natebower Jul 31, 2024

Choose a reason for hiding this comment

natebower Jul 31, 2024

Choose a reason for hiding this comment

natebower Jul 31, 2024

Choose a reason for hiding this comment

Naarcha-AWS commented Jul 5, 2024 •

edited by hdhalter

Loading

natebower Jul 31, 2024 •

edited by Naarcha-AWS

Loading