Skip to content

Removal of request-body is not treated as breaking change #680

@glooms

Description

@glooms

Describe the bug
If a request-body is removed for an operation it does not show up in the changelog.
IMO it is a very breaking change so I was

To Reproduce
Steps to reproduce the behavior:

  1. oasdiff breaking old.json new.json
  2. Spec 1:
{
  "info": {
    "title": "new",
    "version": ""
  },
  "paths": {
    "/new": {
      "post": {
        "summary": "Create something new",
        "responses": {
          "201": {}
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          },
          "required": true
        }
      }
    }
  },
  "openapi": "3.0.0",
  "components": {}
}
  1. Spec 2:
{
  "info": {
    "title": "new",
    "version": ""
  },
  "paths": {
    "/new": {
      "post": {
        "summary": "Create something new",
        "responses": {
          "201": {}
          }
        }
      }
    }
  },
  "openapi": "3.0.0",
  "components": {}
}
  1. Output:
    Expected behavior
    I expected a message saying that the entire request-body had been removed.

Desktop (please complete the following information):

  • OS: Linux

Additional context
Add any other context about the problem here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions