Scenario bundle PATCH accepts ?expand=labels but ignores it

Abierto Apto para principiantes
#2,580 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
78/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
django, python
Área
api, backend

Línea de trabajo

Comienza en oekg/api_views.py, en OekgAPIView.initial y en el return bundle_response(...) al final de patch. Compara bundle GET y los demás endpoints de escritura que resuelven labels, y añade una prueba de regresión que muestre que PATCH gestiona ?expand=labels o lo rechaza de forma coherente; se considera terminado cuando la respuesta coincide con el comportamiento elegido.

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

Descripción

API bug

PATCH /api/v0/scenario-bundles/<uid>/ accepts ?expand=labels (the parameter is validated for every view in OekgAPIView.initial) but does not act on it: the response is built without the expansion set (oekg/api_views.py, the return bundle_response(...) at the end of patch, which passes no expand=). Every other write below a bundle (scenario and study report writes, dataset link writes, replace/) resolves labels when asked, and the bundle GET does too.

So a client asking for labels on a bundle patch silently gets none. Either honour it (pass expand=self.expand, one line, plus a test) or refuse it with the same 400 an unknown expansion gets, by not offering labels on that method.

Found while annotating the endpoints for the OpenAPI reference (#2480); the documentation deliberately does not claim the parameter works there.

Lenguaje dominante
Python
Estrellas
65
Forks
28
Merge medio
4 d 7 h
PR fusionados (30 d)
25

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

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 OpenEnergyPlatform/oeplatform

Todos los issues de OpenEnergyPlatform/oeplatform

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.