Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-04-21 21:47:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 117
fleet/server/service/handler_deprecated_paths.go
Scott Gress 647612345c
Deprecate URLs with "team" and "query" terminology (#40520) 
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #40519

# Details

This PR adds a new system for registering deprecated URLs separately
from the main URLs (i.e. not clogging up `handler.go` with a bunch of
`.WithAltPaths()` or similar. It uses a registry that's shared between
all the different endpointer, which is then iterated over and a new
handler is created for the deprecated endpoint which stores info about
the deprecation (the old and new URLs) in the context. A new middleware
looks for that context info and, if found, logs a deprecation warning
(if the topic is enabled).

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

- [ ] 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.
no need for a changelog as we are not logging the warnings by default

## Testing

- [X] Added/updated automated tests
- [X] QA'd all new/changed functionality manually

* Verified that going to `/teams` with
`--logging_enable_topics=deprecated-field-names` got me this log:
```
deprecated_path=/api/_version_/fleet/teams deprecation_warning="API `/api/_version_/fleet/teams` is deprecated, use `/api/_version_/fleet/fleets` instead
```
* Going to `/fleets` with that flag enabled resulted in no deprecation
log
* Going to `/teams` _without_ the flag enabled resulted in no
deprecation log
2026-02-25 22:20:35 -06:00

223 lines
8.1 KiB
Go
Raw Blame History

package service
import (
eu "github.com/fleetdm/fleet/v4/server/platform/endpointer"
)
// deprecatedPathAliases defines deprecated URL path aliases that map old
// (deprecated) paths to their canonical (primary) paths. Each entry causes
// the deprecated path(s) to serve the same handler as the primary path.
//
// These are organized by category:
// - teams → fleets: team CRUD, secrets, agent_options, users, spec
// - team/teams → fleets: policies, schedule (both singular and plural deprecated)
// - queries → reports: query CRUD, spec, report data
// - host queries → reports
// - live queries → reports: run, run_by_identifiers, run_by_names
// - ABM/VPP token teams → fleets
var deprecatedPathAliases = []eu.DeprecatedPathAlias{
// ---- teams → fleets ----
{
Method: "POST", PrimaryPath: "/api/_version_/fleet/spec/fleets",
DeprecatedPaths: []string{"/api/_version_/fleet/spec/teams"},
},
{
Method: "PATCH", PrimaryPath: "/api/_version_/fleet/fleets/{fleet_id:[0-9]+}/secrets",
DeprecatedPaths: []string{"/api/_version_/fleet/teams/{fleet_id:[0-9]+}/secrets"},
},
{
Method: "POST", PrimaryPath: "/api/_version_/fleet/fleets",
DeprecatedPaths: []string{"/api/_version_/fleet/teams"},
},
{
Method: "GET", PrimaryPath: "/api/_version_/fleet/fleets",
DeprecatedPaths: []string{"/api/_version_/fleet/teams"},
},
{
Method: "GET", PrimaryPath: "/api/_version_/fleet/fleets/{id:[0-9]+}",
DeprecatedPaths: []string{"/api/_version_/fleet/teams/{id:[0-9]+}"},
},
{
Method: "PATCH", PrimaryPath: "/api/_version_/fleet/fleets/{id:[0-9]+}",
DeprecatedPaths: []string{"/api/_version_/fleet/teams/{id:[0-9]+}"},
},
{
Method: "DELETE", PrimaryPath: "/api/_version_/fleet/fleets/{id:[0-9]+}",
DeprecatedPaths: []string{"/api/_version_/fleet/teams/{id:[0-9]+}"},
},
{
Method: "POST", PrimaryPath: "/api/_version_/fleet/fleets/{id:[0-9]+}/agent_options",
DeprecatedPaths: []string{"/api/_version_/fleet/teams/{id:[0-9]+}/agent_options"},
},
{
Method: "GET", PrimaryPath: "/api/_version_/fleet/fleets/{id:[0-9]+}/users",
DeprecatedPaths: []string{"/api/_version_/fleet/teams/{id:[0-9]+}/users"},
},
{
Method: "PATCH", PrimaryPath: "/api/_version_/fleet/fleets/{id:[0-9]+}/users",
DeprecatedPaths: []string{"/api/_version_/fleet/teams/{id:[0-9]+}/users"},
},
{
Method: "DELETE", PrimaryPath: "/api/_version_/fleet/fleets/{id:[0-9]+}/users",
DeprecatedPaths: []string{"/api/_version_/fleet/teams/{id:[0-9]+}/users"},
},
{
Method: "GET", PrimaryPath: "/api/_version_/fleet/fleets/{id:[0-9]+}/secrets",
DeprecatedPaths: []string{"/api/_version_/fleet/teams/{id:[0-9]+}/secrets"},
},
// ---- team/teams → fleets (policies) ----
{
Method: "POST", PrimaryPath: "/api/_version_/fleet/fleets/{fleet_id}/policies",
DeprecatedPaths: []string{
"/api/_version_/fleet/team/{fleet_id}/policies",
"/api/_version_/fleet/teams/{fleet_id}/policies",
},
},
{
Method: "GET", PrimaryPath: "/api/_version_/fleet/fleets/{fleet_id}/policies",
DeprecatedPaths: []string{
"/api/_version_/fleet/team/{fleet_id}/policies",
"/api/_version_/fleet/teams/{fleet_id}/policies",
},
},
{
Method: "GET", PrimaryPath: "/api/_version_/fleet/fleets/{fleet_id}/policies/count",
DeprecatedPaths: []string{
"/api/_version_/fleet/team/{fleet_id}/policies/count",
"/api/_version_/fleet/teams/{fleet_id}/policies/count",
},
},
{
Method: "GET", PrimaryPath: "/api/_version_/fleet/fleets/{fleet_id}/policies/{policy_id}",
DeprecatedPaths: []string{
"/api/_version_/fleet/team/{fleet_id}/policies/{policy_id}",
"/api/_version_/fleet/teams/{fleet_id}/policies/{policy_id}",
},
},
{
Method: "POST", PrimaryPath: "/api/_version_/fleet/fleets/{fleet_id}/policies/delete",
DeprecatedPaths: []string{
"/api/_version_/fleet/team/{fleet_id}/policies/delete",
"/api/_version_/fleet/teams/{fleet_id}/policies/delete",
},
},
{
Method: "PATCH", PrimaryPath: "/api/_version_/fleet/fleets/{fleet_id}/policies/{policy_id}",
DeprecatedPaths: []string{"/api/_version_/fleet/teams/{fleet_id}/policies/{policy_id}"},
},
// ---- queries → reports ----
{
Method: "GET", PrimaryPath: "/api/_version_/fleet/reports/{id:[0-9]+}",
DeprecatedPaths: []string{"/api/_version_/fleet/queries/{id:[0-9]+}"},
},
{
Method: "GET", PrimaryPath: "/api/_version_/fleet/reports",
DeprecatedPaths: []string{"/api/_version_/fleet/queries"},
},
{
Method: "GET", PrimaryPath: "/api/_version_/fleet/reports/{id:[0-9]+}/report",
DeprecatedPaths: []string{"/api/_version_/fleet/queries/{id:[0-9]+}/report"},
},
{
Method: "POST", PrimaryPath: "/api/_version_/fleet/reports",
DeprecatedPaths: []string{"/api/_version_/fleet/queries"},
},
{
Method: "PATCH", PrimaryPath: "/api/_version_/fleet/reports/{id:[0-9]+}",
DeprecatedPaths: []string{"/api/_version_/fleet/queries/{id:[0-9]+}"},
},
{
Method: "DELETE", PrimaryPath: "/api/_version_/fleet/reports/{name}",
DeprecatedPaths: []string{"/api/_version_/fleet/queries/{name}"},
},
{
Method: "DELETE", PrimaryPath: "/api/_version_/fleet/reports/id/{id:[0-9]+}",
DeprecatedPaths: []string{"/api/_version_/fleet/queries/id/{id:[0-9]+}"},
},
{
Method: "POST", PrimaryPath: "/api/_version_/fleet/reports/delete",
DeprecatedPaths: []string{"/api/_version_/fleet/queries/delete"},
},
{
Method: "POST", PrimaryPath: "/api/_version_/fleet/spec/reports",
DeprecatedPaths: []string{"/api/_version_/fleet/spec/queries"},
},
{
Method: "GET", PrimaryPath: "/api/_version_/fleet/spec/reports",
DeprecatedPaths: []string{"/api/_version_/fleet/spec/queries"},
},
{
Method: "GET", PrimaryPath: "/api/_version_/fleet/spec/reports/{name}",
DeprecatedPaths: []string{"/api/_version_/fleet/spec/queries/{name}"},
},
// ---- host queries → reports ----
{
Method: "GET", PrimaryPath: "/api/_version_/fleet/hosts/{id:[0-9]+}/reports/{report_id:[0-9]+}",
DeprecatedPaths: []string{"/api/_version_/fleet/hosts/{id:[0-9]+}/queries/{report_id:[0-9]+}"},
},
// ---- live queries → reports ----
{
Method: "POST", PrimaryPath: "/api/_version_/fleet/reports/{id:[0-9]+}/run",
DeprecatedPaths: []string{"/api/_version_/fleet/queries/{id:[0-9]+}/run"},
},
{
Method: "GET", PrimaryPath: "/api/_version_/fleet/reports/run",
DeprecatedPaths: []string{"/api/_version_/fleet/queries/run"},
},
{
Method: "POST", PrimaryPath: "/api/_version_/fleet/reports/run",
DeprecatedPaths: []string{"/api/_version_/fleet/queries/run"},
},
{
Method: "POST", PrimaryPath: "/api/_version_/fleet/reports/run_by_identifiers",
DeprecatedPaths: []string{"/api/_version_/fleet/queries/run_by_identifiers"},
},
{
Method: "POST", PrimaryPath: "/api/_version_/fleet/reports/run_by_names",
DeprecatedPaths: []string{"/api/_version_/fleet/queries/run_by_names"},
},
// ---- team/teams → fleets (schedule) ----
{
Method: "GET", PrimaryPath: "/api/_version_/fleet/fleets/{fleet_id}/schedule",
DeprecatedPaths: []string{
"/api/_version_/fleet/team/{fleet_id}/schedule",
"/api/_version_/fleet/teams/{fleet_id}/schedule",
},
},
{
Method: "POST", PrimaryPath: "/api/_version_/fleet/fleets/{fleet_id}/schedule",
DeprecatedPaths: []string{
"/api/_version_/fleet/team/{fleet_id}/schedule",
"/api/_version_/fleet/teams/{fleet_id}/schedule",
},
},
{
Method: "PATCH", PrimaryPath: "/api/_version_/fleet/fleets/{fleet_id}/schedule/{report_id}",
DeprecatedPaths: []string{
"/api/_version_/fleet/team/{fleet_id}/schedule/{report_id}",
"/api/_version_/fleet/teams/{fleet_id}/schedule/{report_id}",
},
},
{
Method: "DELETE", PrimaryPath: "/api/_version_/fleet/fleets/{fleet_id}/schedule/{report_id}",
DeprecatedPaths: []string{
"/api/_version_/fleet/team/{fleet_id}/schedule/{report_id}",
"/api/_version_/fleet/teams/{fleet_id}/schedule/{report_id}",
},
},
// ---- ABM/VPP token teams → fleets ----
{
Method: "PATCH", PrimaryPath: "/api/_version_/fleet/abm_tokens/{id:[0-9]+}/fleets",
DeprecatedPaths: []string{"/api/_version_/fleet/abm_tokens/{id:[0-9]+}/teams"},
},
{
Method: "PATCH", PrimaryPath: "/api/_version_/fleet/vpp_tokens/{id}/fleets",
DeprecatedPaths: []string{"/api/_version_/fleet/vpp_tokens/{id}/teams"},
},
}
Reference in a new issue View git blame Copy permalink