Skip to content

[JAY-724] Add cluster health interface#66

Open
sergio-bobillier wants to merge 3 commits intomasterfrom
sb-JAY-724-add-cluster-health-interface
Open

[JAY-724] Add cluster health interface#66
sergio-bobillier wants to merge 3 commits intomasterfrom
sb-JAY-724-add-cluster-health-interface

Conversation

@sergio-bobillier
Copy link
Copy Markdown
Collaborator

Summary

This PR introduces cluster-level Elasticsearch access in jay_api by adding a new JayAPI::Elasticsearch::Cluster class and exposing it through JayAPI::Elasticsearch::Client#cluster.

What’s included

  • Added JayAPI::Elasticsearch::Cluster:
    • Wraps Elasticsearch cluster APIs.
    • Currently exposes #health, delegating to the transport client’s cluster client.
  • Updated JayAPI::Elasticsearch::Client:
    • Added #cluster method.
    • Returns a memoized JayAPI::Elasticsearch::Cluster instance initialized with the existing transport client.
  • Added test coverage:
    • Unit specs for Cluster#health delegation and return behavior.
    • Integration specs for Client#cluster initialization and return value.
  • Updated documentation:
    • Added user guideline page describing how to access and use the Cluster API.
  • Updated changelog:
    • Added unreleased entries for the new Cluster class and Client#cluster.

Why

This provides a clear and extensible entry point for cluster-related Elasticsearch endpoints while keeping the client API consistent and easy to discover.

Backward compatibility

No breaking changes. This PR is additive only.

GitHub Copilot added 3 commits April 14, 2026 17:09
The class gives the user access to cluster-related information and
statistics.

For the moment the class has a single method: #health, which returns the
health statistics of the cluster.
The method returns an instance of the Elasticsearch::Cluster class,
which provides the caller with an interface to retrieve cluster-related
information and statistics.
Documents the the method and its return type, including the methods
offered by the returned object.
@sergio-bobillier sergio-bobillier self-assigned this Apr 14, 2026
@sergio-bobillier sergio-bobillier marked this pull request as ready for review April 14, 2026 15:34
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.

2 participants