Interest in taking Schema description from Schema.__doc__ docstring
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- openapi, python
- Área
- api, documentation
Línea de trabajo
Empieza en src/apispec/ext/marshmallow/openapi.py, alrededor del manejo existente de Meta.description. Comprueba cómo se generan las descripciones de los esquemas y si es aplicable el formato de flask-smorest mencionado; se considera terminado cuando Schema.doc puede proporcionar una descripción si falta Meta.description, sin reemplazar una Meta.description explícita.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
You take the object description from Meta.description in https://github.com/marshmallow-code/apispec/blob/8cbbbeb1630ff4d5732f2287b4985df84681af47/src/apispec/ext/marshmallow/openapi.py#L260
Do you have interest in a pull request to also get it from the Schema docstring? Something like:
if hasattr(Meta, "description"):
jsonschema["description"] = Meta.description
elif schema.__doc__:
jsonschema["description"] = schema.__doc__
You can do the same formating as in https://flask-smorest.readthedocs.io/en/latest/openapi.html#add-summary-and-description.
Makes sense?
- Lenguaje dominante
- Python
- Estrellas
- 1.2k
- Forks
- 210
- Merge medio
- 2 d 1 h
- PR fusionados (30 d)
- 4
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la 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 marshmallow-code/apispec
-
DateTime(format="timestamp") generates invalid OpenAPI schema using min instead of minimumPosiblemente ocupada @Sanjays2402 la tomó hace 102 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
marshmallow-code/apispec#1064 ·
Los mantenedores suelen responder en 1 día
-
documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
marshmallow-code/apispec#750 · 1 comentario · 5 reacciones ·
Los mantenedores suelen responder en 1 día
-
Dependency DashboardAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 30/100
marshmallow-code/apispec#1033 ·
Los mantenedores suelen responder en 1 día
-
`apispec` ignores `oneOf` from `marshmallow-oneofschema`Quizá libre de nuevo Un pull request para esta issue se cerró sin fusionarse. Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 38/100
marshmallow-code/apispec#1012 · 6 comentarios ·
Los mantenedores suelen responder en 1 día
-
Support Overlays standardAbiertoenhancement
Dificultad 5/5 Más de una semana Aptitud para principiantes 30/100
marshmallow-code/apispec#981 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
Todos los issues de marshmallow-code/apispec
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
btclib-org/btclib#3062 ·
Los mantenedores suelen responder en 1 día
-
Run evals automatically in CIAbiertoarea:evals area:infra enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
jse-avl/support-bot#4 · 1 comentario ·
-
bug good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
qte77/agentic-job-offer-to-application-kit#487 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
On a free-threaded build, `_decrypted` can report a ledger locked mid-sign as a damaged fileAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
btclib-org/btclib-wallet#801 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
documentation good first issue
Dificultad 1/5 1-3 horas Aptitud para principiantes 94/100