Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Webhooks diff #634

Closed
gcatanese opened this issue Nov 7, 2024 · 4 comments
Closed

Webhooks diff #634

gcatanese opened this issue Nov 7, 2024 · 4 comments
Labels
bug Something isn't working

Comments

@gcatanese
Copy link

Describe the bug
When generating the diff between specs that contain webhooks I notice the following:

Output start with extensions

Should extensions be replaced by webhooks?

extensions:
    modified:
        webhooks:
            - oldValue: null
              value:

Deleted properties without error or warning

Request attributes are dropped, I would expect a warning to inform about the (potential?) breaking change

TransferData:
                properties:
                    added:
                        - categoryData
                    deleted:
                        - platformPaymentType
                        - pspPaymentReference

To Reproduce
Steps to reproduce the behavior:

oasdiff diff https://raw.githubusercontent.com/Adyen/adyen-openapi/refs/heads/main/yaml/BalancePlatformTransferNotification-v3.yaml \ 
https://raw.githubusercontent.com/Adyen/adyen-openapi/refs/heads/main/yaml/BalancePlatformTransferNotification-v4.yaml

Expected behavior

  1. Replace extensions with webhooks?
  2. Introduce error and warning

Desktop (please complete the following information):

  • OS: macOS
@gcatanese gcatanese added the bug Something isn't working label Nov 7, 2024
@reuvenharrison
Copy link
Collaborator

Thanks for reporting this.
I'll check it asap and update.

@reuvenharrison
Copy link
Collaborator

Webhooks support was introduced in version 3.1.0.
Oasdiff doesn't support this version.

@reuvenharrison reuvenharrison closed this as not planned Won't fix, can't repro, duplicate, stale Nov 7, 2024
@gcatanese
Copy link
Author

Thanks for the quick reaction @reuvenharrison Is supporting OpenAPI 3.1.0 not planned or considered?

@reuvenharrison
Copy link
Collaborator

Please see this discussion: #52

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants