Feature: compatibility detection for Operation ID

[hiddewie]

At the moment, there is no change detection for operation IDs. Changing an Operation ID can break API clients, because the operation ID is usually the way to refer to a specific operation.

Example test case:

Before

openapi: "3.0.0"
info:
  version: 1.0.0
  title: Swagger Petstore
  license:
    name: MIT
servers:
  - url: http://petstore.swagger.io/v1
paths:
  /pets:
    get:
      summary: List all pets
      operationId: listPets
      responses:
        '200':
          description: A paged array of pets
        default:
          description: unexpected error

After

openapi: "3.0.0"
info:
  version: 1.0.0
  title: Swagger Petstore
  license:
    name: MIT
servers:
  - url: http://petstore.swagger.io/v1
paths:
  /pets:
    get:
      summary: List all pets
      operationId: changed
      responses:
        '200':
          description: A paged array of pets
        default:
          description: unexpected error

The output contains no changed operations, while the ID changed.

I am willing to create a pull request to add this feature.

[joschi]

@hiddewie This sounds like a good improvement.

It be great if you could provide a pull request for the implementation. 😄

[hiddewie]

Great! #191 contains the PR