Skip to content
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

Merged
merged 7 commits into from
Nov 12, 2020

Conversation

noahtalerman
Copy link
Member

@noahtalerman noahtalerman commented Nov 11, 2020

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.

…o created rest-endpoint page in docs to document answers to users' questions about the api.
@noahtalerman noahtalerman added :improve documentation Involves writing improvements or additions to documentation and removed :improve documentation Involves writing improvements or additions to documentation labels Nov 11, 2020
@noahtalerman noahtalerman changed the title 3 question/answer stubs added to docs for roundup 11/11/2020. Beginning of REST API documentation. Added info for /hosts endpoint. additional param TODO Nov 11, 2020
@noahtalerman noahtalerman changed the title Beginning of REST API documentation. Added info for /hosts endpoint. additional param TODO Beginning of REST API documentation. Added info for /hosts endpoint. Nov 11, 2020
@noahtalerman
Copy link
Member Author

noahtalerman commented Nov 11, 2020

@billcobbler seeing that #28 is in the process of being approved, it would be awesome if you could throw a description for the additional_info_filters param in the parameters table in this new documentation.

The parameters table:

Name Type In Description
page integer query Page number of the results to fetch.
per_page integer query Results per page.
order_key string query What to order results by. Can be any column in the hosts table.
additional_info_filters string query TODO

Feel free to respond to this comment with your description as well!

Copy link
Member

@mikermcneil mikermcneil left a 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

@billcobbler
Copy link
Contributor

👍 for this PR!

additional_info_filters: a comma delimited list of fields to include in each host's additional information object.

Ideally it'd include a link to the 'additional' host info feature, but I don't see that documented anywhere.

@noahtalerman
Copy link
Member Author

noahtalerman commented Nov 12, 2020

Sweet! Thank you for the quick response.

Ideally it'd include a link to the 'additional' host info feature, but I don't see that documented anywhere.

Noted. The 'additional' host info feature receives an explanation in the below section of the docs, but could receive a more thorough explanation.
https://github.com/fleetdm/fleet/blob/master/docs/cli/file-format.md#fleet-configuration-options

Copy link
Member

@zwass zwass left a 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.

@noahtalerman noahtalerman merged commit 227f854 into fleetdm:master Nov 12, 2020
@noahtalerman noahtalerman deleted the metrics-docs branch November 12, 2020 20:22
chiiph pushed a commit that referenced this pull request Aug 4, 2021
Per [godoc](https://pkg.go.dev/os#IsNotExist), this is the preferred method.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants