Skip to content

Support for detecting changes in webhooks #793

@caristu

Description

@caristu

It would be nice to support API changes in webhooks defined with OpenAPI 3.1, in particular:

  1. Detect if a webhook is removed
  2. Detect changes in the webhook payload

Unfortunately it looks like now this is not possible.

This can be reproduced by doing:


    String oldSpec = Paths.get("webhook1.yml").toUri().toString();
    String newSpec = Paths.get("webhook2.yml").toUri().toString();

    ChangedOpenApi diff = OpenApiCompare.fromLocations(oldSpec, newSpec);

The content of boths specs are attached here (as .txt but they are .yml specs)

webhook1.txt

webhook2.txt

Note that no differences are found in this case

Activity

changed the title [-]Support changes in webhook[/-] [+]Support for detecting changes in webhooks[/+] on Jun 17, 2025
added theissue type on Jun 17, 2025
added this to the 2.2.0 milestone on Jun 17, 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

    Projects

    No projects

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @DrSatyr@caristu

        Issue actions

          Support for detecting changes in webhooks · Issue #793 · OpenAPITools/openapi-diff