Ignore parameter name changes

[EpicWink]

Problem

I have the same (in theory) API spec generated from two different sources, which have different names for the URL path parameters. This causes oasdiff to consider those endpoints to be both new and deleted, even though the API is not any different.

Proposal

Treat URL path parameter names as opaque, and equivalent between the base and revision specs (if the parameters have the same schema, eg the same (lack of) reg-ex).

Alternatives

I currently manually update the OpenAPI spec to have matching path parameters, but this is prone to error.

[reuvenharrison]

Hi @EpicWink ,
Would you be able to provide two specs and a cmd-line that I can use to replicate the issue?
Thanks,
Reuven

[EpicWink]

@reuvenharrison here:

a.openapi.yml

openapi: 3.0.0

info:
  title: My API
  version: '0.1'

paths:
  /books/{bookId}:
    parameters:
      - in: path
        name: bookId
        description: book ID
        required: true

        schema:
          title: ID
          type: string

    get:
      summary: get book details
      description: get details for a book

      responses:
        '200':
          description: successfully retrieved book details

          content:
            application/json:
              schema:
                title: book details
                type: object

                required:
                  - author
                  - title

                properties:
                  author:
                    title: book author name
                    type: string

                  title:
                    title: book title
                    type: string

b.openapi.yml

openapi: 3.0.0

info:
  title: My API
  version: '0.1'

paths:
  /books/{id}:
    parameters:
      - in: path
        name: id
        description: book ID
        required: true

        schema:
          title: ID
          type: string

    get:
      summary: get book details
      description: get details for a book

      responses:
        '200':
          description: successfully retrieved book details

          content:
            application/json:
              schema:
                title: book details
                type: object

                required:
                  - author
                  - title

                properties:
                  author:
                    title: book author name
                    type: string

                  title:
                    title: book title
                    type: string

Text

docker run -v $(pwd):/wd -w /wd --rm -i tufin/oasdiff:latest -format text -base a.openapi.yml -revision b.openapi.yml

### New Endpoints: 1
--------------------
GET /books/{id}  

### Deleted Endpoints: 1
------------------------
GET /books/{bookId}  

### Modified Endpoints: None
----------------------------

YAML

docker run -v $(pwd):/wd -w /wd --rm -i tufin/oasdiff:latest -format yaml -base a.openapi.yml -revision b.openapi.yml

paths:
    added:
        - /books/{id}
    deleted:
        - /books/{bookId}
endpoints:
    added:
        - method: GET
          path: /books/{id}
    deleted:
        - method: GET
          path: /books/{bookId}

[reuvenharrison]

See #212