adding specs for SQL namespace #379

Tokesh · 2024-07-07T13:41:57Z

Description

adding sql query specification

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.

github-actions · 2024-07-07T13:43:52Z

Changes Analysis

Commit SHA: 1573d8b
Comparing To SHA: 592b9b6

API Changes

Summary


├─┬Paths
│ ├──[➕] path (11731:3)
│ ├──[➕] path (5650:3)
│ ├──[➕] path (11777:3)
│ ├──[➕] path (5671:3)
│ ├──[➕] path (5692:3)
│ ├──[➕] path (5629:3)
│ ├──[➕] path (11754:3)
│ └──[➕] path (11708:3)
└─┬Components
  ├──[➕] requestBodies (23511:7)
  ├──[➕] requestBodies (23523:7)
  ├──[➕] requestBodies (23505:7)
  ├──[➕] requestBodies (23517:7)
  ├──[➕] responses (26294:7)
  ├──[➕] responses (26300:7)
  ├──[➕] responses (26306:7)
  ├──[➕] responses (26288:7)
  ├──[➕] responses (26282:7)
  ├──[➕] parameters (21325:7)
  ├──[➕] parameters (21310:7)
  ├──[➕] parameters (21348:7)
  ├──[➕] parameters (21303:7)
  ├──[➕] parameters (21340:7)
  ├──[➕] parameters (21318:7)
  ├──[➕] parameters (21295:7)
  ├──[➕] parameters (21355:7)
  ├──[➕] parameters (21333:7)
  ├──[➕] parameters (21288:7)
  ├──[➕] schemas (48861:7)
  ├──[➕] schemas (48885:7)
  ├──[➕] schemas (48850:7)
  ├──[➕] schemas (48913:7)
  ├──[➕] schemas (48871:7)
  ├──[➕] schemas (48880:7)
  ├──[➕] schemas (48866:7)
  └──[➕] schemas (48894:7)

Document Element	Total Changes	Breaking Changes
paths	8	0
components	27	0

Total Changes: 35
Additions: 35

Report

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

API Coverage

	Before	After	Δ
Covered (%)	490 (47.99 %)	500 (48.97 %)	10 (0.98 %)
Uncovered (%)	531 (52.01 %)	521 (51.03 %)	-10 (-0.98 %)
Unknown	24	24	0

dblock · 2024-07-07T15:02:18Z

Awesome! Please write some tests for it? See https://github.com/opensearch-project/opensearch-api-specification/blob/main/SPECIFICATION_TESTING.md and https://github.com/opensearch-project/opensearch-api-specification/tree/main/tests.

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

This reverts commit e6958b363dd00b5702dba4159985b935d7360e62. Signed-off-by: Tokesh <[email protected]>

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

Tokesh · 2024-07-08T15:47:52Z

Awesome! Please write some tests for it? See https://github.com/opensearch-project/opensearch-api-specification/blob/main/SPECIFICATION_TESTING.md and https://github.com/opensearch-project/opensearch-api-specification/tree/main/tests.

Hello! Yes, i'll add test a bit later. I'm just getting used to OpenAPI.

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

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

dblock · 2024-07-22T14:20:05Z

Want to get this to a mergeable state? It doesn't have to be full coverage of the SQL plugin, can start with just the basics and make more PRs afterwards!

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

spec/namespaces/sql.yaml

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

nhtruong · 2024-07-24T16:23:20Z

@dblock That's very unusual for the framework to obscure an error not related to the testing itself. This should not have been handled by the framework and should crash it for the error trace to be shown.

dblock · 2024-07-24T16:24:45Z

@dblock That's very unusual for the framework to obscure an error not related to the testing itself. This should not have been handled by the framework and should crash it for the error trace to be shown.

Yes, 100%. I can look into it.

nhtruong · 2024-07-24T16:27:23Z

Created an issue: #449

Tokesh · 2024-07-24T16:28:45Z

Probably i found misstake
I'm waiting for the cursor to receive, but it doesn't come with the API
I will test and see

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

github-actions · 2024-07-24T16:44:32Z

Spec Test Coverage Analysis

Total	Tested
524	118 (22.52 %)

…ng comment and temporary ci setting Signed-off-by: Tokesh <[email protected]>

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

