Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor the common query DSL spec to extract IgnoreUnmapped #515

Merged

Conversation

kolchfa-aws
Copy link
Contributor

Ignore_unmapped is a parameter that is common to several query types. This PR refactors the spec to extract IgnoreUnmapped into a common parameter. I left the descriptions in some of the query types because they are more specific than the generic description. I am assuming that the description within a query type overrides the description in the common parameter but please lmk if that's not true. I have verified that for all query types, the default for this parameter is false.

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: Fanit Kolchina <kolchfa@amazon.com>
Copy link

Changes Analysis

Commit SHA: abe27df
Comparing To SHA: c0d4a85

API Changes

Summary

└─┬Components
  ├──[➕] schemas (35579:7)
  ├─┬_common.query_dsl:NestedQuery
  │ └─┬ALLOF
  │   └─┬ignore_unmapped
  │     └──[🔀] $ref (35579:13)❌ 
  ├─┬_common.query_dsl:GeoPolygonQuery
  │ └─┬ALLOF
  │   └─┬ignore_unmapped
  │     └──[🔀] $ref (35579:13)❌ 
  ├─┬_common.query_dsl:HasParentQuery
  │ └─┬ALLOF
  │   └─┬ignore_unmapped
  │     └──[🔀] $ref (35579:13)❌ 
  ├─┬_common.query_dsl:GeoBoundingBoxQuery
  │ └─┬ALLOF
  │   └─┬ignore_unmapped
  │     └──[🔀] $ref (35579:13)❌ 
  ├─┬_common.query_dsl:ParentIdQuery
  │ └─┬ALLOF
  │   └─┬ignore_unmapped
  │     └──[🔀] $ref (35579:13)❌ 
  ├─┬_common.query_dsl:HasChildQuery
  │ └─┬ALLOF
  │   └─┬ignore_unmapped
  │     └──[🔀] $ref (35579:13)❌ 
  ├─┬_common.query_dsl:GeoShapeQuery
  │ └─┬ALLOF
  │   └─┬ignore_unmapped
  │     └──[🔀] $ref (35579:13)❌ 
  └─┬_common.query_dsl:ShapeQuery
    └─┬ALLOF
      └─┬ignore_unmapped
        └──[🔀] $ref (35579:13)❌ 

Document Element Total Changes Breaking Changes
components 9 16
  • BREAKING Changes: 16 out of 9
  • Modifications: 8
  • Additions: 1
  • Breaking Modifications: 8

Report

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

API Coverage

Before After Δ
Covered (%) 510 (49.95 %) 510 (49.95 %) 0 (0 %)
Uncovered (%) 511 (50.05 %) 511 (50.05 %) 0 (0 %)
Unknown 24 24 0

Copy link

Spec Test Coverage Analysis

Total Tested
550 331 (60.18 %)

@nhtruong nhtruong added the skip-changelog No need to update CHANGELOG. label Aug 19, 2024
@nhtruong nhtruong merged commit f9e2701 into opensearch-project:main Aug 19, 2024
15 of 24 checks passed
@dblock
Copy link
Member

dblock commented Aug 19, 2024

We only have 1 use of this parameter in

. Please do take the opportunity to add tests for any parts of the spec being updated in future PRs.

@kolchfa-aws
Copy link
Contributor Author

Yup, this is the first step of the plan.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No need to update CHANGELOG.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants