RicoSuter/NJsonSchema

Add support for comparing two NJsonSchema specifications

Open

#309 opened on Jan 27, 2017

View on GitHub
 (8 comments) (1 reaction) (0 assignees)C# (550 forks)github user discovery
help wantedtype: enhancement

Repository metrics

Stars
 (1,578 stars)
PR merge metrics
 (Avg merge 39d 6h) (1 merged PR in 30d)

Description

Do you have bandwidth to support comparing two NJsonSchema specifications and spew out the differences to determine whether a newer API specification is backwards-compatible with an older API specification.

There is one solution available for ruby users https://github.com/civisanalytics/swagger-diff but i am unable to find one that does c#.

Contributor guide

Research direction
Study the existing swagger diff Ruby implementation and design a similar diff algorithm for NJsonSchema, focusing on backward compatibility checks.
Tech stack
csharp
Domain
api
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.
1-2 days
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.
Mostly clear
Prerequisites
C#JSON Schema
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50