IBM/openapi-to-graphql

Ensure safe printing of circular schemas

Open

#233 opened on Aug 30, 2019

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (215 forks)github user discovery
good first issue

Repository metrics

Stars
 (1,645 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

In many warning/error messages, we stringify and print the faulty schema. This is a problem when we deal with circular schemas. Perhaps we can write a custom function or use a library.

Contributor guide

Research direction
Implement a custom schema stringifier that detects circular references and prints them safely without infinite recursion.
Tech stack
typescript
Domain
api
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70