Skip to content

OpenApiComparer is not implemented #414

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.

Activity

  1. darrelmiller commented on Aug 23, 2019

    @darrelmiller
    Member

    Huh! I had no idea. I don't whether it is in finished enough to consider merging in. If it is I can create a PR based on it.

  2. Backs commented on Sep 25, 2019

    @Backs

    Any new information? Looks lite this code is productoin ready and was added 2 year ago, but still not in master

  3. darrelmiller commented on Jan 4, 2020

    @darrelmiller
    Member

    This code has been merged into the vnext branch. I would like to include it in the v1.2 release but there are still some failing tests. I have marked them as skip for the moment, but they need to be fixed before we can release.

  4. added this to the 1.2.0 milestone on Jan 4, 2020
  5. FLAMESpl commented on May 1, 2020

    @FLAMESpl

    Hi, do you have ETA for complete feature or at least new update? Latest prerelease available on nuget throws StackOverflowException for my swagger doc.

  6. darrelmiller commented on Mar 14, 2021

    @darrelmiller
    Member

    My current thinking is to move comparer capability out to a separate package. There are several contributed solutions and I don't feel like picking a winner.

  7. modified the milestones: 1.3, on Mar 14, 2021
  8. FLAMESpl commented on Mar 16, 2021

    @FLAMESpl

    What is the status of this task? Is it shelved or is it in backlog for considerable future?

  9. nikjw-lmk commented on Jul 29, 2021

    @nikjw-lmk

    Did you end up moving the comparer capability into another repo? It doesn't appear to be here anymore so was wondering if it can be found somewhere else. Thanks.

  10. darrelmiller commented on Jul 29, 2021

    @darrelmiller
    Member

    Hey Nick Ward (@nikjw-lmk) . I moved the code into a feature branch https://github.com/microsoft/OpenAPI.NET/tree/feature/comparer/src/Microsoft.OpenApi/Services I haven't moved it out into a separate module. I have been focused on trying to get the OpenAPIWorkspace into a releasable state.

  11. modified the milestones: , 2.0 on Feb 10, 2022
  12. Chrille79 commented on Jan 3, 2023

    @Chrille79

    Any progress?

  13. added
    priority:p2Medium. Generally has a work-around and a smaller sub-set of customers is affected. SLA <=30 days
    on Dec 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority:p2Medium. Generally has a work-around and a smaller sub-set of customers is affected. SLA <=30 daystype:enhancementEnhancement request targeting an existing experience

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions