ipfs/kubo

HTTP API root

Open

#807 opened on Feb 24, 2015

View on GitHubContributor guide
 (15 comments) (0 reactions) (0 assignees)Go (2,725 forks)batch import
help wantedneed/analysistopic/apitopic/rpc-api

Repository metrics

Stars
 (13,906 stars)
PR merge metrics
 (Avg merge 4d 2h) (28 merged PRs in 30d)

Description

HTTP API root (e.g. http://localhost:5001/) should show a listing with links to:

  • /webui
  • show locally installed, trusted apps. (right now only webui)
  • list the URL to the api: /api/v0/<command>?arg=<args>&<flags>

thanks @dominictarr

Contributor guide

Research direction
Examine the existing HTTP API handler and add a root endpoint that returns a JSON listing with links to /webui, locally installed apps, and API documentation.
Tech stack
go
Domain
apibackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoHTTP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70