Response descriptions tend to be unhelpful
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 42/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- openapi
- Área
- api, documentation
Línea de trabajo
Comienza localizando las definiciones de respuesta de OpenAPI para las respuestas 2XX y revisando cómo se representan actualmente sus descripciones. Determina un reemplazo coherente para el texto genérico "Response", conservando el campo de descripción requerido de OpenAPI. Se considera completado cuando las respuestas de éxito afectadas tienen descripciones útiles y la descripción de la API sigue siendo válida.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Almost all 2XX responses have the description "Response" which feels like the least possible useful description.
Now I understand that OpenAPI requires a description, which I feel is over the top when both the Path and Operation can already have one (and would usually cover at least the semantics of the "success" response). Still, I feel like this should be better as either an empty string or a note that this is a success (response)? Every response is one after all, including failures.
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 1.6k
- Forks
- 342
- Merge medio
- 2 h 23 min
- PR fusionados (30 d)
- 57
Guía de contribución
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.
Más de github/rest-api-description
-
feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
github/rest-api-description#7220 ·
-
feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
github/rest-api-description#7201 ·
-
feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
github/rest-api-description#7163 ·
-
Runner deprecations: registration_deprecates_at is declared on the response but never returned Abiertofeature
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
github/rest-api-description#7162 ·
-
feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
github/rest-api-description#7135 ·
Todos los issues de github/rest-api-description
Issues similares
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
area/profiles comp/cli comp/dashboard P2 sweeper:risk-session-state type/bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
NousResearch/hermes-agent#122365 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
vllm-project/production-stack#1105 ·
-
bug priority:low
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
CyberAgent/psd2svg#430 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100