Add `implementedBy` field in `metadata.yml`
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Quiet
- Tech stack
- graphql
- Domain
- documentation
Research direction
Start with metadata.yml, the four proposed implementedBy representations, and the linked projects definition list. Compare support for named projects and arbitrary plugins, then confirm the chosen schema and its expected metadata shape; the work is done when the format is decided and documented consistently.
Written by the indexing model from the issue text.
Description
@PascalSenn suggested at today's wg meeting that GAPs should list (in metadata.yml) what servers/clients implement the spec, so users can decide which spec to use.
Option 1 - text only
implementedBy:
- "Apollo Client >= v1.2.3"
- "Relay >= v3.4.5"
Option 2 - markdown links
implementedBy:
- [Apollo Client >= v1.2.3](https://www.apollographql.com/docs/react)
- [Relay >= v3.4.5](https://github.com/facebook/relay)
Option 3 - structured data
implementedBy:
- name: Apollo Client
website: https://www.apollographql.com/docs/react
version: 1.2.3
- name: Relay
website: https://www.apollographql.com/docs/react
version: 3.4.5
Option 4 - project definition keys + structured data
implementedBy:
- project: apollo-client
version: 1.2.3
- project: relay
version: 3.4.5
...which refers to some central projects.yml that looks like this:
- id: apollo-client
website: https://www.apollographql.com/docs/react
- id: relay
website: https://github.com/facebook/relay
Maybe this can reuse the definitions list here https://caniuse.graphql.now/index.html#projects
Note: I'd also like to support arbitrary projects here too, since support might initially be implemented as random a plugin (e.g. the @mock spec is currently implemented in apollo-client-mock-directive-plugin, not apollo core. I would expect many specs might start out this way.
So that implies something like this:
implementedBy:
- project: relay
version: 3.4.5
- name: apollo-client-mock-directive-plugin
website: https://github.com/magicmark/apollo-client-mock-directive-plugin/
version: 0.0.1
my vote is Option 4.
- Dominant language
- JavaScript
- Stars
- 10
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
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.
More from graphql/gaps
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
clarify licensingOpen
Difficulty 3/5 1-2 days Newbie friendliness 45/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
feature request
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
openlayers/openlayers#17736 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
521xueweihan/HelloGitHub#4326 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Mintplex-Labs/anything-llm#7133 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
Maintainers usually reply within 1 day