Skip to content

adding ppl namespace api specs#460

Merged
dblock merged 7 commits intoopensearch-project:mainfrom
Tokesh:ppl-namespace
Aug 3, 2024
Merged

adding ppl namespace api specs#460
dblock merged 7 commits intoopensearch-project:mainfrom
Tokesh:ppl-namespace

Conversation

@Tokesh
Copy link
Copy Markdown
Collaborator

@Tokesh Tokesh commented Aug 1, 2024

Description

adding ppl namespace specs

Issues Resolved

[#231]

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.

Tokesh added 2 commits August 2, 2024 00:24
@Tokesh
adding ppl namespace api specs
8113beb 
Signed-off-by: Tokesh <tokesh789@gmail.com>
@Tokesh
fix lint and adding changelog
8b714e9 
Signed-off-by: Tokesh <tokesh789@gmail.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Aug 1, 2024 •
edited
Loading

Changes Analysis

Commit SHA: 4b157ac
Comparing To SHA: 2ca485a

API Changes

Summary

├─┬Paths
│ ├──[➕] path (10447:3)
│ ├──[➕] path (4095:3)
│ ├──[➕] path (4116:3)
│ ├──[➕] path (4074:3)
│ ├──[➕] path (10493:3)
│ ├──[➕] path (10470:3)
│ ├─┬/_plugins/_sql
│ │ └─┬POST
│ │   ├─┬Responses
│ │   │ └─┬200
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (49237:13)❌ 
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[🔀] $ref (49228:13)❌ 
│ ├─┬/_opendistro/_sql
│ │ └─┬POST
│ │   ├─┬Responses
│ │   │ └─┬200
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (49237:13)❌ 
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[🔀] $ref (49228:13)❌ 
│ ├─┬/_opendistro/_sql/stats
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[🔀] $ref (49298:13)❌ 
│ ├─┬/_plugins/_sql/_explain
│ │ └─┬POST
│ │   ├─┬Responses
│ │   │ └─┬200
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (49198:13)❌ 
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[🔀] $ref (49178:13)❌ 
│ ├─┬/_plugins/_sql/stats
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[🔀] $ref (49298:13)❌ 
│ └─┬/_opendistro/_sql/_explain
│   └─┬POST
│     ├─┬Responses
│     │ └─┬200
│     │   └─┬application/json
│     │     └─┬Schema
│     │       └──[🔀] $ref (49198:13)❌ 
│     └─┬Requestbody
│       └─┬application/json
│         └─┬Schema
│           └──[🔀] $ref (49178:13)❌ 
└─┬Components
  ├──[➕] requestBodies (23163:7)
  ├──[➕] requestBodies (23157:7)
  ├──[➕] requestBodies (23151:7)
  ├──[➕] responses (25458:7)
  ├──[➕] responses (25470:7)
  ├──[➕] responses (25476:7)
  ├──[➕] responses (25464:7)
  ├──[➕] parameters (19918:7)
  ├──[➕] parameters (19924:7)
  ├──[➕] parameters (19944:7)
  ├──[➕] parameters (19905:7)
  ├──[➕] parameters (19931:7)
  ├──[➕] parameters (19911:7)
  ├──[➕] parameters (19950:7)
  ├──[➕] parameters (19937:7)
  ├──[➖] schemas (49034:7)❌ 
  ├──[➖] schemas (48982:7)❌ 
  ├──[➖] schemas (48973:7)❌ 
  ├──[➖] schemas (48987:7)❌ 
  ├──[➖] schemas (48996:7)❌ 
  ├──[➕] schemas (49198:7)
  ├──[➕] schemas (49212:7)
  ├──[➕] schemas (49187:7)
  ├──[➕] schemas (49237:7)
  ├──[➕] schemas (49298:7)
  ├─┬sql._common:Explain
  │ ├──[➕] properties (49184:9)
  │ ├──[➖] properties (48920:9)❌ 
  │ ├──[➕] properties (49182:9)
  │ ├──[➖] properties (48918:9)❌ 
  │ ├──[➕] properties (49180:9)
  │ └──[➖] properties (48916:9)❌ 
  ├─┬sql._common:Query
  │ ├──[➕] properties (49234:9)
  │ ├──[➕] properties (49232:9)
  │ └──[➕] properties (49230:9)
  └─┬sql._common:Plugins
    └─┬query
      └──[🔀] $ref (49212:13)❌
Document Element Total Changes Breaking Changes
components 35 9
paths 16 10
  • ❌ BREAKING Changes: 19 out of 51
  • Modifications: 11
  • Removals: 8
  • Additions: 32
  • Breaking Removals: 8
  • Breaking Modifications: 11

Report

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

API Coverage

Before After Δ
Covered (%) 502 (49.17 %) 510 (49.95 %) 8 (0.78 %)
Uncovered (%) 519 (50.83 %) 511 (50.05 %) -8 (-0.78 %)
Unknown 24 24 0

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Aug 1, 2024 •
edited
Loading

Spec Test Coverage Analysis

Total Tested
534 120 (22.47 %)

@Tokesh
Copy link
Copy Markdown
Collaborator Author

Tokesh commented Aug 1, 2024

Still a draft. I want to refactor the structures, as there is an intersection with the SQL plugin. But the main work is done and the tests are written.

Tokesh and others added 3 commits August 2, 2024 23:25
@Tokesh
reusing already defined structures
88ffd25 
Signed-off-by: Tokesh <tokesh789@gmail.com>
@Tokesh
Merge branch 'main' into ppl-namespace
e11770c 
Signed-off-by: Niyazbek Torekeldi <78027392+Tokesh@users.noreply.github.com>
@Tokesh
Merge branch 'main' into ppl-namespace
833b696 
Signed-off-by: Niyazbek Torekeldi <78027392+Tokesh@users.noreply.github.com>
@Tokesh Tokesh marked this pull request as ready for review August 2, 2024 19:16
@Tokesh
edit of test descriptions
aea69f2 
Signed-off-by: Tokesh <tokesh789@gmail.com>
dblock
dblock suggested changes Aug 2, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

Nice. Mostly nitty asks.

Comment thread spec/namespaces/ppl.yaml Outdated
Comment thread spec/schemas/_plugins._common.yaml Outdated
Comment thread tests/ppl/explain.yaml Outdated
Comment thread tests/ppl/explain.yaml
@Tokesh
fixing descriptions, file structure and deleting semicolons from requ…
4b157ac 
…estbody

Signed-off-by: Tokesh <tokesh789@gmail.com>
@Tokesh Tokesh requested a review from dblock August 3, 2024 13:42
@dblock dblock merged commit 8bf497c into opensearch-project:main Aug 3, 2024
@Tokesh Tokesh mentioned this pull request Aug 3, 2024
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@harshavamsi harshavamsi Awaiting requested review from harshavamsi harshavamsi is a code owner

@sachetalva sachetalva Awaiting requested review from sachetalva sachetalva is a code owner

@nhtruong nhtruong Awaiting requested review from nhtruong

@Xtansia Xtansia Awaiting requested review from Xtansia Xtansia is a code owner

@VachaShah VachaShah Awaiting requested review from VachaShah VachaShah is a code owner

@aabeshov aabeshov Awaiting requested review from aabeshov aabeshov is a code owner

1 more reviewer

@dblock dblock dblock approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Tokesh @dblock