starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Add APIs that use unique slug instead of ID #458

New Issue
Closed
opened 2025-12-29 16:22:21 +01:00 by adam · 2 comments
adam commented 2025-12-29 16:22:21 +01:00
Owner
Copy Link

Originally created by @dqminh on GitHub (Sep 30, 2016).

I dont feel like uniquely generated ID is the right abstraction for restful API given that most entities already have unique human-readable name (i.e. slug/name etc.). I think being able to use slug as part of the queries to identify resources instead of IDs would improve the API.

Since we already have API with ids, wdyt about adding api_prefix/slug/<slug> for this ?

Originally created by @dqminh on GitHub (Sep 30, 2016). I dont feel like uniquely generated ID is the right abstraction for restful API given that most entities already have unique human-readable name (i.e. slug/name etc.). I think being able to use slug as part of the queries to identify resources instead of IDs would improve the API. Since we already have API with ids, wdyt about adding `api_prefix/slug/<slug>` for this ?
adam closed this issue 2025-12-29 16:22:21 +01:00
adam commented 2025-12-29 16:22:22 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Oct 4, 2016):

Adding entry points for slugs duplicates much of the API. This also leads to inconsistencies as not all objects have slugs. Slugs were only implemented in the web UI to make the URLs a bit easier to understand at a glance.

@jeremystretch commented on GitHub (Oct 4, 2016): Adding entry points for slugs duplicates much of the API. This also leads to inconsistencies as not all objects have slugs. Slugs were only implemented in the web UI to make the URLs a bit easier to understand at a glance.
adam commented 2025-12-29 16:22:22 +01:00
Author
Owner
Copy Link

@dqminh commented on GitHub (Oct 5, 2016):

@jeremystretch thanks. Duplicating the api is certainly one valid reason. This is not too important now actually so i will close the issue.

@dqminh commented on GitHub (Oct 5, 2016): @jeremystretch thanks. Duplicating the api is certainly one valid reason. This is not too important now actually so i will close the issue.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#458
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?