n1ru4l/graphql-schema-generator-rest

keep schema generator directive syntax up to date with apollo-link-rest

Open

#10 opened on Nov 30, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (6 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (95 stars)
PR merge metrics
 (PR metrics pending)

Description

This will be a breaking change 🙄

I will create a new branch for this and push it as a pre-release until the apollo-link-rest api becomes stable.

Current changes:

  • Rename route param to path
  • Replace provides param with @export directive
  • fieldNameNormalizer Note: We have the more "powerful" mappers that can transform the whole request result body.
  • Add a endpoint directive

Also nice to have:

  • Update docs about differences between apollo-link-rest and apollo-schema-generator-rest combined with apollo-link-schema

Edit:

I am currently not working on this library. If anyone wants to bring it to a new level feel free to make proposals/open a PR.

Contributor guide

Research direction
Study the apollo link rest documentation to understand the new directive syntax (path, @export, endpoint). Then update the schema generator to match. Test with existing examples and update the documentation.
Tech stack
javascriptnodejsrest api
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScriptGraphQL
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50