Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

For Central API docs, show optional/required info

Abierto
  • ¿Algo no está bien?
#1,836 0 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Área
documentation

Línea de trabajo

Comienza por docs/api.yaml cerca de la línea enlazada e inspecciona cómo se representa el esquema de Central API en la documentación de Sphinx. Confirma dónde se pierde la información sobre los datos opcionales y obligatorios y, a continuación, verifica que la documentación de la API renderizada muestre visiblemente esa información para el endpoint de ejemplo.

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

Descripción

Central

For example: https://github.com/getodk/central-backend/blob/0cd56948854ecc544a1b4af9efd88cf9ceee153d/docs/api.yaml#L11958 -- this is not surfaced in the rendered docs.

Lenguaje dominante
Python
Estrellas
58
Forks
160
Merge medio
4 d 21 h
PR fusionados (30 d)
6

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 getodk/docs

Todos los issues de getodk/docs

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.