opensearch-project / opensearch-project/opensearch-java

[FEATURE] Switch code generation to point to versioned OpenAPI specification

Open
#1,290 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
165
Forks
250
Avg merge
1d 18h
Merged PRs (30d)
26

Description

Is your feature request related to a problem?

Now that opensearch-api-specification publishes a versioned specification we should migrate the code generation to use it rather than a local copy.

As the code-gen and spec is still in high flux, it may be valuable to keep the current approach until the code-gen is stable, i.e. the current incremental stages are complete and we no longer filtering which operations to generate.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing code-generation setup and its local OpenAPI specification, then compare it with the versioned specification published by opensearch-api-specification. Done means generation uses the versioned source after the current incremental stages are complete and operation filtering is no longer required.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
build-system, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.