clojure-emacs / clojure-emacs/clojuredocs-export-edn

HTTP API

Open
#2 6 comments 0 reactions 0 assignees View on GitHub
Dominant language
Clojure
Stars
10
Forks
2
PR merge metrics
No merged PRs in 30d

Description

I've been thinking lately that it'd be great if we exposed a simple HTTP API to query directly our ClojureDocs EDN export. This would simplify the lives of clients a lot, as they won't have to deal with keeping a local copy of the data and will be able to fetch some data even without Orchard or cider-nrepl.

I guess the simplest API would be - clients request the docs for a symbol and get everything we have about it. A more polished API would allow for clients to specify they want only part of the data for some symbol (e.g. `:see-alsos`). @liquidz What do you think?

Contributor guide

No contributing guide indexed for this repository

Research direction

No files, tests, or entry points are named. Start by reviewing the repository contents and the unresolved issue discussion to identify how the EDN export is produced and where an HTTP service could fit. Done would mean agreeing on and implementing a queryable API for symbol documentation, including whether partial data such as :see-alsos is supported.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
api, backend
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.