Joystream / Joystream/hydra

WIP: Field type spec

Open
#64 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement low-prio low-prio-feature
Dominant language
TypeScript
Stars
50
Forks
43
PR merge metrics
No merged PRs in 30d

Description

Write proper spec for @field type references here

https://github.com/Joystream/joystream/issues/1378#issuecomment-705469500

Has to describe

  • What are allowed member types? can one do unions, other field types, reverse lookups, relationships?
  • How to model in database? should optimize for safety and Warthog compaitiblity.
  • How to expose in AIP? Should filter, ordering be possible?

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 with the linked Joystream issue comment and review the current handling of @field type references. Define the specification for allowed member types, database modeling, and AIP exposure, including filtering and ordering. Done means the open design questions are resolved in a clear written specification.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, database, documentation
Issue type
Documentation
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.