Write a guide how to implement an API Report method
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
- Stack tecnológico
- php
- Área
- api, documentation
Línea de trabajo
Comienza con la guía existente „Exposing API Methods“ enlazada en el issue. Añade ejemplos que cubran una DataTable construida a partir de un array simple y un report existente personalizado con un filtro, y explica cómo se aplican los parámetros de consulta de DataTable, como limit, showColumns y filter_*; la guía estará terminada cuando ambos ejemplos y esa justificación estén documentados.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
It would be good to extend the current guide about Exposing API Methods with an example how to implement an API Report method.
Maybe one example that creates a DataTable from a simple array and runs a filter on it? The filter is maybe not needed but we should explain why not simply return the plain array: Because the dataTable allows to use all our query parameters like limit, showColumns, filter_*, ...
Then maybe another simple example that fetches an existing report, runs a filter on it to customize the report and returns it.
- Lenguaje dominante
- PHP
- Estrellas
- 58
- Forks
- 88
- Merge medio
- 6 h 29 min
- PR fusionados (30 d)
- 3
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 5/5 Más de una semana Aptitud para principiantes 25/100
matomo-org/developer-documentation#787 · 1 comentario ·
Todos los issues de matomo-org/developer-documentation
Issues similares
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
rap2hpoutre/fast-excel#425 ·
-
bug Medium Priority
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
sync-en
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
sync-en
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 2 días
-
Перевод устарел
Dificultad 1/5 1-3 horas Aptitud para principiantes 78/100