opensearch-project / documentation-website

The documentation for OpenSearch, OpenSearch Dashboards, and their associated plugins.
https://opensearch.org/docs
Apache License 2.0
67 stars 466 forks source link

[DOC] Clarify that Snapshot Info (Snashot/Restore APIs) may not return `state` property #6027

Open reta opened 8 months ago

reta commented 8 months ago

What do you want to do?

Tell us about your request. Provide a summary of the request and all versions that are affected.

The Snapshot APIs may not return state property if snapshot state is unknown or cannot be determined, the example below is taken from one of the production systems:

{
    data_streams: [], 
    include_global_state: True, 
    indices: ["<redacted>"], 
    snapshot: "<redacted>", 
    start_time: '2023-12-06T04:17:10.958Z', 
    start_time_in_millis: 1701836230958
}

The server side and client side models clearly indicate that but sadly not the documentation, that causes confusion. Relevant part of the documentation: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore/#take-snapshots

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

willyborankin commented 8 months ago

@reta it looks like a bug to me. Not missing information in docs.

reta commented 8 months ago

@reta it looks like a bug to me. Not missing information in docs.

@willyborankin Why is that? The API responses for server have it as optional field.

hdhalter commented 8 months ago

@prudhvigodithi - Do you know who might be able to comment on this?