Joystream / Joystream/hydra

Custom APIs

Open
#488 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement low-prio qn-hydra-board to-triage
Dominant language
TypeScript
Stars
50
Forks
43
PR merge metrics
No merged PRs in 30d

Description

Background

Sometimes we want some API feature which either is not present, or is too slow, and we have to either make complex changes to Hydra to accomodate some edge case - which typically requires some long delay, or we have to start doing hacky workarounds.

Proposal

Implement something like this https://docs.subsquid.io/reference/api-extensions.

But this is only worth doing if its super easy.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked Subsquid API extensions reference and compare its approach with Hydra's current extension points. Define a minimal, validated scope for custom APIs and confirm that the resulting integration is easy to use without complex Hydra changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.