Include dev API in docs
Abierto
Nadie ha tomado este issue todavía.
cloud/server
- Lenguaje dominante
- Vue
- Estrellas
- 15
- Forks
- 22
- Merge medio
- 5 d 11 h
- PR fusionados (30 d)
- 9
Descripción
if we have swagger definition of the public REST API it should be possible to easily create nice documentation for anyone who would like to use it for custom integrations
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.
Línea de trabajo
El issue identifica la REST API pública y una definición de Swagger, pero no indica archivos ni puntos de entrada. Empieza por localizar la especificación de la API y los puntos de integración del sitio de documentación; la tarea estará terminada cuando la API pública esté documentada de una forma fácil de usar para integradores personalizados.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- openapi
- Área
- api, documentation
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100