FileVar uploads collide with REST run parameters

Cerrado
  • ¿Algo no está bien?
#73 1 comentario 0 reacciones 1 asignado Ver en GitHub

Los mantenedores suelen responder en 1 día

@pheus ya está trabajando en esto.

Desde el 3/11/2026.

  • #105 de @pheus — fusionado

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
56/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python
Área
api

Línea de trabajo

Start at the REST run endpoint's multipart request handling and trace how uploaded file parts are separated from execution parameters. The report reproduces collisions for FileVar names commit and data; use its documented multipart requests to check both cases. Done means the endpoint accepts those uploads as variables, keeps run settings separate, and returns HTTP 201 with the file available to the Script.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

app: scripts severity: medium status: accepted type: bug
Plugin Version

v0.0.1

NetBox Version

v4.7.3

Python Version

3.12

Steps to Reproduce
  1. Create a Script Project for uploaded files, upload the following Script, and activate its revision: 
    from netbox_scripts.scripts import FileVar, Script


class TakesNamedFile(Script):
    commit = FileVar(label='Named file')

    def run(self, data, commit):
        return data['commit'].read().decode()
  2. Create a small notes.txt file and request a run using the documented multipart format. Replace <id> with the Script's ID: 
    printf 'hello\n' > notes.txt

curl -i -sS -X POST \
  -H "Authorization: Token $NETBOX_TOKEN" \
  -F 'data={}' \
  -F [email protected] \
  'https://netbox.example.com/api/plugins/netbox-scripts/scripts/<id>/run/'
Expected Behavior

The request returns HTTP 201 and queues the Script with the uploaded file in data['commit']. The file variable is kept separate from the run's commit setting.

The REST execution guide documents file parts named after their variables and separates variable values from execution parameters.

Observed Behavior

The request returns HTTP 400:

{"commit": ["Must be a valid boolean."]}

A FileVar named data, sent alongside the JSON data part, similarly returns:

{"data": ["Value must be valid JSON."]}

The endpoint reads the uploaded file as the top-level run parameter with the same name.

This affects request handling and is separate from the OpenAPI schema change in #16.

Lenguaje dominante
Python
Estrellas
8
Forks
0
Merge medio
11 h 22 min
PR fusionados (30 d)
40

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de netbox-community/netbox-scripts

Todos los issues de netbox-community/netbox-scripts

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.