Missing api documentation for "POST /api/extras/scripts/" request #9907

New Issue

adam · 2025-12-29T21:24:15+01:00

adam commented

2025-12-29 21:24:15 +01:00

Originally created by @ngotzmann on GitHub (Jun 26, 2024).

Deployment Type

Self-hosted

NetBox Version

v4.0.5

Python Version

3.11

Steps to Reproduce

Go to https://demo.netbox.dev/api/schema/swagger-ui/#/extras/extras_scripts_create or your self hosted
1.1. Under "Parameters", you will notice there are no parameters
Trying to call the api endpoint without body, will result in an error (who would have expected this 😄 )
I used following curl command:

curl -X 'POST' \
  'https://netbox/api/extras/scripts/' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Token XXX" \
  -d ''

Expected Behavior

Having all fields available on this endpoint documented

Observed Behavior

{
  "error": "null value in column \"module_id\" of relation \"extras_script\" violates not-null constraint\nDETAIL:  Failing row contains (19, , null, t).",
  "exception": "IntegrityError",
  "netbox_version": "4.0.5",
  "python_version": "3.11.2"
}

Originally created by @ngotzmann on GitHub (Jun 26, 2024). ### Deployment Type Self-hosted ### NetBox Version v4.0.5 ### Python Version 3.11 ### Steps to Reproduce 1. Go to https://demo.netbox.dev/api/schema/swagger-ui/#/extras/extras_scripts_create or your self hosted 1.1. Under "Parameters", you will notice there are no parameters 2. Trying to call the api endpoint without body, will result in an error (who would have expected this :smile: ) 3. I used following curl command: ```bash curl -X 'POST' \ 'https://netbox/api/extras/scripts/' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H "Authorization: Token XXX" \ -d '' ``` ### Expected Behavior Having all fields available on this endpoint documented ### Observed Behavior ```bash { "error": "null value in column \"module_id\" of relation \"extras_script\" violates not-null constraint\nDETAIL: Failing row contains (19, , null, t).", "exception": "IntegrityError", "netbox_version": "4.0.5", "python_version": "3.11.2" } ```

adam added the type: bug status: duplicate topic: OpenAPI labels 2025-12-29 21:24:15 +01:00

adam closed this issue

2025-12-29 21:24:15 +01:00

adam commented

2025-12-29 21:24:16 +01:00

@jeffgdotorg commented on GitHub (Jun 27, 2024):

Thanks for reporting a problem in NetBox.

I've reproduced the problem in a fresh install of NetBox v4.0.6. With a little bit of lateral exploring I'm finding the lack of parameter documentation is not unique to extras/scripts; for example, extras_tags_create also lacks parameter documentation, though POSTing to that endpoint with an empty body provides useful feedback rather than an internal server error.

I'm moving your issue out of triage and into needs owner status. If you or another developer with the requisite skills and capacity would like to work it through to a PR, please say so and a maintainer will assign the issue to you.

@jeffgdotorg commented on GitHub (Jun 27, 2024): Thanks for reporting a problem in NetBox. I've reproduced the problem in a fresh install of NetBox v4.0.6. With a little bit of lateral exploring I'm finding the lack of parameter documentation is not unique to `extras/scripts`; for example, `extras_tags_create` also lacks parameter documentation, though POSTing to that endpoint with an empty body provides useful feedback rather than an internal server error. I'm moving your issue out of triage and into `needs owner` status. If you or another developer with the requisite skills and capacity would like to work it through to a PR, please say so and a maintainer will assign the issue to you.

adam commented

2025-12-29 21:24:16 +01:00

@arthanson commented on GitHub (Jul 12, 2024):

Closing this as duplicate of #16670

@arthanson commented on GitHub (Jul 12, 2024): Closing this as duplicate of #16670

Sign in to join this conversation.

Branches Tags

main

feature

release-v4.5.5

21578-prefix-import-scope

19034-rackreservation-unit-count

21556-fix-dropdown-clearing

20152-support-for-marking-module-bays-and-device-bays-as-disabled

21157-export-template-public-models

21357-register-model-actions

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21203-q-attr-denorm

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

v4.5-beta1-release

7604-filter-modifiers-v3

12318-case-insensitive-uniqueness

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#9907