Tokesh · 2024-07-24T17:20:35Z

I'm so happy! You can check it now!
@dblock @nhtruong

nhtruong

This is great! Thank you!

nhtruong · 2024-07-24T20:26:15Z

Cant merged. Blocked by #379 (review) @dblock

dblock

Couple more. I think we should stay disciplined about prologue, sorry to be a hassle.

Also see if you can exercise the parameters like sanitize that aren't.

dblock · 2024-07-24T21:13:47Z

CHANGELOG.md

@@ -35,6 +35,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added AjvErrorsParser to print more informative error messages ([#364](https://github.com/opensearch-project/opensearch-api-specification/issues/364))
 - Added JsonSchemaValidator, a wrapper for AJV ([#364](https://github.com/opensearch-project/opensearch-api-specification/issues/364))
 - Added support for `application/cbor` responses ([#371](https://github.com/opensearch-project/opensearch-api-specification/pull/371))
+- Added tests for SQL namespace ([#379](https://github.com/opensearch-project/opensearch-api-specification/pull/379))


Actually the add is the spec.

Let's say "Added /_plugins/_sql, close and stats"?

dblock · 2024-07-24T21:14:08Z

tests/sql/close.yaml

@@ -0,0 +1,53 @@
+$schema: ../../json_schemas/test_story.schema.yaml
+
+description: Test to explicitly clear the cursor context


Add a period at the end.

Time for another lint!

We have #403, I'll add a note on tests.

dblock · 2024-07-24T21:14:47Z

tests/sql/close.yaml

+    parameters:
+      index: books
+    response:
+      status: 200


The above should be moved to a prologue because they aren't exercising the SQL API namespace.

dblock · 2024-07-24T21:17:21Z

Probably i found misstake I'm waiting for the cursor to receive, but it doesn't come with the API I will test and see

It did raise that bug of reporting errors, so thank you! Fix in #450.

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

Tokesh · 2024-07-25T16:11:32Z

Also see if you can exercise the parameters like sanitize that aren't.

I found sanitize in documentation here:

And rechecked on local machine

dblock · 2024-07-25T16:21:06Z

Also see if you can exercise the parameters like sanitize that aren't.

I found sanitize in documentation here: And rechecked on local machine

Yes, I meant adding a test that actually uses it.

dblock · 2024-07-25T16:23:14Z

Merged this! @Tokesh if you want to remove the changelog line that says "Added tests for ... SQL" (I don't think it's helpful), add some tests for ?sanitize and whatever other parts of the spec you declared but didn't test in a next PR, that'd be great!

Tokesh changed the title ~~added sql query specification~~ adding SQL namespace Jul 7, 2024

Tokesh changed the title ~~adding SQL namespace~~ adding specs for SQL namespace Jul 7, 2024

Tokesh added 11 commits July 8, 2024 19:52

added sql query specification

678fbdf

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

lint of query params

36b6c48

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

added explain, close and stats API specs

2a61bed

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

small fix of x-operation group

6af8316

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

fixing lint errors

108d0a0

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

small fix of operation group

a0965bc

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

Revert "fix operation xgroup"

df6c0ff

This reverts commit e6958b363dd00b5702dba4159985b935d7360e62. Signed-off-by: Tokesh <[email protected]>

fix response body

225447d

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

response body not passing linter

aa51113

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

response body

68752e2

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

deleting unnecessary response body

374e0e6

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

Tokesh force-pushed the sql-namespace branch from a736885 to 374e0e6 Compare July 8, 2024 14:52

Tokesh added 2 commits July 8, 2024 20:42

adding first test for SQL query api

73974e7

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

deleting local parameters for testing

a615da8

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

Tokesh and others added 3 commits July 21, 2024 22:16

adding tests for sql namespace

cb81586

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

fixing tests for sql namespace

7ae06fb

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

fixing lint

7efd2bb

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

fixing status in request body of sql query API

a9b20c5

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

Tokesh marked this pull request as ready for review July 24, 2024 04:03

Tokesh requested review from dblock, harshavamsi, sachetalva, nhtruong and Xtansia as code owners July 24, 2024 04:03

dblock reviewed Jul 24, 2024

View reviewed changes

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

Tokesh added 2 commits July 24, 2024 21:18

fixing specs-validate ci

bf278c8

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

adding verbose to check error in tests

ede9aba

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

nhtruong mentioned this pull request Jul 24, 2024

[BUG] Test framework hidding errors not related to spec test instead of crashing #449

Closed

adding second document to receive cursor

0c29ed7

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

Tokesh added 2 commits July 24, 2024 22:14

added bulk in close API tests, description of PR to changelog, deleti…

8514dfd

…ng comment and temporary ci setting Signed-off-by: Tokesh <[email protected]>

adding author name to cspell

8cd485b

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

Tokesh requested a review from dblock July 24, 2024 17:19

nhtruong previously approved these changes Jul 24, 2024

View reviewed changes

dblock requested changes Jul 24, 2024

View reviewed changes

adding text to changelog and refactoring code from chapters to prologue

1573d8b

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

Tokesh dismissed nhtruong’s stale review via 1573d8b July 25, 2024 16:09

Tokesh requested review from dblock and nhtruong July 25, 2024 16:15

nhtruong approved these changes Jul 25, 2024

View reviewed changes

dblock approved these changes Jul 25, 2024

View reviewed changes

dblock merged commit 6fd9afe into opensearch-project:main Jul 25, 2024
14 checks passed

This was referenced Jul 31, 2024

Adding SQL Settings specs #456

Merged

[FEATURE] Add specs for sql namespace #235

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adding specs for SQL namespace #379

adding specs for SQL namespace #379

Tokesh commented Jul 7, 2024

github-actions bot commented Jul 7, 2024 •

edited

Loading

dblock commented Jul 7, 2024

Tokesh commented Jul 8, 2024

dblock commented Jul 22, 2024

nhtruong commented Jul 24, 2024

dblock commented Jul 24, 2024

nhtruong commented Jul 24, 2024

Tokesh commented Jul 24, 2024

github-actions bot commented Jul 24, 2024

Tokesh commented Jul 24, 2024

nhtruong left a comment

nhtruong commented Jul 24, 2024

dblock left a comment •

edited

Loading

dblock Jul 24, 2024

dblock Jul 24, 2024

nhtruong Jul 25, 2024

dblock Jul 25, 2024

dblock Jul 24, 2024

dblock commented Jul 24, 2024

Tokesh commented Jul 25, 2024 •

edited

Loading

dblock commented Jul 25, 2024

dblock commented Jul 25, 2024 •

edited

Loading

		@@ -0,0 +1,53 @@
		$schema: ../../json_schemas/test_story.schema.yaml

		description: Test to explicitly clear the cursor context

adding specs for SQL namespace #379

adding specs for SQL namespace #379

Conversation

Tokesh commented Jul 7, 2024

Description

Issues Resolved

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

Changes Analysis

API Changes

Summary

Report

API Coverage

dblock commented Jul 7, 2024

Tokesh commented Jul 8, 2024

dblock commented Jul 22, 2024

nhtruong commented Jul 24, 2024

dblock commented Jul 24, 2024

nhtruong commented Jul 24, 2024

Tokesh commented Jul 24, 2024

github-actions bot commented Jul 24, 2024

Spec Test Coverage Analysis

Tokesh commented Jul 24, 2024

nhtruong left a comment

Choose a reason for hiding this comment

nhtruong commented Jul 24, 2024

dblock left a comment • edited Loading

Choose a reason for hiding this comment

dblock Jul 24, 2024

Choose a reason for hiding this comment

dblock Jul 24, 2024

Choose a reason for hiding this comment

nhtruong Jul 25, 2024

Choose a reason for hiding this comment

dblock Jul 25, 2024

Choose a reason for hiding this comment

dblock Jul 24, 2024

Choose a reason for hiding this comment

dblock commented Jul 24, 2024

Tokesh commented Jul 25, 2024 • edited Loading

dblock commented Jul 25, 2024

dblock commented Jul 25, 2024 • edited Loading

github-actions bot commented Jul 7, 2024 •

edited

Loading

dblock left a comment •

edited

Loading

Tokesh commented Jul 25, 2024 •

edited

Loading

dblock commented Jul 25, 2024 •

edited

Loading