Adding SQL Settings specs #456

Tokesh · 2024-07-31T17:01:26Z

Description

adding sql settings specs

Issues Resolved

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Tokesh <[email protected]>

github-actions · 2024-07-31T17:03:28Z

Changes Analysis

Commit SHA: 41b888e
Comparing To SHA: b67104c

API Changes

Summary

├─┬Paths
│ ├──[➕] path (11797:3)
│ ├──[➕] path (4074:3)
│ ├─┬/_opendistro/_sql/stats
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └─┬Schema
│ │ │ │   └──[➖] description (21323:22)
│ │ │ └─┬Parameters
│ │ │   └─┬Schema
│ │ │     └──[➖] description (21331:22)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └─┬Schema
│ │   │   └──[➖] description (21346:22)
│ │   └─┬Parameters
│ │     └─┬Schema
│ │       └──[➖] description (21338:22)
│ ├─┬/_plugins/_sql/_explain
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └─┬Schema
│ │   │   └──[➖] description (21308:22)
│ │   └─┬Parameters
│ │     └─┬Schema
│ │       └──[➖] description (21316:22)
│ ├─┬/_opendistro/_sql
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └─┬Schema
│ │   │   └──[➖] description (21361:22)
│ │   └─┬Parameters
│ │     └─┬Schema
│ │       └──[➖] description (21353:22)
│ ├─┬/_plugins/_sql/stats
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └─┬Schema
│ │ │ │   └──[➖] description (21323:22)
│ │ │ └─┬Parameters
│ │ │   └─┬Schema
│ │ │     └──[➖] description (21331:22)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └─┬Schema
│ │   │   └──[➖] description (21338:22)
│ │   └─┬Parameters
│ │     └─┬Schema
│ │       └──[➖] description (21346:22)
│ ├─┬/_plugins/_sql
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └─┬Schema
│ │   │   └──[➖] description (21353:22)
│ │   └─┬Parameters
│ │     └─┬Schema
│ │       └──[➖] description (21361:22)
│ ├─┬/_opendistro/_sql/_explain
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └─┬Schema
│ │   │   └──[➖] description (21316:22)
│ │   └─┬Parameters
│ │     └─┬Schema
│ │       └──[➖] description (21308:22)
│ ├─┬/_opendistro/_sql/close
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └─┬Schema
│ │   │   └──[➖] description (21293:22)
│ │   └─┬Parameters
│ │     └─┬Schema
│ │       └──[➖] description (21301:22)
│ └─┬/_plugins/_sql/close
│   └─┬POST
│     ├─┬Parameters
│     │ └─┬Schema
│     │   └──[➖] description (21293:22)
│     └─┬Parameters
│       └─┬Schema
│         └──[➖] description (21301:22)
└─┬Components
  ├──[➕] requestBodies (23556:7)
  ├──[➕] responses (26271:7)
  ├──[➕] parameters (21395:7)
  ├──[➕] schemas (49051:7)
  ├──[➕] schemas (49025:7)
  ├──[➕] schemas (48950:7)
  ├──[➕] schemas (48925:7)
  ├──[➕] schemas (48941:7)
  ├──[➕] schemas (49015:7)
  ├──[➕] schemas (48909:7)
  ├──[➕] schemas (49056:7)
  ├──[➕] schemas (48934:7)
  └──[➕] schemas (49020:7)

Document Element	Total Changes	Breaking Changes
paths	22	0
components	13	0

Total Changes: 35
Removals: 20
Additions: 15

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/10220107483/artifacts/1770365701

API Coverage

	Before	After	Δ
Covered (%)	500 (48.97 %)	502 (49.17 %)	2 (0.2 %)
Uncovered (%)	521 (51.03 %)	519 (50.83 %)	-2 (-0.2 %)
Unknown	24	24	0

github-actions · 2024-07-31T17:11:26Z

Spec Test Coverage Analysis

Total	Tested
526	117 (22.24 %)

CHANGELOG.md

tests/sql/query.yaml

Tokesh · 2024-07-31T17:16:27Z

But i have a question. How i can describe this request body in specs? When user can input 2 different formats of request body. I have already described the second option, where everything is in a more detailed format.

spec/_superseded_operations.yaml

tests/sql/settings.yaml

dblock · 2024-07-31T19:06:39Z

But i have a question. How i can describe this request body in specs? When user can input 2 different formats of request body. I have already described the second option, where everything is in a more detailed format.

You mean in the schema? Are you looking for - anyOf:?

dblock · 2024-07-31T19:07:19Z

spec/schemas/sql._common.yaml

+          type: string
+        size_limit:
+          type: string


Double-checking that those are actually strings?

This API accept string and also numbers.

dblock

Let's make sure the types are correct.

dblock · 2024-07-31T19:07:28Z

spec/schemas/sql._common.yaml

+      properties:
+        enabled:
+          type: string


Tokesh · 2024-08-01T16:40:36Z

Let's make sure the types are correct.

I double checked it

Signed-off-by: Tokesh <[email protected]>

dblock

Thanks! It's close. See comments, look through all unresolved conversations. The types look suspicious.

spec/namespaces/sql.yaml

Signed-off-by: Tokesh <[email protected]>

Tokesh · 2024-08-01T18:52:00Z

Thanks! It's close. See comments, look through all unresolved conversations. The types look suspicious.

Okkie! I resolved all comments
Also, I attached a few screenshots related to types.

dblock

Looks good. One ask for CHANGELOG and we can merge.

spec/namespaces/sql.yaml

