Skip to content

[API updates] Fleet Desktop > Self-service: categories & updates #27681

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

Open
wants to merge 2 commits into
base: docs-v4.68.0
Choose a base branch
from

Conversation

eugkuo
Copy link
Contributor

@eugkuo eugkuo commented Mar 31, 2025

In support of #27245

@@ -9241,6 +9241,7 @@ Returns information about the specified software. By default, `versions` are sor
"software_package": {
"name": "FalconSensor-6.44.pkg",
"version": "6.44",
"category": "utilities",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIRC we decided that a software title could belong to multiple categories?

Also, we should confirm whether/how categories vary, as that will determine where this gets put. Where it is right now would mean that categories are set per-team, which is probably fine, and we'd also need this indicated on app store apps, which is a little awkward from an API perspective as there are two places to look for the values but not the end of the world.

Semi-finally, are we using slugs for categories (like you're doing here) or display names? If slugs, how are we mapping to display names? Thinking we need a GET endpoint (/fleet/software/categories) for this list. We'll also want filtering by category (any-of search via comma-delimited list) on /fleet/device/{token}/software . Filtering by category would require self_service to be set since we have undefined/unclear behavior otherwise.

Finally, we may want to add category filtering on the /fleet/software/titles endpoint. If we did this for we would want to require self_service or available_for_install to be set in order to filter by category for similar reasons to requiring self_service on the device endpoint.

@iansltx iansltx force-pushed the eugkuo-patch-4-add-categories branch from bcf5c4f to 2f17e50 Compare April 11, 2025 06:15
@iansltx iansltx changed the base branch from main to docs-v4.68.0 April 11, 2025 06:15
@iansltx iansltx marked this pull request as ready for review April 11, 2025 14:34
@iansltx iansltx requested a review from rachaelshaw as a code owner April 11, 2025 14:34
Copy link
Member

@rachaelshaw rachaelshaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple things I think we should add for clarity:

  • It'd be nice to actually create the list of categories somewhere in the docs, and link to it in the parameter tables. (Is there a self-service guide we can add it to, and link there?)
  • Are these case-sensitive? If so, we should specify that.

@iansltx
Copy link
Member

iansltx commented Apr 11, 2025

@rachaelshaw We do have a self-service guide.

These would not be case-sensitive since we'd be matching = on name in the DB.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants