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
Add YAML spec docs about matching errors #89370
Merged
elasticsearchmachine
merged 3 commits into
elastic:main
from
DaveCTurner:2022-08-16-rest-api-spec-match-errors
Aug 18, 2022
Merged
Add YAML spec docs about matching errors #89370
elasticsearchmachine
merged 3 commits into
elastic:main
from
DaveCTurner:2022-08-16-rest-api-spec-match-errors
Aug 18, 2022
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It's not obvious that a YAML test with a `catch` stanza also permits `match` blocks to assert things about the structure of the error response, but this structure may be an important part of the API spec. This commit adds this info to the docs about YAML tests.
DaveCTurner
added
>docs
General docs changes
>non-issue
:Delivery/Build
Build or test infrastructure
v7.17.6
v8.5.0
labels
Aug 16, 2022
elasticsearchmachine
added
Team:Docs
Meta label for docs team
Team:Delivery
Meta label for Delivery team
labels
Aug 16, 2022
Pinging @elastic/es-docs (Team:Docs) |
Pinging @elastic/es-delivery (Team:Delivery) |
nik9000
approved these changes
Aug 18, 2022
id: 1 | ||
|
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.
Maybe,
# And, optionally, you can assert on the contents of the precise contents of the error message.
DaveCTurner
added
auto-merge
Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!)
auto-backport-and-merge
Automatically create backport pull requests and merge when ready
labels
Aug 18, 2022
DaveCTurner
added a commit
to DaveCTurner/elasticsearch
that referenced
this pull request
Aug 18, 2022
It's not obvious that a YAML test with a `catch` stanza also permits `match` blocks to assert things about the structure of the error response, but this structure may be an important part of the API spec. This commit adds this info to the docs about YAML tests.
💚 Backport successful
|
elasticsearchmachine
pushed a commit
that referenced
this pull request
Aug 18, 2022
It's not obvious that a YAML test with a `catch` stanza also permits `match` blocks to assert things about the structure of the error response, but this structure may be an important part of the API spec. This commit adds this info to the docs about YAML tests.
weizijun
added a commit
to weizijun/elasticsearch
that referenced
this pull request
Aug 19, 2022
* upstream/main: (265 commits) Disable openid connect tests due to missing fixture (elastic#89478) Add periodic job for single processor node testing Updates to changelog processing after docs redesign (elastic#89463) Better support for multi cluster for run task (elastic#89442) Mute failing tests (elastic#89465) [ML] Performance improvements related to ECS Grok pattern usage (elastic#89424) Add source fallback support for date and date_nanos mapped types (elastic#89440) Reuse Info in lifecycle step (elastic#89419) feature: support metrics for multi value fields (elastic#88818) Upgrade OpenTelemetry API and remove workaround (elastic#89438) Remove LegacyClusterTaskResultActionListener (elastic#89459) Add YAML spec docs about matching errors (elastic#89370) Remove redundant cluster upgrade tests for auth tokens (elastic#89417) Return 400 error for GetUserPrivileges call with API keys (elastic#89333) User Profile - Detailed errors in hasPrivileges response (elastic#89224) Rollover min_* conditions docs and highlight (elastic#89434) REST tests for percentiles_bucket agg (elastic#88029) REST tests for cumulative pipeline aggs (elastic#88966) Clean-up file watcher keys. (elastic#89429) fix a typo in Security.java (elastic#89248) ... # Conflicts: # server/src/main/java/org/elasticsearch/index/mapper/NumberFieldMapper.java
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
auto-backport-and-merge
Automatically create backport pull requests and merge when ready
auto-merge
Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!)
:Delivery/Build
Build or test infrastructure
>docs
General docs changes
>non-issue
Team:Delivery
Meta label for Delivery team
Team:Docs
Meta label for docs team
v7.17.6
v8.5.0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's not obvious that a YAML test with a
catch
stanza also permitsmatch
blocks to assert things about the structure of the errorresponse, but this structure may be an important part of the API spec.
This commit adds this info to the docs about YAML tests.