microsoft / microsoft/OpenAPI.NET
OpenApiComparer is not implemented
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 1.6k
- Forks
- 286
- Avg merge
- 6h 38m
- Merged PRs (30d)
- 35
Description
Hello,
My team is using this repository to generate our OpenAPI document, and we started using the OpenApiComparer recently in our project. This method returns a value so we believed it was working until recently when after making a change this still returned an empty list.
After looking at the implementation it's quite clear that this method does nothing but it is documented as being a method that "Compares two OpenApiDocuments and returns a list of differences.".
I believe this method should be removed or should throw instead.
After looking a bit more, there seems to be a valid implementation of this in the vnext branch that was never merged into master.
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.
Research direction
Start by reading src/Microsoft.OpenApi/Services/OpenApiComparer.cs and inspect the valid implementation in the vnext branch. Determine whether the intended resolution is to remove the method, make it throw, or bring over the vnext implementation; done means OpenApiComparer no longer silently returns an empty result for a comparison.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, openapi
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100