opensearch-project/OpenSearch

Generate RESTful APIs from spec

Open

#3,090 opened on Apr 27, 2022

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Java (1,505 forks)batch import
Build Libraries & InterfacesClientsenhancementfeaturehelp wanted

Repository metrics

Stars
 (8,123 stars)
PR merge metrics
 (Avg merge 5d 9h) (266 merged PRs in 30d)

Description

Is your feature request related to a problem? Please describe.

Coming from https://github.com/opensearch-project/opensearch-api-specification/issues/30, RESTful APIs are hand-rolled, making it difficult to inspect the available routes, required or optional parameters.

Describe the solution you'd like Use https://github.com/opensearch-project/opensearch-api-specification to generate code in OpenSearch.

History In this issue we discussed an approach that either starts with code that can be inspected/reflected, or starts with a spec, but not both. We proposed using https://github.com/opensearch-project/opensearch-api-specification to generate code in OpenSearch, vs. usng OpenSearch to export the spec in https://github.com/opensearch-project/opensearch-api-specification.

Contributor guide

Research direction
Investigate the OpenSearch API specification repository and design a code generation pipeline that produces RESTful API code from the spec. Understand the current hand rolled API structure and map spec elements to Java classes.
Tech stack
java
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaUnderstanding of OpenSearch internalsCode generation concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30