Document meta-data returned by operations #1169
Merged
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
With this commit we add a new `meta data` section to each operation in the track reference documentation which documents which meta data are returned. This information can be used to add assertions for custom tracks. We also enhance a couple of existing runners so that they return a `dict` structure instead of a tuple because only `dicts` are supported for assertions. Relates elastic#1157
danielmitterdorfer
added
enhancement
| @@ -457,135 +457,6 @@ async def __call__(self, es, params): | |||
| in ``benchmarks/driver``. | |||
| * ``request-timeout``: a non-negative float indicating the client-side timeout for the operation. If not present, defaults to | |||
| ``None`` and potentially falls back to the global timeout setting. | |||
|
|
|||
There was a problem hiding this comment.
As this would now duplicate user docs I've removed it here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
With this commit we add a new
meta datasection to each operation inthe track reference documentation which documents which meta data are
returned. This information can be used to add assertions for custom
tracks. We also enhance a couple of existing runners so that they return
a
dictstructure instead of a tuple because onlydictsare supportedfor assertions.
Relates #1157