fleetdm / fleet

Open-source platform for IT, security, and infrastructure teams. (Linux, macOS, Chrome, Windows, cloud, data center)
https://fleetdm.com
Other
3.12k stars 431 forks source link

Update "Resend host's configuration profile" API URL #21795

Open rachaelshaw opened 2 months ago

rachaelshaw commented 2 months ago

Goal

User story
As an API user working with the "Resend host's configuration profile" endpoint,
I want to see the profile UUID directly after /configuration_profiles/ in the URL
so that I can immediately see what type of thing the UUID identifies.

Objective

None. Not tied to a quarterly objective.

@noahtalerman: Why are we prioritizing it? Why are we working on it? Fleet will always take on small, iterative UX improvements when we have the space. Key is making is small.

Context

Changes

Product

Engineering

ℹ️  Please read this issue carefully and understand it. Pay special attention to UI wireframes, especially "dev notes".

QA

Risk assessment

Manual testing steps

  1. Step 1
  2. Step 2
  3. Step 3

Testing notes

Confirmation

  1. [ ] Engineer (@____): Added comment to user story confirming successful completion of QA.
  2. [ ] QA (@____): Added comment to user story confirming successful completion of QA.
noahtalerman commented 1 month ago

Hey @rachaelshaw, because we filed this request and thus understand it enough to update the issue description, I pulled this issue onto the drafting board and assigned you. (as opposed to customer requests that we now leave in feature request format and peel users stories off of).

When you get to this one, please feel free to update the issue description into user story format.

rachaelshaw commented 1 month ago

Original request:

Problem

The URL pattern for Resend host's configuration profile doesn't match the API convention we're using elsewhere, where the identifier in the URL comes directly after the thing it's identifying (for example: /software/:software_title_id/install versus /software/install/:software_title_id, as designed here).

Potential solutions

Update documented URL to be POST /api/v1/fleet/hosts/:id/configuration_profiles/resend/:profile_uuid and maintain a redirect for the old URL for backwards compatibility.