Beginning of REST API documentation. Added info for /hosts endpoint.#29
Beginning of REST API documentation. Added info for /hosts endpoint.#29noahtalerman merged 7 commits intofleetdm:masterfrom
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! |
mikermcneil
left a comment
There was a problem hiding this comment.
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."
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
/hostsendpoint.A description is needed in the 'additional_info_filters' row of the parameters markdown table.