Api documentation as json or interactively?
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
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- json, openapi
- Área
- api, documentation
Línea de trabajo
Comienza con la documentación de la API enlazada y la documentación de TypeDoc sobre la generación de JSON; compara el endpoint .json propuesto con la alternativa de Swagger/OpenAPI. Se considerará terminado cuando exista un enfoque documentado y acordado para exponer módulos y métodos en un formato legible por máquinas.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
I checked out the api documentation and couldn't find a way to get the modules and methods in a machine readable way. However typedoc states that you can generate json from the comments.
Could we add json somehow, maybe for something like
https://plugins-doc.logseq.com/logseq/baseInfo
it could just be:
https://plugins-doc.logseq.com/logseq/baseInfo.json
An alternative could be something like swagger, which is for OpenApi-documented RESTful apis only. But maybe there exists something comparable for typedoc?!
- Lenguaje dominante
- HTML
- Estrellas
- 26
- Forks
- 8
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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 logseq/plugins
-
🧩 logseq.App.registerCommand Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
-
🧩 logseq.Editor.insertBatchBlock Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
-
Doc pages are broken Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
-
🧩 logseq.DB.datascriptQuery Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 25/100
Todos los issues de logseq/plugins
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 80/100
microsoft/magentic-ui#588 ·
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
alexgorbatchev/simple-ptt#3 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
CorrelAid/formtransform#44 ·