Problem I have the same (in theory) API spec generated from two di

<a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/us

Hi <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="

See <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id

Ignore parameter name changes about oasdiff HOT 3 CLOSED

tufin commented on May 26, 2024

Ignore parameter name changes

from oasdiff.

Comments (3)

EpicWink commented on May 26, 2024 1

@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}