Fixed a badly formatted example #4851
Conversation
|
Following you can find the validation changes against the target branch for the APIs. No changes detected. You can validate these APIs yourself by using the |
|
|
||
| \ } | ||
|
|
||
| value: |- |
There was a problem hiding this comment.
We don't really have a way to define examples that issue multiple requests, so I'm putting the 2nd and 3rd requests in the value key.
There was a problem hiding this comment.
This does not seem like a valid OpenAPI example to me. Linters that check the request body example against the schema (we currently have those linting rules turned off) would fail due to those extra API requests in the value. I think we need to stick to one API request body per yaml file.
There was a problem hiding this comment.
The current version of this example has two requests. And the method_request key in this example file is set to the "close index" endpoint, which does not take a body, and for that reason fails parsing in the request converter.
If we have to use one request per example, then maybe it is best to remove this example?
FYI, this is how the current two-request version looks in the official docs:
This particular example was not correctly parsed by the request converter. I have fixed it to match what the description of the example says.