-
Notifications
You must be signed in to change notification settings - Fork 29
Open
Description
Problem
Sometimes docs are out of sync with api and when they are updated it appears as a breaking change. oasdiff has --err-ignore and --warn-ignore but the oasdiff-action does not have, so how can I ignore specific errors thrown by the oasdiff-action?
running oasdiff breaking... base: https://raw.githubusercontent.com/calcom/cal.com/refs/heads/main/docs/api-reference/v2/openapi.json, revision: docs/api-reference/v2/openapi.json, fail_on: ERR, include_checks: , include_path_params: false, deprecation_days_beta: , deprecation_days_stable: , exclude_elements: , filter_extension: , composed: false, output_to_file:
flags:
Error: in API GET /v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/private-links added the new path request parameter 'orgId'
Error: in API POST /v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/private-links added the new path request parameter 'orgId'
Error: in API DELETE /v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/private-links/{linkId} added the new path request parameter 'orgId'
Error: in API PATCH /v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/private-links/{linkId} added the new path request parameter 'orgId'
Solution
Would be nice if in .yml file of github action running oasdiff-action it would be possible to use --err-ignore and --warn-ignore and paste errors above so they are ignored.
Question
Is there a way to ignore errors or warnings using oasdiff-action? Thank you
Metadata
Metadata
Assignees
Labels
No labels