Azure / Azure/openapi-diff

Need detailed documentation

Open
#211 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
290
Forks
50
Avg merge
5d 13h
Merged PRs (30d)
5

Description

Can I install this as npm package and compare 2 OAS URL's and log it to a text file ?

I tried something like this `compare OAS_OLD_URL/swagger.json OAS_NEW_URL/swagger.json` but nothing happens. Need some help on running this in local and setting log file path.

Contributor guide

Open the contributing guide

Research direction

The issue names no files or tests; start by locating the CLI entry point and current installation and usage documentation for openapi-diff. Reproduce the two-URL command locally, then document the supported installation, comparison, and text-log path behavior with an example that produces visible output.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, openapi
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.