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

[Proposal] Update API template #7709

Merged
merged 11 commits into from
Jul 24, 2024

Fix link

3806af0
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Merged

[Proposal] Update API template #7709

Fix link
3806af0
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Jul 24, 2024 in 0s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (7)

_api-reference/tasks.md|49 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_api-reference/document-apis/multi-get.md|59 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_api-reference/cat/cat-segments.md|29 col 43| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/api-reference/cat/index)'.
_api-reference/cat/cat-field-data.md|11 col 3| [OpenSearch.HeadingCapitalization] 'CAT Field Data' is a heading and should be in sentence case.
_api-reference/cat/cat-field-data.md|29 col 43| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/api-reference/cat/index)'.
_api-reference/cat/cat-count.md|28 col 94| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/api-reference/cat/index)'.
_api-reference/cat/cat-thread-pool.md|28 col 43| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/api-reference/cat/index)'.

Filtered Findings (2440)

404.md|9 col 48| [OpenSearch.HeadingPunctuation] Don't use punctuation at the end of a heading.
404.md|11 col 96| [OpenSearch.DirectionAboveBelow] Use 'following or later' instead of 'below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
404.md|11 col 142| [OpenSearch.Please] Using 'please' is unnecessary. Remove.
_reporting/rep-cli-index.md|35 col 15| [OpenSearch.AcronymParentheses] 'CLI': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_reporting/rep-cli-index.md|35 col 195| [OpenSearch.AcronymParentheses] 'CLI': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_reporting/rep-cli-index.md|37 col 46| [OpenSearch.AcronymParentheses] 'CLI': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_reporting/rep-cli-create.md|17 col 117| [OpenSearch.Spelling] Error: Shapshot. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_reporting/rep-cli-install.md|13 col 69| [OpenSearch.Spelling] Error: npm. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_reporting/rep-cli-install.md|15 col 25| [OpenSearch.Spelling] Error: npm. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_reporting/rep-cli-install.md|15 col 57| [OpenSearch.Spelling] Error: npm. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_reporting/rep-cli-install.md|17 col 54| [OpenSearch.Spelling] Error: npm. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_reporting/rep-cli-install.md|19 col 48| [OpenSearch.Spelling] Error: npm. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_reporting/rep-cli-lambda.md|107 col 59| [Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.
_reporting/rep-cli-lambda.md|122 col 91| [Vale.Terms] Use 'Lambda' instead of 'lambda'.
_reporting/rep-cli-lambda.md|123 col 57| [OpenSearch.UnitsSpacing] Put a space between the number and the units in '1024MB.'.
_observing-your-data/index.md|19 col 34| [OpenSearch.Spelling] Error: timeframe. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/index.md|19 col 34| [OpenSearch.SubstitutionsError] Use 'time frame' instead of 'timeframe'.
_observing-your-data/index.md|19 col 77| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/index)'.
_observing-your-data/index.md|20 col 25| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/observing-your-data/event-analytics)'.
_observing-your-data/index.md|22 col 31| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/observing-your-data/operational-panels)'.
_observing-your-data/index.md|25 col 25| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/observing-your-data/trace/index)'.
_observing-your-data/index.md|27 col 24| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/observing-your-data/notebooks)'.
_reporting/rep-cli-options.md|24 col 79| [Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.
_reporting/rep-cli-options.md|28 col 65| [OpenSearch.AcronymParentheses] 'SMTP': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_reporting/rep-cli-options.md|28 col 90| [OpenSearch.AcronymParentheses] 'SMTP': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_reporting/rep-cli-options.md|29 col 66| [OpenSearch.AcronymParentheses] 'SMTP': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_reporting/rep-cli-options.md|29 col 91| [OpenSearch.AcronymParentheses] 'SMTP': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_reporting/rep-cli-options.md|30 col 86| [OpenSearch.AcronymParentheses] 'SMTP': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_observing-your-data/operational-panels.md|12 col 122| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/index)'.
_observing-your-data/operational-panels.md|22 col 164| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/observing-your-data/event-analytics)'.
_reporting/rep-cli-env-var.md|73 col 99| [OpenSearch.AcronymParentheses] 'SMTP': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_reporting/rep-cli-env-var.md|96 col 9| [OpenSearch.Spelling] Error: zsh. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/alerting/cron.md|13 col 71| [OpenSearch.LatinismsElimination] Using 'etc.' is unnecessary. Remove.
_observing-your-data/alerting/cron.md|17 col 10| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_observing-your-data/alerting/cron.md|18 col 8| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_observing-your-data/alerting/cron.md|19 col 16| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_observing-your-data/alerting/cron.md|20 col 9| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_observing-your-data/alerting/cron.md|21 col 15| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_observing-your-data/alerting/cron.md|39 col 130| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_observing-your-data/alerting/settings.md|13 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_observing-your-data/alerting/settings.md|21 col 95| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore)'.
_observing-your-data/alerting/settings.md|39 col 55| [Vale.Terms] Use 'Alerting plugin' instead of 'alerting plugin'.
_observing-your-data/alerting/per-query-bucket-monitors.md|29 col 86| [OpenSearch.DirectionAboveBelow] Use 'previous, preceding, or earlier' instead of 'above' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_observing-your-data/alerting/per-query-bucket-monitors.md|29 col 95| [OpenSearch.DirectionAboveBelow] Use 'following or later' instead of 'below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_observing-your-data/alerting/per-query-bucket-monitors.md|31 col 99| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/opensearch/query-dsl/full-text/index)'.
_observing-your-data/alerting/per-query-bucket-monitors.md|87 col 97| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/opensearch/query-dsl/full-text/index)'.
_observing-your-data/alerting/per-query-bucket-monitors.md|104 col 1| [OpenSearch.Repetition] 'custom' is repeated.
_observing-your-data/alerting/monitors.md|54 col 80| [OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'alert.id'.
_observing-your-data/alerting/triggers.md|18 col 363| [OpenSearch.DirectionAboveBelow] Use 'previous, preceding, or earlier' instead of 'ABOVE' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_observing-your-data/alerting/triggers.md|18 col 375| [OpenSearch.DirectionAboveBelow] Use 'following or later' instead of 'BELOW' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_observing-your-data/alerting/triggers.md|134 col 80| [OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'alert.id'.
_observing-your-data/alerting/dashboards-alerting.md|39 col 14| [OpenSearch.Spelling] Error: Vizlib. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/alerting/dashboards-alerting.md|86 col 233| [OpenSearch.Spelling] Error: unlinks. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/alerting/security.md|45 col 301| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security/access-control/document-level-security)'.
_observing-your-data/alerting/security.md|45 col 412| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security/access-control/field-level-security)'.
_observing-your-data/alerting/security.md|51 col 21| [Vale.Terms] Use 'Alerting plugin' instead of 'alerting plugin'.
_observing-your-data/alerting/per-cluster-metrics-monitors.md|43 col 9| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_observing-your-data/alerting/per-document-monitors.md|33 col 1| [OpenSearch.DashSpacing] There should be no spaces around the dash in 'tags --- that'.
_observing-your-data/alerting/composite-monitors.md|213 col 5| [OpenSearch.HeadingCapitalization] 'Get Composite Monitor' is a heading and should be in sentence case.
_observing-your-data/alerting/composite-monitors.md|229 col 5| [OpenSearch.HeadingCapitalization] 'Update Composite Monitor' is a heading and should be in sentence case.
_observing-your-data/alerting/composite-monitors.md|273 col 5| [OpenSearch.HeadingCapitalization] 'Delete Composite Monitor' is a heading and should be in sentence case.
_observing-your-data/alerting/composite-monitors.md|281 col 5| [OpenSearch.HeadingCapitalization] 'Execute Composite Monitor' is a heading and should be in sentence case.
_observing-your-data/ad/settings.md|10 col 3| [OpenSearch.HeadingCapitalization] 'Anomaly Detection settings' is a heading and should be in sentence case.
_observing-your-data/ad/settings.md|30 col 56| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|34 col 129| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|35 col 157| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|36 col 254| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|37 col 277| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|39 col 125| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|41 col 151| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|42 col 133| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|45 col 545| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_observing-your-data/ad/settings.md|45 col 554| [OpenSearch.Range] Use an en dash (--) with no space on either side in a range of numbers.
_observing-your-data/ad/settings.md|45 col 783| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|46 col 149| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|47 col 92| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|48 col 137| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/settings.md|48 col 208| [OpenSearch.LatinismsSubstitution] Use 'using, through, by accessing, or by choosing' instead of 'via'.
_observing-your-data/ad/result-mapping.md|12 col 41| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/dashboards-anomaly-detection.md|21 col 99| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/install-and-configure/plugins)'.
_observing-your-data/ad/dashboards-anomaly-detection.md|26 col 369| [OpenSearch.SubstitutionsError] Use 'for more information about' instead of 'For more information on'.
_observing-your-data/ad/dashboards-anomaly-detection.md|30 col 14| [OpenSearch.Spelling] Error: Vizlib. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/ad/security.md|30 col 315| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security/access-control/document-level-security)'.
_observing-your-data/ad/security.md|30 col 426| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/security/access-control/field-level-security)'.
_observing-your-data/trace/index.md|12 col 3| [OpenSearch.HeadingCapitalization] 'Trace Analytics' is a heading and should be in sentence case.
_observing-your-data/alerting/api.md|322 col 50| [OpenSearch.Spelling] Error: tz. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/alerting/api.md|322 col 172| [OpenSearch.SubstitutionsError] Use 'time zone' instead of 'TimeZone'.
_observing-your-data/trace/trace-analytics-jaeger.md|50 col 71| [OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'analytics. Set'.
_observing-your-data/ad/index.md|87 col 239| [Vale.Terms] Use 'JSON' instead of 'json'.
_observing-your-data/ad/index.md|112 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_observing-your-data/ad/index.md|220 col 1| [OpenSearch.SpacingSlash] When using '/' between words, do not insert space on either side of it.
_observing-your-data/trace/getting-started.md|11 col 3| [OpenSearch.HeadingCapitalization] 'Getting started with Trace Analytics' is a heading and should be in sentence case.
_observing-your-data/trace/getting-started.md|21 col 44| [OpenSearch.DirectionAboveBelow] Use 'following example' instead of 'example below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_observing-your-data/trace/getting-started.md|84 col 41| [OpenSearch.SubstitutionsError] Use 'time frame' instead of 'timeframe'.
_observing-your-data/trace/getting-started.md|84 col 41| [OpenSearch.Spelling] Error: timeframe. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/trace/getting-started.md|84 col 77| [OpenSearch.SubstitutionsError] Use 'for more information about' instead of 'For more information on'.
_observing-your-data/app-analytics.md|23 col 12| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/index)'.
_observing-your-data/app-analytics.md|28 col 17| [OpenSearch.Ampersand] Don't use an ampersand in place of 'and' in documentation.
_observing-your-data/app-analytics.md|36 col 13| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/index)'.
_observing-your-data/log-ingestion.md|9 col 3| [OpenSearch.HeadingCapitalization] 'Log Ingestion' is a heading and should be in sentence case.
_observing-your-data/log-ingestion.md|23 col 1| [OpenSearch.DirectionAboveBelow] Use 'following example' instead of 'example below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_observing-your-data/log-ingestion.md|42 col 34| [OpenSearch.SubstitutionsError] Use 'ingest pipeline' instead of 'ingestion pipeline'.
_observing-your-data/log-ingestion.md|42 col 234| [OpenSearch.SubstitutionsError] Use 'ingest pipeline' instead of 'ingestion pipeline'.
_observing-your-data/notifications/index.md|26 col 216| [OpenSearch.DirectionAboveBelow] Use 'following or later' instead of 'below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_observing-your-data/observability-security.md|36 col 344| [OpenSearch.LatinismsElimination] Using 'etc.' is unnecessary. Remove.
_observing-your-data/notebooks.md|79 col 3| [OpenSearch.AcronymParentheses] 'PPL': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_observing-your-data/prometheusmetrics.md|74 col 4| [OpenSearch.Spelling] Error: Datasource. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/prometheusmetrics.md|197 col 24| [OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'page, enter'.
_observing-your-data/event-analytics.md|31 col 5| [OpenSearch.HeadingCapitalization] 'OpenSearch Dashboards Query Assistant' is a heading and should be in sentence case.
_observing-your-data/event-analytics.md|40 col 6| [OpenSearch.HeadingCapitalization] 'Enabling Query Assistant' is a heading and should be in sentence case.
_observing-your-data/event-analytics.md|52 col 6| [OpenSearch.HeadingCapitalization] 'Setting up Query Assistant' is a heading and should be in sentence case.
_observing-your-data/event-analytics.md|68 col 173| [OpenSearch.Spelling] Error: _flights. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/event-analytics.md|109 col 5| [OpenSearch.Spelling] Error: Livestreaming. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_observing-your-data/ad/api.md|329 col 25| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_observing-your-data/ad/api.md|501 col 6| [OpenSearch.HeadingCapitalization] 'Sample Responses' is a heading and should be in sentence case.
_observing-your-data/ad/api.md|627 col 158| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_observing-your-data/ad/api.md|629 col 42| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/api.md|634 col 117| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/api.md|2176 col 44| [OpenSearch.Simple] Don't use 'simply' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_observing-your-data/ad/api.md|2236 col 118| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_observing-your-data/ad/api.md|2236 col 144| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_observing-your-data/ad/api.md|2238 col 54| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_observing-your-data/ad/api.md|2238 col 132| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/api.md|2238 col 190| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_observing-your-data/ad/api.md|2503 col 136| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/api.md|2712 col 6| [OpenSearch.HeadingCapitalization] 'Sample Responses' is a heading and should be in sentence case.
_observing-your-data/ad/api.md|3023 col 277| [Vale.Terms] Use 'Anomaly Detection plugin' instead of 'anomaly detection plugin'.
_observing-your-data/ad/api.md|3043 col 6| [OpenSearch.HeadingCapitalization] 'Sample Responses' is a heading and should be in sentence case.
_observing-your-data/ad/api.md|3072 col 6| [OpenSearch.HeadingCapitalization] 'Sample Responses' is a heading and should be in sentence case.
_observing-your-data/ad/api.md|3221 col 181| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_observing-your-data/ad/api.md|3223 col 93| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_dashboards/index.md|58 col 43| [OpenSearch.LinksDoubleSlash] Remove double slashes from the link '({{site.url}}{{site.baseurl}}//observing-your-data/index/)'.
_dashboards/index.md|61 col 4| [OpenSearch.HeadingCapitalization] 'Dashboards Management' is a heading and should be in sentence case.
_dashboards/quickstart.md|26 col 12| [OpenSearch.Spelling] Error: undock. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_dashboards/quickstart.md|26 col 246| [OpenSearch.Spelling] Error: Undock. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_dashboards/quickstart.md|43 col 4| [OpenSearch.HeadingCapitalization] 'Using the Discover application' is a heading and should be in sentence case.
_dashboards/quickstart.md|63 col 4| [OpenSearch.HeadingCapitalization] 'Using the Dashboards application' is a heading and should be in sentence case.
_dashboards/dashboard/plugins-dashboards.md|29 col 179| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_dashboards/sm-dashboards.md|9 col 3| [OpenSearch.HeadingCapitalization] 'Snapshot Management' is a heading and should be in sentence case.
_dashboards/sm-dashboards.md|79 col 28| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_dashboards/sm-dashboards.md|119 col 28| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_dashboards/sm-dashboards.md|141 col 144| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/sm-dashboards.md|149 col 108| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_dashboards/sm-dashboards.md|149 col 389| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_dashboards/sm-dashboards.md|178 col 84| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/sm-dashboards.md|178 col 178| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/sm-dashboards.md|180 col 110| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/dashboard/index.md|96 col 26| [OpenSearch.DirectionTopBottom] Use 'upper right' instead of 'top right' for window, page, or pane references to features or controls. Use 'top' and 'bottom' only as a general screen reference.
_dashboards/dashboard/index.md|98 col 34| [OpenSearch.DirectionTopBottom] Use 'upper right' instead of 'top right' for window, page, or pane references to features or controls. Use 'top' and 'bottom' only as a general screen reference.
_dashboards/dashboard/index.md|138 col 105| [OpenSearch.DirectionTopBottom] Use 'upper right' instead of 'top right' for window, page, or pane references to features or controls. Use 'top' and 'bottom' only as a general screen reference.
_dashboards/branding.md|11 col 121| [OpenSearch.Spelling] Error: favicon. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_dashboards/branding.md|20 col 292| [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/dashboards/install/tls)'.
_dashboards/branding.md|34 col 1| [OpenSearch.Spelling] Error: loadingLogo. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_dashboards/branding.md|35 col 1| [OpenSearch.Spelling] Error: faviconUrl. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_dashboards/branding.md|36 col 1| [OpenSearch.Spelling] Error: applicationTitle. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_dashboards/branding.md|60 col 394| [OpenSearch.Simple] Don't use 'just' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_dashboards/branding.md|121 col 45| [OpenSearch.DirectionAboveBelow] Use 'following example' instead of 'example below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_dashboards/branding.md|140 col 17| [OpenSearch.Spelling] Error: nagivation. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_dashboards/branding.md|142 col 136| [OpenSearch.DirectionAboveBelow] Use 'following steps' instead of 'steps below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_dashboards/management/management-index.md|8 col 3| [OpenSearch.HeadingCapitalization] 'Dashboards Management' is a heading and should be in sentence case.
_dashboards/management/accelerate-external-data.md|47 col 79| [OpenSearch.Spelling] Error: skippping. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_dashboards/management/data-sources.md|44 col 19| [OpenSearch.Ampersand] Don't use an ampersand in place of 'and' in documentation.
_dashboards/management/data-sources.md|45 col 12| [OpenSearch.SignatureV4] 'AWS Signature Version 4': Use 'AWS Signature Version 4' instead of 'AWS SigV4' on first appearance. Then, Signature Version 4 may be used. Only use SigV4 when space is limited.
_dashboards/management/data-sources.md|62 col 15| [OpenSearch.Ampersand] Don't use an ampersand in place of 'and' in documentation.
_dashboards/management/data-sources.md|64 col 8| [OpenSearch.SignatureV4] 'AWS Signature Version 4': Use 'AWS Signature Version 4' instead of 'AWS SigV4' on first appearance. Then, Signature Version 4 may be used. Only use SigV4 when space is limited.
_dashboards/search-telemetry.md|21 col 71| [Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.
_dashboards/im-dashboards/index.md|10 col 3| [OpenSearch.HeadingCapitalization] 'Index Management' is a heading and should be in sentence case.
_dashboards/im-dashboards/index.md|20 col 4| [OpenSearch.HeadingCapitalization] 'Get started with Index Management using Dashboards' is a heading and should be in sentence case.
_dashboards/im-dashboards/index.md|24 col 126| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/im-dashboards/index.md|28 col 12| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/management/advanced-settings.md|120 col 87| [OpenSearch.LinksDoubleSlash] Remove double slashes from the link '({{site.url}}{{site.baseurl}}//api-reference/popular-api/)'.
_dashboards/management/advanced-settings.md|137 col 108| [OpenSearch.Spelling] Error: Quandl's. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_dashboards/query-workbench.md|105 col 108| [OpenSearch.AcronymParentheses] 'PPL': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_dashboards/query-workbench.md|115 col 68| [OpenSearch.AcronymParentheses] 'PPL': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_dashboards/query-workbench.md|115 col 106| [OpenSearch.AcronymParentheses] 'PPL': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_dashboards/im-dashboards/notifications.md|38 col 52| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/im-dashboards/component-templates.md|33 col 4| [OpenSearch.HeadingCapitalization] 'Creating component templates using the Index Management UI' is a heading and should be in sentence case.
_dashboards/im-dashboards/forcemerge.md|20 col 41| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/im-dashboards/forcemerge.md|30 col 73| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_dashboards/im-dashboards/forcemerge.md|46 col 73| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_dashboards/im-dashboards/datastream.md|91 col 73| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_dashboards/im-dashboards/datastream.md|115 col 59| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/management/multi-data-sources.md|48 col 20| [OpenSearch.Ampersand] Don't use an ampersand in place of 'and' in documentation.
_dashboards/management/multi-data-sources.md|49 col 13| [OpenSearch.SignatureV4] 'AWS Signature Version 4': Use 'AWS Signature Version 4' instead of 'AWS SigV4' on first appearance. Then, Signature Version 4 may be used. Only use SigV4 when space is limited.
_dashboards/management/multi-data-sources.md|67 col 25| [OpenSearch.Ampersand] Don't use an ampersand in place of 'and' in documentation.
_dashboards/management/multi-data-sources.md|68 col 18| [OpenSearch.SignatureV4] 'AWS Signature Version 4': Use 'AWS Signature Version 4' instead of 'AWS SigV4' on first appearance. Then, Signature Version 4 may be used. Only use SigV4 when space is limited.
_dashboards/visualize/maptiles.md|13 col 3| [OpenSearch.HeadingCapitalization] 'Configuring a Web Map Service (WMS)' is a heading and should be in sentence case.
_dashboards/visualize/maptiles.md|13 col 33| [OpenSearch.HeadingAcronyms] '(WMS)': Don't define acronyms in headings.
_dashboards/visualize/vega.md|16 col 290| [OpenSearch.AcronymParentheses] 'README': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_dashboards/visualize/maps-stats-api.md|10 col 3| [OpenSearch.HeadingCapitalization] 'Maps Stats API' is a heading and should be in sentence case.
_dashboards/im-dashboards/index-management.md|48 col 48| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/im-dashboards/index-management.md|55 col 7| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/im-dashboards/index-management.md|67 col 76| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/im-dashboards/index-management.md|88 col 86| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/im-dashboards/index-management.md|96 col 66| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/im-dashboards/index-management.md|102 col 64| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/im-dashboards/index-management.md|108 col 50| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/im-dashboards/index-management.md|116 col 68| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/im-dashboards/index-management.md|124 col 66| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/im-dashboards/index-management.md|136 col 60| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/im-dashboards/index-management.md|146 col 58| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_dashboards/im-dashboards/index-management.md|154 col 64| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
... (Too many findings. Dropped some findings)

Annotations

Check failure on line 49 in _api-reference/tasks.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _api-reference/tasks.md#L49

[OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
Raw output
{"message": "[OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.", "location": {"path": "_api-reference/tasks.md", "range": {"start": {"line": 49, "column": 1}}}, "severity": "ERROR"}

Check failure on line 59 in _api-reference/document-apis/multi-get.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _api-reference/document-apis/multi-get.md#L59

[OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
Raw output
{"message": "[OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.", "location": {"path": "_api-reference/document-apis/multi-get.md", "range": {"start": {"line": 59, "column": 1}}}, "severity": "ERROR"}

Check failure on line 29 in _api-reference/cat/cat-segments.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _api-reference/cat/cat-segments.md#L29

[OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/api-reference/cat/index)'.
Raw output
{"message": "[OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/api-reference/cat/index)'.", "location": {"path": "_api-reference/cat/cat-segments.md", "range": {"start": {"line": 29, "column": 43}}}, "severity": "ERROR"}

Check failure on line 11 in _api-reference/cat/cat-field-data.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _api-reference/cat/cat-field-data.md#L11

[OpenSearch.HeadingCapitalization] 'CAT Field Data' is a heading and should be in sentence case.
Raw output
{"message": "[OpenSearch.HeadingCapitalization] 'CAT Field Data' is a heading and should be in sentence case.", "location": {"path": "_api-reference/cat/cat-field-data.md", "range": {"start": {"line": 11, "column": 3}}}, "severity": "ERROR"}

Check failure on line 29 in _api-reference/cat/cat-field-data.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _api-reference/cat/cat-field-data.md#L29

[OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/api-reference/cat/index)'.
Raw output
{"message": "[OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/api-reference/cat/index)'.", "location": {"path": "_api-reference/cat/cat-field-data.md", "range": {"start": {"line": 29, "column": 43}}}, "severity": "ERROR"}

Check failure on line 28 in _api-reference/cat/cat-count.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _api-reference/cat/cat-count.md#L28

[OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/api-reference/cat/index)'.
Raw output
{"message": "[OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/api-reference/cat/index)'.", "location": {"path": "_api-reference/cat/cat-count.md", "range": {"start": {"line": 28, "column": 94}}}, "severity": "ERROR"}

Check failure on line 28 in _api-reference/cat/cat-thread-pool.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _api-reference/cat/cat-thread-pool.md#L28

[OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/api-reference/cat/index)'.
Raw output
{"message": "[OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/api-reference/cat/index)'.", "location": {"path": "_api-reference/cat/cat-thread-pool.md", "range": {"start": {"line": 28, "column": 43}}}, "severity": "ERROR"}