Breaking change: Changing the number of allowed items in an array

[savage-alex]

Given the following parameter

- name: color
        in: query
        description: Color of the car. Its possible to filter on up to 5 colors at a time.
        required: false
        style: form
        explode: true
        schema:
          maxLength: 100
          minLength: 0
          maxItems: 10
          minItems: 0
          type: array
          items:
            type: string
            enum:
            - Black
            - Blue
            - Red
            - Silver
            - Green
            - Yellow
        example:
        - Blue

If the max or min items are changed this could be a breaking change

[acunniffe]

@savage-alex -- question, is it breaking if the range expands?

For instance if minimum is 50 and maximum is 100

• is making minimum 60 a break? 60 is in the original set
• is making maximum 110 a break? 110 was outside the original set
• does it matter if the array is being sent in a request or returned in a response?

[savage-alex]

We have spectral rules for this seperatly for requests, responses and for parameters (wrongly or rightly) so we can give specific information to the designer.

I think it you increased a limit that would be ok but reducing them would not be ok.

[acunniffe]

Makes sense. We've heard this from another team as well, going to open a quick PR :)

[savage-alex]

Great to see the tool picking up this change. We just need to add the rule for it