Skip to content

Conversation

@dev-docs-github-app-dev
Copy link

This PR adds comprehensive API reference documentation for the Remote Store Metadata API, which enables users to fetch metadata about remote store segments and translogs for specific indices and shards.

Key additions include:

  • Detailed endpoint descriptions for /_remotestore/metadata/{index} and /_remotestore/metadata/{index}/{shard_id}
  • Complete parameter documentation for both path and query parameters
  • Clear example requests and responses with detailed JSON structure
  • Comprehensive field descriptions for response body components
  • Information about required permissions and security considerations
  • Usage notes and best practices

This documentation will help users understand and effectively utilize the Remote Store Metadata API for enhanced observability and debugging of indices backed by remote storage.

File added:

  • opensearch/API_REFERENCE.md

@dev-docs-github-app-dev
Copy link
Author

dev-docs-github-app-dev bot commented May 14, 2025

This pull request was created by AI Agent. Please review the changes and provide feedback. Context used:

                        {
  "docsToCreate": [
    {
      "filePath": "opensearch/API_REFERENCE.md",
      "branch": "main"
    }
  ],
  "docsToUpdate": [],
  "relevantCodeFiles": [],
  "relevantCodeRepo": "opensearch-project/OpenSearch",
  "relevantDocsFiles": [
    {
      "filePath": "API_STYLE_GUIDE.md",
      "branch": "main"
    },
    {
      "filePath": "DEVELOPER_GUIDE.md",
      "branch": "main"
    },
    {
      "branch": "main",
      "filePath": "API_STYLE_GUIDE.md"
    },
    {
      "branch": "main",
      "filePath": "CONTRIBUTING.md"
    },
    {
      "branch": "main",
      "filePath": "DEVELOPER_GUIDE.md"
    },
    {
      "branch": "main",
      "filePath": "_aggregations/bucket/index.md"
    }
  ]
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant