-
Notifications
You must be signed in to change notification settings - Fork 64
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
[Docs]: Update rest of core parameter descriptions #623
Conversation
Signed-off-by: Archer <[email protected]>
Changes AnalysisCommit SHA: c5df856 API ChangesSummary
ReportThe full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/11521340477/artifacts/2104964900 API Coverage
|
Spec Test Coverage Analysis
|
There was a problem hiding this 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".'
}
There was a problem hiding this 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!
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]>
@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! |
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
There was a problem hiding this 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 😄 ).
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
@dblock: This is ready for your review. |
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.