-
Notifications
You must be signed in to change notification settings - Fork 74
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
Adds cluster API example requests and responses #2870
Conversation
Following you can find the validation results for the APIs you have changed.
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.
LGTM. Let me know if you want me to add the updates to the overlay files in this same PR
450a8d0
to
8d1dc45
Compare
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
1 similar comment
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
337e8b3
to
7aa6369
Compare
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
I added a *.yaml file to this PR for your consideration. Right now all the *.json examples are returning linting errors like this:
I tried converting the example to a YAML file then commenting out the extra fields (since yaml allows comments whereas json doesn't). This succeeds in solving the linting errors (since the comment fields are not carried forward to the output). Is this acceptable to use YAML instead of JSON format and is it okay to comment out those extra fields? |
Co-authored-by: lcawl <lcawley@elastic.co>
Overview
Related to #2482.
This PR adds request and response examples to the cluster APIs.