opensearch-project / opensearch-project/sql

[FEATURE] Fill out `sql` namespace for spec repo

Open
#2,659 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

catch-all acknowledged enhancement maintenance
Dominant language
Java
Stars
176
Forks
229
Avg merge
2d 21h
Merged PRs (30d)
43

Description

The sql namespace on the spec repo is missing a few endpoints. We need these endpoints filled out in the spec so that we generate clients that interact with this plugin properly:

  • Make sure that the existing sql endpoints in the spec, if any, are correct
  • Fill out missing sql endpoints.

The Dev's Guide is a great place to start.

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 with the Dev's Guide and the sql namespace in the OpenSearch API specification issue linked from this report. Compare the existing SQL endpoints with the plugin's available endpoints, then identify the missing operations and any incorrect definitions. Done means the namespace fully and accurately describes the SQL endpoints needed for generated clients.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, sql
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.