Skip to content

[api-diff] change classification of remove-enum/add-enum-value in response #7

@iugaidiana

Description

@iugaidiana

It is needed to change classification for the following cases in response schema - paths.[].[].responses.[].content.[].schema:

  1. add new enum value
    • changeId: add-enum-value
    • severity: requires attention
      Example:

before:

openapi: 3.0.0
...
paths:
  /pets:
    get: 
      responses:
        '200':
          content:
            'application/json':
                schema:       
                   type: string
                   enum:
                     - val1
                     - val2

after:

openapi: 3.0.0
...
paths:
  /pets:
    get: 
      responses:
        '200':
          content:
            'application/json':
                schema:       
                   type: string
                   enum:
                     - val1
                     - val2
                     - val3

  1. remove entire enum with all values
    • changeId: remove-enum
    • severity: requires attention
      Example:

before:

openapi: 3.0.0
...
paths:
  /pets:
    get: 
      responses:
        '200':
          content:
            'application/json':
                schema:       
                   type: string
                   enum:
                     - val1
                     - val2

after:

openapi: 3.0.0
...
paths:
  /pets:
    get: 
      responses:
        '200':
          content:
            'application/json':
                schema:       
                   type: string

tbd: separate ticket to change description for risky changes

Metadata

Metadata

Labels

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions