Skip to content
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

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

Open
15 tasks
rachaelshaw opened this issue Sep 3, 2024 · 2 comments
Open
15 tasks

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

rachaelshaw opened this issue Sep 3, 2024 · 2 comments
Assignees
Labels
#g-endpoint-ops Endpoint ops product group :product Product Design department (shows up on 🦢 Drafting board) story A user story defining an entire feature

Comments

@rachaelshaw
Copy link
Member

rachaelshaw commented Sep 3, 2024

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.

Context

Changes

Product

  • UI changes: N/A
  • CLI (fleetctl) usage changes: N/A
  • YAML changes: N/A
  • REST API changes: PR
    • Note that a redirect from the old URL will be maintained for backwards compatibility, but it will not be documented
  • Fleet's agent (fleetd) changes: N/A
  • Activity changes: N/A
  • Permissions changes: N/A
  • Changes to paid features or tiers: N/A
  • Other reference documentation changes: N/A
  • Once shipped, requester has been notified

Engineering

  • Feature guide changes: TODO
  • Database schema migrations: TODO
  • Load testing: TODO

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

QA

Risk assessment

  • Requires load testing: TODO
  • Risk level: Low / High TODO
  • Risk description: TODO

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.
@rachaelshaw rachaelshaw added :product Product Design department (shows up on 🦢 Drafting board) ~feature fest Will be reviewed at next Feature Fest labels Sep 3, 2024
@rachaelshaw rachaelshaw changed the title Update "Resend configuration profile" API URL Update "Resend host's configuration profile" API URL Sep 3, 2024
@noahtalerman noahtalerman removed the :product Product Design department (shows up on 🦢 Drafting board) label Sep 4, 2024
@noahtalerman noahtalerman added story A user story defining an entire feature :product Product Design department (shows up on 🦢 Drafting board) #g-endpoint-ops Endpoint ops product group and removed ~feature fest Will be reviewed at next Feature Fest labels Sep 18, 2024
@noahtalerman
Copy link
Member

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.

This was referenced Sep 26, 2024
rachaelshaw added a commit that referenced this issue Sep 27, 2024
For #21795

Updates the URL for the "Resend configuration profile" API endpoint.
(The old URL will be maintained for backwards compatibility.)
@rachaelshaw
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
#g-endpoint-ops Endpoint ops product group :product Product Design department (shows up on 🦢 Drafting board) story A user story defining an entire feature
Development

No branches or pull requests

3 participants