HTTP Methods Examples Provided 20231026

[leanneeliatra]

Description

A customer submitted a query in relation to this page of the documentation:
https://opensearch.org/docs/latest/api-reference/document-apis/index-document

Customer query: please give a full detailed document with method type. what use put method? like this if describe that can easy to use a developer this apies.-x

Answer to customers query:
In the documentation there is a list of HTTP method examples. The examples are not explained and they cannot be directly inputted to test them.

Fix: Add clarification to the documentation. Describe in more detail what the HTTP methods are used for. Give actual examples the user can follow along with in a more stepwise manner, give examples the user can copy paste into the dev tools and run them.

Issues Resolved
This ticket addresses one part of #4314

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.

[leanneeliatra]

@hdhalter @scrawfor99 @Naarcha-AWS, this PR is ready for a review please. Thank you.

[hdhalter]

I'm not sure this addresses the feedback, but I do know that we lost the description. We also need to make sure to follow the API template.

[leanneeliatra]

Hi all, I have addressed all the comments now for this PR.
To summarise, these are the recent comments and the updated status:

1. We lost the description of the index, add back in the first 2 sections. cc @hdhalter
   This is amended., see the updated page
2. We should make sure we follow the API template as per this page cc @hdhalter
   I'm not sure how I am currently deviating. Are the current changes okay, or can you inform me of what it is I am missing please, as I’m not certain from reviewing the page, thank you.
3. We had repeated a section of code here, @scrawfor99 & @Naarcha-AWS picked up on this, thanks
   this is amended.
4. I have capitalised the word Permissions in Index Permissions amended cc @scrawfor99
5. The hypen in document-level and field-level can stay, in keeping with the rest of the page. cc @scrawfor99

[leanneeliatra]

One small comment then we'll pass it to editorial.

That's great @Naarcha-AWS thanks, I have made that small change and addressed all other comments now.
To check also, should we leave in the section ## Adding a sample index and documents to use the HTTP methods or do you think it's a bit too much information?
Thanks

[leanneeliatra]

Final changes from sync call & confirmations from @Naarcha-AWS

1. Change Hamburger to actions menu.
2. curl based commands through terminal
3. Comment should we leave in the section ## Adding a sample index and documents to use the HTTP methods this section is okay to leave in from Nates review.

Points addressed and edits made in the code

[natebower]

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

[natebower]

DSL should be defined on first appearance.

[leanneeliatra]

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

Thank you @natebower, I have addressed the editorial review comments and alos the comments from @Naarcha-AWS from our call.

Thank you both.

[natebower]

@leanneeliatra @Naarcha-AWS A few corrections, please. Thanks!

[leanneeliatra]

@leanneeliatra @Naarcha-AWS A few corrections, please. Thanks!

Brilliant @natebower thank you, those have been addressed.