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 a data_type field to the CustomField API serializer #5921

New Issue
Closed
opened 2025-12-29 19:34:15 +01:00 by adam · 0 comments
adam commented 2025-12-29 19:34:15 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Jan 10, 2022).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.1.5

Feature type

Change to existing functionality

Proposed functionality

Add a read-only data_type field to the REST API serializer for the custom field model. This will convey the JSON data type being returned by the custom field.

For example, a text, longtext, or url custom field would return a data type of string. The value of this field is inferred entirely from the custom field type; no user input is required or possible.

Use case

This would provide a convenient mechanism by which an API client can "learn" how to process the custom fields without needing to rely on a predefined mapping of field types.

Database changes

No response

External dependencies

No response

Originally created by @jeremystretch on GitHub (Jan 10, 2022). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.1.5 ### Feature type Change to existing functionality ### Proposed functionality Add a read-only `data_type` field to the REST API serializer for the custom field model. This will convey the JSON data type being returned by the custom field. For example, a `text`, `longtext`, or `url` custom field would return a data type of `string`. The value of this field is inferred entirely from the custom field type; no user input is required or possible. ### Use case This would provide a convenient mechanism by which an API client can "learn" how to process the custom fields without needing to rely on a predefined mapping of field types. ### Database changes _No response_ ### External dependencies _No response_
adam added the status: acceptedtype: feature labels 2025-12-29 19:34:15 +01:00
adam closed this issue 2025-12-29 19:34:15 +01:00
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 status: accepted type: feature
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#5921
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?