Adding deprecated: true to an operation yields a parse error about oasdiff

[reuvenharrison]

Hi @tibbe,
When removing an endpoint and marking it as deprecated, oasdiff requires an additional field x-sunset, like this:

    "/authorized/organizations/{organization_id}/link_invitations": {
      "delete": {
        "deprecated": true,
        "x-sunset": "2024-12-31",

Adding this field will prevent the api-path-sunset-parse error that you are receiving.
This behavior is documented here: https://github.com/Tufin/oasdiff/blob/main/docs/API-DEPRECATION.md

Please share your feedback.

[tibbe]

Hi @tibbe, When removing an endpoint and marking it as deprecated, oasdiff requires an additional field x-sunset, like this:

    "/authorized/organizations/{organization_id}/link_invitations": {
      "delete": {
        "deprecated": true,
        "x-sunset": "2024-12-31",

Adding this field will prevent the api-path-sunset-parse error that you are receiving. This behavior is documented here: https://github.com/Tufin/oasdiff/blob/main/docs/API-DEPRECATION.md

Please share your feedback.

That's not really feasible in all the cases where the OpenAPI spec is programatically generated, like in the case of FastAPI, as the user likely has no control over what gets put in the generated spec, especially so for non-standard fields like x-sunset (hence the "x-" part).

I don't think oasdiff should require the input spec to contain non-standard fields. It's fine if it also accepts them but shouldn't fail if they're not present.

[reuvenharrison]

I agree. That's a good point.

[reuvenharrison]

Thanks for reporting this.
Please let me know if it is working as expected now.
Details: https://github.com/Tufin/oasdiff/blob/main/docs/DEPRECATION.md

[tibbe]

Thanks!