[Request] Auto-generated, publicly accessible API docs
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
- typescript
- Área
- api, documentation
Línea de trabajo
Comienza revisando el gist de documentación de API existente enlazado en el issue y, después, haz un inventario de los endpoints actuales para la recuperación y creación de datos, así como para emitir comandos. Define la ubicación pública de la documentación generada y verifica que cubra esos grupos de endpoints para los desarrolladores de Farmware e integraciones.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Currently https://gist.github.com/RickCarlino/10db2df375d717e9efdd3c2d9d8932af exists but it would be very useful to have a, for example, https://api.farm.bot that detailed the available endpoints for data retrieval, creation, and issuing commands would be very useful for farmware and integration developers.
If something like this already exists please point me to it and close this ticket.
- Lenguaje dominante
- TypeScript
- Estrellas
- 978
- Forks
- 357
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Incluye un Dockerfile o un 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 FarmBot/Farmbot-Web-App
-
Dificultad 4/5 3-5 días Aptitud para principiantes 20/100
FarmBot/Farmbot-Web-App#2505 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
FarmBot/Farmbot-Web-App#2498 · 2 comentarios · 1 reacción ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
FarmBot/Farmbot-Web-App#2467 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 20/100
FarmBot/Farmbot-Web-App#2463 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
FarmBot/Farmbot-Web-App#2416 ·
Todos los issues de FarmBot/Farmbot-Web-App
Issues similares
-
grep and find tools search inside VCS directories (.git, .svn, .hg, .jj)Posiblemente ocupada @acmerfight la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
earendil-works/pi#12084 ·
Los mantenedores suelen responder en 1 día
-
comp/desktop P3 type/feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
NousResearch/hermes-agent#154285 ·
Los mantenedores suelen responder en 1 día
-
agent-reported bug from-app needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
nightly-labs/openbot#8154 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
jdx/mise-action#730 ·
Los mantenedores suelen responder en 1 día
-
area:cards enhancement hand-tail ready-for-agent
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
fil-donadoni/tolaria#9275 ·
Los mantenedores suelen responder en 1 día