Need detailed documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- csharp, openapi
- Domain
- cli, documentation
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.
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.
- Dominant language
- C#
- Stars
- 290
- Forks
- 50
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 10
Contributor 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 Azure/openapi-diff
-
Azure/openapi-diff#482 · 1 assignee ·
-
Azure/openapi-diff#479 · 2 comments · 1 assignee ·
-
Azure/openapi-diff#456 · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Azure/openapi-diff#445 ·
-
Azure/openapi-diff#371 · 7 comments · 1 assignee ·
All issues in Azure/openapi-diff
Similar issues
-
:watch: Not Triaged dotnet-fsharp/svc
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Client customer-reported needs-team-attention question Service Attention WebPubSub
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Azure/azure-sdk-for-net#63292 · 3 comments · 1 reaction ·
-
Issue-Enhancement Needs-Triage
Difficulty 1/5 Under an hour Newbie friendliness 86/100
PowerShell/PowerShell#28061 · 2 reactions ·
-
dependencies needs-team-triage server-Azure.Mcp
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
aspnet-core/svc aspnetcore-signalr/subsvc doc-enhancement Pri2 SignalR
Difficulty 1/5 Under an hour Newbie friendliness 88/100
dotnet/AspNetCore.Docs#37729 ·