[API/YAML] Docs for new setup experience script PUT endpoint - #35736
Merged
Conversation
JordanMontgomery
had a problem deploying
to
Docker Hub
November 14, 2025 00:46 — with 
GitHub Actions
Error
GitHub Actions
Error
JordanMontgomery
temporarily deployed
to
Docker Hub
November 14, 2025 00:52 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
6 tasks
JordanMontgomery
marked this pull request as ready for review
November 14, 2025 01:03
JordanMontgomery
temporarily deployed
to
Docker Hub
November 14, 2025 15:09 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
| ## Software and script | ||
|
|
||
| > As of Fleet 4.59.0, there is a known bug in which, if [GitOps](https://fleetdm.com/docs/configuration/yaml-files) runs while a new Mac is going through Setup Assistant, the script will not run. Follow the [GitHub issue](https://github.com/fleetdm/fleet/issues/35309) to learn more. | ||
| > In Fleet versions prior to 4.76.1, there is a known bug in which, if [GitOps](https://fleetdm.com/docs/configuration/yaml-files) runs while a new Mac is going through Setup Assistant, the script will not run. Follow the [GitHub issue](https://github.com/fleetdm/fleet/issues/35309) to learn more. |
Member
Author
There was a problem hiding this comment.
@noahtalerman I think we're still planning to ship this as v4.76.1 right? Does this updated verbiage make sense? do we even need this anymore?
Member
There was a problem hiding this comment.
You're referring to this bug fix right? Looks like it's targeted for 4.76.1 👍
Good catch.
I think we can remove this entirely. Same for the YAML reference: https://github.com/fleetdm/fleet/pull/35736/files#diff-b71104232d8fbaaf4bd537065533cbf39ec5f9bf028ec1d8083346953ed5178dR454
JordanMontgomery
added a commit
that referenced
this pull request
Nov 14, 2025
<!-- Add the related story/sub-task/bug number, like Resolves #123, or remove if NA --> **Related issue:** Resolves #35309 Related doc update #35736 Adds a PUT endpoint for setting setup experience scripts, as opposed to the current POST implementation(which errors if the script is already set, which is why gitops calls DELETE first every time). If the contents change, the new endpoint has the same effect as DELETE then POST today, however if the contents are unchanged no changes occur, allowing gitops runs to avoid cancelling script executions. Also switched gitops over to the new PUT endpoint and removed the DELETE in the "set" path. # Checklist for submitter If some of the following don't apply, delete the relevant line. - [x] Changes file added for user-visible changes in `changes/`, `orbit/changes/` or `ee/fleetd-chrome/changes`. See [Changes files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/committing-changes.md#changes-files) for more information. - [x] Input data is properly validated, `SELECT *` is avoided, SQL injection is prevented (using placeholders for values in statements) - [x] If paths of existing endpoints are modified without backwards compatibility, checked the frontend/CLI for any necessary changes ## Testing - [x] Added/updated automated tests - [x] Where appropriate, [automated tests simulate multiple hosts and test for host isolation](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/reference/patterns-backend.md#unit-testing) (updates to one hosts's records do not affect another) - [ ] QA'd all new/changed functionality manually
georgekarrv
pushed a commit
that referenced
this pull request
Nov 14, 2025
<!-- Add the related story/sub-task/bug number, like Resolves #123, or remove if NA --> **Related issue:** Resolves #35309 Related doc update #35736 Adds a PUT endpoint for setting setup experience scripts, as opposed to the current POST implementation(which errors if the script is already set, which is why gitops calls DELETE first every time). If the contents change, the new endpoint has the same effect as DELETE then POST today, however if the contents are unchanged no changes occur, allowing gitops runs to avoid cancelling script executions. Also switched gitops over to the new PUT endpoint and removed the DELETE in the "set" path. # Checklist for submitter If some of the following don't apply, delete the relevant line. - [x] Changes file added for user-visible changes in `changes/`, `orbit/changes/` or `ee/fleetd-chrome/changes`. See [Changes files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/committing-changes.md#changes-files) for more information. - [x] Input data is properly validated, `SELECT *` is avoided, SQL injection is prevented (using placeholders for values in statements) - [x] If paths of existing endpoints are modified without backwards compatibility, checked the frontend/CLI for any necessary changes ## Testing - [x] Added/updated automated tests - [x] Where appropriate, [automated tests simulate multiple hosts and test for host isolation](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/reference/patterns-backend.md#unit-testing) (updates to one hosts's records do not affect another) - [ ] QA'd all new/changed functionality manually
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
JordanMontgomery
had a problem deploying
to
Docker Hub
November 14, 2025 19:26 — with
GitHub Actions
Error
GitHub Actions
Error
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
JordanMontgomery
had a problem deploying
to
Docker Hub
November 14, 2025 19:27 — with
GitHub Actions
Error
GitHub Actions
Error
JordanMontgomery
temporarily deployed
to
Docker Hub
November 14, 2025 19:28 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
noahtalerman
approved these changes
Nov 14, 2025
noahtalerman
added a commit
that referenced
this pull request
Nov 14, 2025
PR the made the changes: #35736 Context: https://fleetdm.slack.com/archives/C09PMPZ5YGH/p1763159136256149?thread_ts=1763137797.536439&cid=C09PMPZ5YGH
JordanMontgomery
added a commit
that referenced
this pull request
Nov 18, 2025
<!-- Add the related story/sub-task/bug number, like Resolves #123, or remove if NA --> **Related issue:** Resolves #35309 Related doc update #35736 Adds a PUT endpoint for setting setup experience scripts, as opposed to the current POST implementation(which errors if the script is already set, which is why gitops calls DELETE first every time). If the contents change, the new endpoint has the same effect as DELETE then POST today, however if the contents are unchanged no changes occur, allowing gitops runs to avoid cancelling script executions. Also switched gitops over to the new PUT endpoint and removed the DELETE in the "set" path. # Checklist for submitter If some of the following don't apply, delete the relevant line. - [x] Changes file added for user-visible changes in `changes/`, `orbit/changes/` or `ee/fleetd-chrome/changes`. See [Changes files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/committing-changes.md#changes-files) for more information. - [x] Input data is properly validated, `SELECT *` is avoided, SQL injection is prevented (using placeholders for values in statements) - [x] If paths of existing endpoints are modified without backwards compatibility, checked the frontend/CLI for any necessary changes ## Testing - [x] Added/updated automated tests - [x] Where appropriate, [automated tests simulate multiple hosts and test for host isolation](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/reference/patterns-backend.md#unit-testing) (updates to one hosts's records do not affect another) - [ ] QA'd all new/changed functionality manually
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
API changes for #35309
Also updates bug notes to call out fixed version.
Related PR #35651