Signed-off-by: Niyazbek Torekeldi <[email protected]>

dblock

Question on boolean:

tests/sql/settings.yaml

Signed-off-by: Tokesh <[email protected]>

Tokesh · 2024-08-02T18:13:33Z

@dblock @nhtruong ready for your review!

Tokesh added 2 commits July 31, 2024 21:49

adding specs and tests for SQL Settings API

0bea608

Signed-off-by: Tokesh <[email protected]>

fix lint and validate ci

7acf0b6

Signed-off-by: Tokesh <[email protected]>

Tokesh requested review from dblock, harshavamsi, sachetalva, nhtruong, Xtansia, VachaShah and aabeshov as code owners July 31, 2024 17:01

Tokesh commented Jul 31, 2024

View reviewed changes

CHANGELOG.md Show resolved Hide resolved

Tokesh commented Jul 31, 2024

View reviewed changes

tests/sql/query.yaml Show resolved Hide resolved

nhtruong reviewed Jul 31, 2024

View reviewed changes

spec/_superseded_operations.yaml Show resolved Hide resolved

dblock approved these changes Jul 31, 2024

View reviewed changes

tests/sql/settings.yaml Outdated Show resolved Hide resolved

dblock reviewed Jul 31, 2024

View reviewed changes

dblock requested changes Jul 31, 2024

View reviewed changes

spec/schemas/sql._common.yaml Outdated

properties:

enabled:

type: string

Copy link

Member

dblock Jul 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Boolean?

dblock mentioned this pull request Aug 1, 2024

[FEATURE] Support plugins in client opensearch-project/opensearch-java#1120

Open

Tokesh added 2 commits August 1, 2024 22:52

adding version plain version of request body

a6e3502

Signed-off-by: Tokesh <[email protected]>

hotfix lint

f4c2be7

Signed-off-by: Tokesh <[email protected]>

Tokesh requested review from nhtruong and dblock August 1, 2024 17:58

dblock requested changes Aug 1, 2024

View reviewed changes

spec/namespaces/sql.yaml Outdated Show resolved Hide resolved

spec/namespaces/sql.yaml Outdated Show resolved Hide resolved

Tokesh added 2 commits August 1, 2024 23:26

deleting unnecessary descriptions in sql namespace specs

72d367d

Signed-off-by: Tokesh <[email protected]>

adding anyOf to few parameters in SQL schemas

57b6a53

Signed-off-by: Tokesh <[email protected]>

Tokesh requested a review from dblock August 1, 2024 18:50

dblock requested changes Aug 1, 2024

View reviewed changes

spec/namespaces/sql.yaml Show resolved Hide resolved

Tokesh added 2 commits August 2, 2024 22:03

adding changelog changes

281d555

Signed-off-by: Niyazbek Torekeldi <[email protected]>

Merge branch 'main' into sql-opendistro-setting

308ad94

Signed-off-by: Niyazbek Torekeldi <[email protected]>

dblock requested changes Aug 2, 2024

View reviewed changes

tests/sql/settings.yaml Outdated Show resolved Hide resolved

Tokesh requested a review from dblock August 2, 2024 18:06

fixing types in tests

41b888e

Signed-off-by: Tokesh <[email protected]>

dblock approved these changes Aug 2, 2024

View reviewed changes

dblock merged commit 2ca485a into opensearch-project:main Aug 2, 2024
12 checks passed

Tokesh mentioned this pull request Aug 3, 2024

[FEATURE] Add specs for sql namespace #235

Closed

9 tasks

aabeshov mentioned this pull request Aug 9, 2024

Observability namespace #474

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding SQL Settings specs #456

Adding SQL Settings specs #456

Tokesh commented Jul 31, 2024

github-actions bot commented Jul 31, 2024 •

edited

Loading

github-actions bot commented Jul 31, 2024 •

edited

Loading

Tokesh commented Jul 31, 2024 •

edited

Loading

dblock commented Jul 31, 2024

dblock Jul 31, 2024

Tokesh Aug 1, 2024

dblock left a comment

dblock Jul 31, 2024

Tokesh commented Aug 1, 2024 •

edited

Loading

dblock left a comment

Tokesh commented Aug 1, 2024

dblock left a comment

dblock left a comment

Tokesh commented Aug 2, 2024

Adding SQL Settings specs #456

Adding SQL Settings specs #456

Conversation

Tokesh commented Jul 31, 2024

Description

Issues Resolved

github-actions bot commented Jul 31, 2024 • edited Loading

Changes Analysis

API Changes

Summary

Report

API Coverage

github-actions bot commented Jul 31, 2024 • edited Loading

Spec Test Coverage Analysis

Tokesh commented Jul 31, 2024 • edited Loading

dblock commented Jul 31, 2024

dblock Jul 31, 2024

Choose a reason for hiding this comment

Tokesh Aug 1, 2024

Choose a reason for hiding this comment

dblock left a comment

Choose a reason for hiding this comment

dblock Jul 31, 2024

Choose a reason for hiding this comment

Tokesh commented Aug 1, 2024 • edited Loading

dblock left a comment

Choose a reason for hiding this comment

Tokesh commented Aug 1, 2024

dblock left a comment

Choose a reason for hiding this comment

dblock left a comment

Choose a reason for hiding this comment

Tokesh commented Aug 2, 2024

github-actions bot commented Jul 31, 2024 •

edited

Loading

github-actions bot commented Jul 31, 2024 •

edited

Loading

Tokesh commented Jul 31, 2024 •

edited

Loading

Tokesh commented Aug 1, 2024 •

edited

Loading