Rethink Plugin API documentation: auto-generate JSON API spec, generate `.pyi` and `.d.ts` from there
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 15/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Activo
- Stack tecnológico
- json, python, typescript
- Área
- api, documentation
Línea de trabajo
The payload names no files or entry points; it covers the RPC protocol as documented in the executable, Python and Node plugin guides of the Flow-Launcher docs repo. Start by reading those guides to see what protocol detail they repeat. Done would mean a decision on the spec format and tooling, agreed in the thread, before any generator for .pyi or .d.ts is written.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Extracted from: https://github.com/Flow-Launcher/docs/pull/108#discussion_r4232118122
Documenting the RPC protocol in the various language-specific plugin guides is not ideal. Rather, we should decide on a formal, generated reference for the RPC spec, the same way you might see documentation for a C# API, or a .d.ts reference. Then these various non-C# plugin guides - executable, python, node - can stop documenting the protocol and instead reference the formal spec.
This spec can also be used to generate types for the TypeScript/JavaScript and Python libraries which make plugin development easier. Someone should be able to easily import the library in their node or python project and get rich intellisense for JSON requests and responses.
- Lenguaje dominante
- Svelte
- Estrellas
- 23
- Forks
- 23
- Merge medio
- 9 d 34 min
- PR fusionados (30 d)
- 3
Preparar el entorno
- Sin Dockerfile ni 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 Flow-Launcher/docs
-
documentation
Dificultad 3/5 1-2 días Aptitud para principiantes 25/100
Flow-Launcher/docs#99 ·
-
bug
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
Flow-Launcher/docs#87 · 13 comentarios ·
-
Outdated NodeJS versionAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 45/100
Flow-Launcher/docs#79 · 2 comentarios ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
Flow-Launcher/docs#49 · 1 comentario ·
-
Deploy on VercelAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
Flow-Launcher/docs#4 · 12 comentarios ·
Todos los issues de Flow-Launcher/docs
Issues similares
-
Add an EPUB parserAbiertoarea: core good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
openapi/gknowledge#21 ·
-
get() for StrEnumPosiblemente ocupada @FeJo5952 la tomó hoy. Abiertogood first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
collective/icalendar#1921 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
agent-butler-finding agent-research-recommend bug ready-for-agent
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
jordansmall/spindrift#5278 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
`openai`: Set request parametersAbiertoImprovement Python Spans
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
getsentry/sentry-python#7990 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
alphagov/notifications-api#5004 ·
Los mantenedores suelen responder en 2 días