opensearch-project / opensearch-api-specification

API specification for OpenSearch
Apache License 2.0
35 stars 62 forks source link

[Docs]: Update rest of core parameter descriptions #623

Closed Naarcha-AWS closed 1 month ago

Naarcha-AWS commented 1 month ago

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[bot] commented 1 month ago

Changes Analysis

Commit SHA: c5df8562a73254d881a51463b456bb7860763959 Comparing To SHA: 4c48c26fc3674b251525aaad24ce87510c34bb33

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

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
github-actions[bot] commented 1 month ago

Spec Test Coverage Analysis

Total Tested
505 320 (63.37 %)
natebower commented 1 month ago

@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!

Naarcha-AWS commented 1 month ago

@dblock: This is ready for your review.