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

Remove requirement for image dimensions in API #10043

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

Originally created by @llamafilm on GitHub (Aug 2, 2024).

Originally assigned to: @bctiemann on GitHub.

NetBox version

v4.0.8

Feature type

Change to existing functionality

Proposed functionality

When uploading an image attachment via API, it should not require image_height and image_width fields. These should be calculated automatically, as they are when uploading using the GUI. Actually this already works, if you provide incorrect values (any integer) they will be ignored, and Netbox figures out the correct dimensions.

As an example, I'd like to use code like this:

files = { 'image': open(filename, 'rb') }
payload = {
    'name': filename,
    'object_id': 454,
    'object_type': 'dcim.site'
}
url = f'{base_url}/api/extras/image-attachments/'
req = requests.post(url, headers=headers, files=files, data=payload)

This currently fails with 400: {"image_height":["This field is required."],"image_width":["This field is required."]}

Use case

Calculating image dimensions requires extra work, and Netbox is already capable of doing this automatically, as it does when you upload using the GUI.

Database changes

none

External dependencies

No response

Originally created by @llamafilm on GitHub (Aug 2, 2024). Originally assigned to: @bctiemann on GitHub. ### NetBox version v4.0.8 ### Feature type Change to existing functionality ### Proposed functionality When uploading an image attachment via API, it should not require `image_height` and `image_width` fields. These should be calculated automatically, as they are when uploading using the GUI. Actually this already works, if you provide incorrect values (any integer) they will be ignored, and Netbox figures out the correct dimensions. As an example, I'd like to use code like this: ```py files = { 'image': open(filename, 'rb') } payload = { 'name': filename, 'object_id': 454, 'object_type': 'dcim.site' } url = f'{base_url}/api/extras/image-attachments/' req = requests.post(url, headers=headers, files=files, data=payload) ``` This currently fails with 400: `{"image_height":["This field is required."],"image_width":["This field is required."]}` ### Use case Calculating image dimensions requires extra work, and Netbox is already capable of doing this automatically, as it does when you upload using the GUI. ### Database changes none ### External dependencies _No response_
adam added the type: bugstatus: acceptedseverity: low labels 2025-12-29 21:26:07 +01:00
adam closed this issue 2025-12-29 21:26:07 +01:00
adam commented 2025-12-29 21:26:08 +01:00
Author
Owner
Copy Link

@llamafilm commented on GitHub (Aug 2, 2024):

By the way, the same operation can be done in python without specifying dimensions:

from django.contrib.contenttypes.models import ContentType
from django.core.files.base import File
i = ImageAttachment(
    object_type=ContentType.objects.get(app_label='dcim', model='location'),
    object_id=14588,
    image=File(open('/tmp/image.png', 'rb')),
    name='my file'
)
i.full_clean()
i.save()
@llamafilm commented on GitHub (Aug 2, 2024): By the way, the same operation can be done in python without specifying dimensions: ```py from django.contrib.contenttypes.models import ContentType from django.core.files.base import File i = ImageAttachment( object_type=ContentType.objects.get(app_label='dcim', model='location'), object_id=14588, image=File(open('/tmp/image.png', 'rb')), name='my file' ) i.full_clean() i.save() ```
adam commented 2025-12-29 21:26:08 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Aug 22, 2024):

Reclassifying this as a bug, as those fields should not be required.

@jeremystretch commented on GitHub (Aug 22, 2024): Reclassifying this as a bug, as those fields should not be required.
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 severity: low status: accepted type: bug
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#10043
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?