API design: Self-service: Install Apple App Store apps on macOS #22102
Conversation
| | ---- | ------- | ---- | -------------------------------------------- | | ||
| | software_title_id | integer | path | **Required**. The ID of the software title to download software package.| | ||
| | team_id | integer | query | **Required**. The team ID. Downloads a software package added to the specified team. | | ||
| | alt | integer | query | **Required**. If specified and set to "media", downloads the specified software package. | |
There was a problem hiding this comment.
What happens if you set it to something else?
There was a problem hiding this comment.
@rachaelshaw We return this error:
There was a problem hiding this comment.
What's the reason for including the alt parameter if it's required & only supports one value? Are we planning on changing this to be a "Get or download" endpoint in the future & making alt optional?
There was a problem hiding this comment.
@rachaelshaw We decided in the past that we'll use alt=media for download. Ideally, it would be "Get or download", but we don't need "Get" in the UI in this case, so that's why we have alt required.
| | ---- | ------- | ---- | -------------------------------------------- | | ||
| | software_title_id | integer | path | **Required**. The ID of the software title to download software package.| | ||
| | team_id | integer | query | **Required**. The team ID. Downloads a software package added to the specified team. | | ||
| | alt | integer | query | **Required**. If specified and set to "media", downloads the specified software package. | |
There was a problem hiding this comment.
What's the reason for including the alt parameter if it's required & only supports one value? Are we planning on changing this to be a "Get or download" endpoint in the future & making alt optional?
Co-authored-by: Rachael Shaw <r@rachael.wtf>
|
Hey @marko-lisica just a heads up that this reference docs PR has merge conflicts. I think we want to get those resolved before Rachael approves otherwise I think we'll have to request another review Please let me know if I can help resolve them! |
marko-lisica
temporarily deployed
to
Docker Hub
GitHub Actions
Inactive
|
@noahtalerman I just resolved the conflict. @rachaelshaw When you get the chance, could you take one more look? |
noahtalerman
had a problem deploying
to
Docker Hub
GitHub Actions
Error
noahtalerman
temporarily deployed
to
Docker Hub
GitHub Actions
Inactive
noahtalerman
temporarily deployed
to
Docker Hub
GitHub Actions
Inactive
| - [Batch-apply packages](#batch-apply-packages) | ||
| - [Batch-apply App Store apps](#batch-apply-app-store-apps) | ||
| - [Get token to download package](#get-token-to-download-package) | ||
| - [Download package using a token](#download-package-using-a-token) |
There was a problem hiding this comment.
@lucasmrod when we merged in reference docs for the 4.57 release, it looks like the batch-apply endpoints got moved to the REST API docs instead of the contributors docs (see here).
I moved them back. When you get the chance, can you please check to see if these changes look right?
Also, I moved the download endpoints here b/c I think they're only for the Fleet UI to use (#21341). The best practice download endpoint for the IT admin to use in automations is here: https://fleetdm.com/docs/rest-api/rest-api#download-package
There was a problem hiding this comment.
I'm super confused. It seems we deliberately moved them from API for contributors to REST API? (here).
There was a problem hiding this comment.
Hmm, I see. I think up to @rachaelshaw.
Rachael re your comment here, are we changing our philosophy? That is, endpoints that fleetctl uses (not best practice for automation use cases) live in API for contributors.
API design for:
Old PR: #19687