labthings / labthings/python-labthings
Action schema defines links inconsistently with Thing Description
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 19
- Forks
- 2
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
Thing Description defines the links property of a Thing to be an array of objects, each with "rel" and "href" properties (among others). Would it make sense for Actions to follow suit? This isn't a normative part of the spec, but it would feel quite sensible. It would mean changing from:
{
"status": "completed",
"output": true,
"links": {
"self": {
"href": "https://my_host/actions/id"
}
}
}
to
{
"status": "completed",
"output": true,
"links": [
{"rel": "self", "href":"https://my_host/actions/id"},
]
}
The resulting object is slightly less convenient (I can't just do action["links"]["self"]["href"]) but it is more in keeping with the standard.
This is really a decision for LabThings-FastAPI, but I'm keen not to break compatibility if there was a good reason for doing it the current way.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza revisando el esquema de respuesta actual de Action y la definición de links de Thing Description; después, sigue cualquier expectativa de compatibilidad para las respuestas de Action existentes. Esto se completa cuando el proyecto ha decidido si las representaciones deben alinearse y el comportamiento, la documentación y las pruebas resultantes reflejan esa decisión.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- flask, python
- Área
- api, backend
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100