Use OpenAPI standard for API documentation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- openapi
- Área
- api, documentation
Línea de trabajo
Comienza revisando el Openmost/Matomo 5.0.0 starter en SwaggerHub y compáralo con la documentación existente para desarrolladores del repositorio. Aclara la superficie de la API y los esquemas de parámetros complejos que deben representarse. Se considera completado cuando se genera un documento YAML o JSON de OpenAPI mantenible y se mantiene actualizado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Hi,
Is it possible for you to generate and maintain an OpenAPI documentation ? (YAML or JSON single file)
I try to make a starter, but parameters objet type is complex and never documented in official documentation.
Here is the starter : https://app.swaggerhub.com/apis-docs/Openmost/Matomo/5.0.0
Regards,
Ronan HELLO
- Lenguaje dominante
- PHP
- Estrellas
- 58
- Forks
- 88
- Merge medio
- 2 d 10 h
- PR fusionados (30 d)
- 2
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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 matomo-org/developer-documentation
-
Documentation enhancement
Dificultad 1/5 1-3 horas Aptitud para principiantes 68/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
-
bug
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 55/100
matomo-org/developer-documentation#806 · 2 comentarios ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 45/100
matomo-org/developer-documentation#784 · 1 comentario ·
Todos los issues de matomo-org/developer-documentation
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
0. Needs triage bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
nextcloud/fulltextsearch#1061 ·
Los mantenedores suelen responder en 1 día
-
[Resource]: Claude KitAbiertoresource-submission validation-passed
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
hesreallyhim/awesome-claude-code#3375 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día