Api documentation as json or interactively?
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- json, openapi
- Domain
- api, documentation
Research direction
Start with the linked API documentation and TypeDoc's JSON-generation documentation; compare the proposed .json endpoint with the Swagger/OpenAPI alternative. Done should be a documented, agreed approach for exposing modules and methods in a machine-readable form.
Written by the indexing model from the issue text.
Description
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?!
- Dominant language
- HTML
- Stars
- 26
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from logseq/plugins
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Doc pages are broken Open
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
use-agent-os/agent-os#3312 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
needs-acceptance wg/data-plane-networking
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vllm-project/semantic-router#4024 · 1 comment ·
-
bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
amponce/archive-movie-browser#165 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100