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.

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

Add Resolve API #7603

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add Resolve API #7603

wants to merge 6 commits into from

Conversation

Naarcha-AWS
Copy link
Collaborator

@Naarcha-AWS Naarcha-AWS commented Jul 2, 2024

Closes #2114

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]>
@Naarcha-AWS
Copy link
Collaborator Author

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

@Naarcha-AWS
Copy link
Collaborator Author

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.

Looks good! Just a few suggestions.


## Path and HTTP methods

The Resolve Index API supports the following API method:
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need this line? We don't have an intro sentence in the template.

## Permissions

When OpenSearch Security is enabled, you must have the `view_index_metadata` or `manage` index permissions for the target data stream, index, or index alias. <!-----FOLLOW UP, Is there a distinction between index permissions and index privileges?>

Copy link
Contributor

Choose a reason for hiding this comment

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

Should we link to the permissions page?

_api-reference/index-apis/resolve.md Outdated Show resolved Hide resolved
_api-reference/index-apis/resolve.md Outdated Show resolved Hide resolved
_api-reference/index-apis/resolve.md Outdated Show resolved Hide resolved
_api-reference/index-apis/resolve.md Outdated Show resolved Hide resolved
_api-reference/index-apis/resolve.md Outdated Show resolved Hide resolved
_api-reference/index-apis/resolve.md Outdated Show resolved Hide resolved
_api-reference/index-apis/resolve.md Show resolved Hide resolved
Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS dismissed hdhalter’s stale review August 13, 2024 15:51

Review changes implemented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Tech review PR: Tech review in progress API backport 1.3 PR: Backport label for v1.3.x backport 2.15 Content gap
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC]Create documentation for _resolve API
3 participants