ardatan / ardatan/graphql-mesh
Improve doc of additionalResolvers sourceArgs
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.5k
- Forks
- 363
- Avg merge
- 6h 10m
- Merged PRs (30d)
- 19
Description
I just find out by a random test that's possible to specify a value inside object using the dot notation (condition.assetId) in the sourceArgs in additionalResolvers:
additionalResolvers:
- targetTypeName: Query
...
sourceArgs:
condition.assetId: "{root.id}"
It would be nice to add this to the doc with at least an example.
I think the documentation is missing a section explaining all the features possible in the yaml file.
As another argument for you to consider the doc improvement: I recently experienced the same random discovery about env in the yaml file: https://github.com/Urigo/graphql-mesh/pull/2986.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation for additionalResolvers and its sourceArgs option; no specific file or test is named in the issue. Document the dot-notation example for nested values, and clarify the broader YAML capabilities requested, including the related env discovery mentioned in pull request 2986.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100