-
Notifications
You must be signed in to change notification settings - Fork 114
Add overlay for simplified Duration data type #5407
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
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 |
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.
Preview looks good to me, but I guess it would be nice to indicate potential valid values, but sounds like a can of worms per the Slack discussion. It's at least nice to remove the implication that it only accepts -1 or 0.
(cherry picked from commit 1c92db2)
(cherry picked from commit 1c92db2)
(cherry picked from commit 1c92db2)
(cherry picked from commit 1c92db2)
This PR adds an overlay to change the definition for the Duration data type in the OpenAPI files that are used for docs.
It was:
This PR changes it to:
The reason for the change is that the way it's currently rendered in the documentation, it looks like "-1" and "0" are the only valid options:
For example in https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-analyze
With this overlay in place, the output is as follows: