-
Notifications
You must be signed in to change notification settings - Fork 468
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
Beginning of REST API documentation. Added info for /hosts endpoint. #29
Conversation
…o created rest-endpoint page in docs to document answers to users' questions about the api.
…ts. Removed changes to updating fleet.
@billcobbler seeing that #28 is in the process of being approved, it would be awesome if you could throw a description for the The parameters table:
Feel free to respond to this comment with your description as well! |
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!
Eventually would be good to document the default behavior if order_key, per_page, and page are not specified but that doesn't need to be part of this PR
👍 for this PR! additional_info_filters: a comma delimited list of fields to include in each host's Ideally it'd include a link to the 'additional' host info feature, but I don't see that documented anywhere. |
Sweet! Thank you for the quick response.
Noted. The 'additional' host info feature receives an explanation in the below section of the docs, but could receive a more thorough explanation. |
…xample with additional information.
Added a hyphen to "comma-delimited."
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.
Looks great! Thank you.
Per [godoc](https://pkg.go.dev/os#IsNotExist), this is the preferred method.
The beginning of REST API documentation for Fleet.
I added information for the
/hosts
endpoint.A description is needed in the 'additional_info_filters' row of the parameters markdown table.