informalsystems / informalsystems/hermes

Hermes REST endpoint list

Open
#1,990 0 comments 1 reaction 0 assignees View on GitHub
A: good-first-issue I: rest-api
Dominant language
Rust
Stars
505
Forks
399
PR merge metrics
No merged PRs in 30d

Description

## Summary
It would be nice to show the REST endpoints with `curl -s -X GET 'http://127.0.0.1:3000' | jq`

## Problem Definition
Need to consult the documentation or code to see the available endpoints.

## Proposal

## Acceptance Criteria

____

#### For Admin Use

- [ ] Not duplicate issue
- [ ] Appropriate labels applied
- [ ] Appropriate milestone (priority) applied
- [ ] Appropriate contributors tagged
- [ ] Contributor assigned/self-assigned

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Hermes documentation and code that define its REST endpoints, using the curl and jq command in the issue as the intended way to inspect them. Clarify the desired endpoint-list format and acceptance criteria; done should make the available endpoints discoverable without searching through the code.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.