Docs changes for auto-update, pin, rollback#48327
Conversation
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Claude Code Review
This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.
Tip: disable this comment in your organization's Code Review settings.
| "software_title_id": 2234, | ||
| "software_icon_url": "/api/latest/fleet/software/titles/2234/icon?team_id=123", | ||
| "software_display_name": "Crowdstrike Falcon", | ||
| "pinned_version": "149.0.7827.54", |
There was a problem hiding this comment.
@cdcme why pinned_version here? We use version everywhere else in the API/YAML.
|
|
||
| For Fleet-maintained apps, the `software_package` object includes two additional fields: | ||
|
|
||
| - `pinned_version`: The version the app is pinned to — a specific version (e.g. `"149.0.7827.54"`) or a caret major-version constraint (e.g. `"^147"`). Omitted when the app automatically updates to the latest version. |
There was a problem hiding this comment.
Same comment as above. I think it should be version.
There was a problem hiding this comment.
@marko-lisica version is already used on the software_package response object for the active installer's version, so the pin needs a distinct name; pinned_version is the stored pin (which can be ^147 or null), shown alongside version. Inputs (PATCH body, GitOps YAML) use version to set the pin; outputs (this response and the activity) use pinned_version to report it. The docs match what the API emits. Happy to rename if we'd rather change the API, but it'd collide with the existing version field here.
marko-lisica
left a comment
marko-lisica
left a comment
There was a problem hiding this comment.
@cdcme I left few suggestions, otherwise looks good.
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
3 participants
Related issue: Resolves #46728
Docs for auto-update, version pinning, and rollback of Fleet-maintained apps (#38504), shipped in #48293.