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

[Docs] Edit msearch parameters descriptions #618

Merged
merged 3 commits into from
Oct 17, 2024

Conversation

Naarcha-AWS
Copy link
Contributor

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.

Copy link
Contributor

github-actions bot commented Oct 17, 2024

Changes Analysis

Commit SHA: d937b1d
Comparing To SHA: 99bc701

API Changes

Summary

└─┬Components
  ├─┬_core.msearch:MultisearchBody
  │ ├─┬script_fields
  │ │ └──[🔀] description (41496:24)
  │ ├─┬seq_no_primary_term
  │ │ └──[🔀] description (41550:24)
  │ ├─┬explain
  │ │ └──[🔀] description (41442:24)
  │ ├─┬ext
  │ │ └──[🔀] description (41445:24)
  │ ├─┬from
  │ │ └──[🔀] description (41466:24)
  │ ├─┬version
  │ │ └──[🔀] description (41545:24)
  │ ├─┬indices_boost
  │ │ └──[🔀] description (41474:24)
  │ ├─┬size
  │ │ └──[🔀] description (41503:24)
  │ └─┬track_scores
  │   └──[🔀] description (41540:24)
  └─┬_core.msearch_template:TemplateConfig
    ├─┬explain
    │ └──[🔀] description (41409:24)
    ├─┬source
    │ └──[🔀] description (41425:24)
    └─┬params
      └──[🔀] description (41414:24)

Document Element Total Changes Breaking Changes
components 12 0
  • Total Changes: 12
  • Modifications: 12

Report

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

API Coverage

Before After Δ
Covered (%) 588 (57.59 %) 588 (57.59 %) 0 (0 %)
Uncovered (%) 433 (42.41 %) 433 (42.41 %) 0 (0 %)
Unknown 29 29 0

Copy link
Contributor

Spec Test Coverage Analysis

Total Tested
504 317 (62.9 %)

Copy link
Contributor

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@Naarcha-AWS Just an added period 😄

spec/schemas/_core.msearch.yaml Outdated Show resolved Hide resolved
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@dblock dblock added the skip-changelog No need to update CHANGELOG. label Oct 17, 2024
@dblock dblock merged commit 4c48c26 into opensearch-project:main Oct 17, 2024
19 of 20 checks passed
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