graphprotocol / graphprotocol/docs

More info on `dataSources.mapping.entities`

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

Nobody has claimed this yet.

Dominant language
MDX
Stars
85
Forks
162
Avg merge
6h 31m
Merged PRs (30d)
4

Description

It seems dataSources.mapping.entities is not strictly validated with the defined schema and would still work without issues as long as they're not empty in the manifest.

https://github.com/graphprotocol/docs/blob/17613951bc3ee87a58f8e3748babd2cc284e1a0f/website/pages/en/developing/creating-a-subgraph.mdx?plain=1#L149

It would be nice to have some more info on how exactly this config is being used, and also of the fact that its not validated with the schema

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 at website/pages/en/developing/creating-a-subgraph.mdx around the linked dataSources.mapping.entities section. Compare the documented configuration with the defined schema and clarify how entities are used and that non-empty values are not schema-validated. Done means the documentation explains this behavior clearly for manifest authors.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.