github / github/elastomer-client

Test API coverage against the spec

Open
#91 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Ruby
Stars
197
Forks
28
PR merge metrics
No merged PRs in 30d

Description

ES has a well defined API spec here: https://github.com/elasticsearch/elasticsearch/tree/master/rest-api-spec/api

We should test our API coverage against specific versions. On that note, we should probably explicitly note which versions we support (where support means we strive for 100% coverage) and which we don't (coverage might be incomplete). We could even add methods in the client for determining whether the connected version of ES is officially supported.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Elasticsearch API specification at rest-api-spec/api and comparing it with the elastomer-client API surface. Determine how version-specific coverage should be measured and which Elasticsearch versions are officially supported. Done means the agreed coverage checks, support policy, and connected-version behavior are defined and implemented.

Written by the indexing model from the issue text.

Assessment

Tech stack
elasticsearch, ruby
Domain
api, backend-api-design, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.