logseq / logseq/plugins

Api documentation as json or interactively?

Open
#11 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
26
Forks
8
PR merge metrics
No merged PRs in 30d

Description

I checked out the [api documentation](https://plugins-doc.logseq.com/) and couldn't find a way to get the modules and methods in a machine readable way. However [typedoc](https://typedoc.org/) 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](https://swagger.io/), which is for OpenApi-documented RESTful apis only. But maybe there exists something comparable for typedoc?!

Contributor guide

No contributing guide indexed for this repository

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.

Assessment

Tech stack
json, openapi
Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.