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]: Update rest of core parameter descriptions #623

Merged
merged 6 commits into from
Oct 25, 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: c5df856
Comparing To SHA: 4c48c26

API Changes

Summary

├─┬Paths
│ ├─┬/{index}/_bulk/stream
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_bulk
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/_bulk/stream
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_search
│ │ ├─┬GET
│ │ │ ├──Parameters
│ │ │ └──Parameters
│ │ └─┬POST
│ │   ├──Parameters
│ │   └──Parameters
│ ├─┬/_bulk
│ │ ├─┬PUT
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_update/{id}
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_mget
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_source/{id}
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬HEAD
│ │   └──Parameters
│ ├─┬/{index}/_explain/{id}
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬POST
│ │   └──Parameters
│ ├─┬/{index}/_doc/{id}
│ │ ├─┬GET
│ │ │ └──Parameters
│ │ └─┬HEAD
│ │   └──Parameters
│ ├─┬/_search
│ │ ├─┬GET
│ │ │ ├──Parameters
│ │ │ └──Parameters
│ │ └─┬POST
│ │   ├──Parameters
│ │   └──Parameters
│ └─┬/_mget
│   ├─┬GET
│   │ └──Parameters
│   └─┬POST
│     └──Parameters
└─┬Components
  ├─┬_core.search:FieldCollapse
  │ ├─┬inner_hits
  │ │ └──[🔀] description (42326:24)
  │ └─┬max_concurrent_group_searches
  │   └──[🔀] description (42333:24)
  ├─┬_core.search:HitsMetadata
  │ └─┬total
  │   └──[🔀] description (42546:24)
  ├─┬_core.reindex:Source
  │ └─┬size
  │   └──[🔀] description (41978:24)
  ├─┬_core.termvectors:Filter
  │ ├─┬max_doc_freq
  │ │ └──[🔀] description (43015:24)
  │ ├─┬max_num_terms
  │ │ └──[🔀] description (43020:24)
  │ ├─┬max_term_freq
  │ │ └──[🔀] description (43023:24)
  │ └─┬max_word_length
  │   └──[🔀] description (43028:24)
  ├─┬_core.search:HighlightBase
  │ ├─┬boundary_scanner_locale
  │ │ └──[🔀] description (42365:24)
  │ ├─┬max_analyzed_offset
  │ │ └──[🔀] description (42386:24)
  │ ├─┬number_of_fragments
  │ │ └──[🔀] description (42397:24)
  │ ├─┬phrase_limit
  │ │ └──[🔀] description (42412:24)
  │ ├─┬post_tags
  │ │ └──[🔀] description (42420:24)
  │ └─┬pre_tags
  │   └──[🔀] description (42427:24)
  ├─┬_core.search:RescoreQuery
  │ ├─┬query_weight
  │ │ └──[🔀] description (42783:24)
  │ └─┬rescore_query_weight
  │   └──[🔀] description (42787:24)
  ├─┬_core.scripts_painless_execute:PainlessContextSetup
  │ └─┬document
  │   └──[🔀] description (41996:24)
  ├─┬_core.reindex_rethrottle:ReindexStatus
  │ ├─┬requests_per_second
  │ │ └──[🔀] description (41865:24)
  │ ├─┬noops
  │ │ └──[🔀] description (41862:24)
  │ ├─┬batches
  │ │ └──[🔀] description (41853:24)
  │ └─┬updated
  │   └──[🔀] description (41881:24)
  ├─┬_core.search:TrackHits
  │ └──[🔀] description (42989:20)
  ├─┬_core.search:Suggester
  │ └─┬text
  │   └──[🔀] description (42938:24)
  ├─┬_core.search:InnerHits
  │ └─┬from
  │   └──[🔀] description (42572:24)
  └─┬_core.search:SourceConfigParam
    └──[🔀] description (42901:20)

Document Element Total Changes Breaking Changes
paths 0 0
components 25 0
  • Total Changes: 25
  • Modifications: 25

Report

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

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

github-actions bot commented Oct 17, 2024

Spec Test Coverage Analysis

Total Tested
505 320 (63.37 %)

Copy link
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.

Linter caught an issue.

{
  file: 'schemas/_core.search.yaml',
  location: '#/components/schemas/TrackHits',
  message: 'The description must start with a capital letter and end with a period, got "The number of hits matching the query. When `true`, the exact\n' +
    'number of hits is returned at the cost of some performance. When `false`, the\n' +
    'response does not include the total number of hits matching the query.\n' +
    'Default is `10,000` hits".'
}

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 Please see my comments and changes and let me know if you have any questions. Thanks!

spec/schemas/_core.reindex.yaml Outdated Show resolved Hide resolved
spec/schemas/_core.reindex_rethrottle.yaml Outdated Show resolved Hide resolved
spec/schemas/_core.reindex_rethrottle.yaml Outdated Show resolved Hide resolved
spec/schemas/_core.scripts_painless_execute.yaml Outdated Show resolved Hide resolved
spec/schemas/_core.search.yaml Outdated Show resolved Hide resolved
spec/schemas/_core.termvectors.yaml Outdated Show resolved Hide resolved
spec/schemas/_core.termvectors.yaml Outdated Show resolved Hide resolved
spec/schemas/_core.termvectors.yaml Outdated Show resolved Hide resolved
spec/schemas/_core.termvectors.yaml Outdated Show resolved Hide resolved
spec/schemas/_core.termvectors.yaml Outdated Show resolved Hide resolved
Naarcha-AWS and others added 2 commits October 18, 2024 09:35
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@natebower
Copy link
Contributor

@Naarcha-AWS It looks like there are just a couple of pending comments that need to be addressed before I can reread and approve. Thanks!

@dblock dblock added the skip-changelog No need to update CHANGELOG. label Oct 23, 2024
@@ -922,7 +922,7 @@ components:
type: object
properties:
text:
description: Global suggest text, to avoid repetition when the same text is used in several suggesters
description: The global suggest text, to avoid repetition when the same text is used in several suggesters
type: string
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Naarcha-AWS Naarcha-AWS requested a review from dblock October 25, 2024 15:31
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 LGTM with one minor change (my mistake--I used the wrong spelling in my suggestion 😄 ).

spec/schemas/_core.search.yaml Outdated Show resolved Hide resolved
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS
Copy link
Contributor Author

@dblock: This is ready for your review.

@dblock dblock merged commit 0605aec into opensearch-project:main Oct 25, 2024
21 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