-
Notifications
You must be signed in to change notification settings - Fork 2
Operation Parameters
Adil Bektursunov edited this page Mar 17, 2026
·
4 revisions
| Path | Change id | Comment | Example | Severity | Approved | Version Combination | Link | |
|---|---|---|---|---|---|---|---|---|
| 1 | paths.[].[].parameters.[] | add-operation-parameter | add optional query/header/cookie parameter | before after | non-breaking | add-operation-parameter | ||
| 2 | paths.[].[].parameters.[] | add-header-parameter-with-name-accept | from oas: If "in" is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored | before after | unclassified | add-header-parameter-with-name-accept | ||
| 3 | paths.[].[].parameters.[] | remove-header-parameter-with-name-accept | from oas: If "in" is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored | before after | unclassified | remove-header-parameter-with-name-accept | ||
| 4 | paths.[].[].parameters.[] | add-header-parameter-with-name-content-type | from oas: If "in" is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored | before after | unclassified | add-header-parameter-with-name-content-type | ||
| 5 | paths.[].[].parameters.[] | remove-header-parameter-with-name-content-type | from oas: If "in" is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored | before after | unclassified | remove-header-parameter-with-name-content-type | ||
| 6 | paths.[].[].parameters.[] | add-header-parameter-with-name-authorization | from oas: If "in" is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored | before after | unclassified | add-header-parameter-with-name-authorization | ||
| 7 | paths.[].[].parameters.[] | remove-header-parameter-with-name-authorization | before after | unclassified | remove-header-parameter-with-name-authorization | |||
| 8 | paths.[].[].parameters.[] | remove-operation-parameter | remove optional query/header/cookie parameter | before after | breaking | remove-operation-parameter | ||
| 9 | paths.[].[].parameters.[].in. | update-parameter-type | before after | (key for parameter is "name" + "in") 2 changes: breaking - removed query parameter non-breaking - added cookie parameter | update-parameter-type | |||
| 10 | paths.[].[].parameters.[].description. | add-parameter-description | add description for any param type | before after | annotation | add-parameter-description | ||
| 11 | paths.[].[].parameters.[].description. | update-parameter-description | update description for any param type | before after | annotation | update-parameter-description | ||
| 12 | paths.[].[].parameters.[].description. | remove-parameter-description | remove description for any param type | before after | annotation | remove-parameter-description | ||
| 13 | paths.[].[].parameters.[].required. | add-required-attribute-with-default-value-for-parameter | before after | [not supported] | add-required-attribute-with-default-value-for-parameter | |||
| 14 | paths.[].[].parameters.[].required. | remove-required-attribute-with-default-value-from-parameter | before after | [not supported] | remove-required-attribute-with-default-value-from-parameter | |||
| 15 | paths.[].[].parameters.[].required. | mark-parameter-as-required | before after | breaking | mark-parameter-as-required | |||
| 16 | paths.[].[].parameters.[].required. | mark-parameter-as-optional | before after | non-breaking | mark-parameter-as-optional | |||
| 17 | paths.[].[].parameters.[].deprecated. | add-deprecated-attribute-with-default-value-for-parameter | before after | [not supported] | add-deprecated-attribute-with-default-value-for-parameter | |||
| 18 | paths.[].[].parameters.[].deprecated. | remove-deprecated-attribute-with-default-value-from-parameter | before after | [not supported] | remove-deprecated-attribute-with-default-value-from-parameter | |||
| 19 | paths.[].[].parameters.[].deprecated. | mark-parameter-as-deprecated | before after | deprecated | mark-parameter-as-deprecated | |||
| 20 | paths.[].[].parameters.[].deprecated. | remove-deprecated-value | before after | deprecated | remove-deprecated-value | |||
| 21 | paths.[].[].parameters.[].allowEmptyValue. | add-allowEmptyValue-attribute-with-default-value-for-parameter | before after | [not supported] | add-allowEmptyValue-attribute-with-default-value-for-parameter | |||
| 22 | paths.[].[].parameters.[].allowEmptyValue. | remove-allowEmptyValue-attribute-with-default-value-from-parameter | before after | [not supported] | remove-allowEmptyValue-attribute-with-default-value-from-parameter | |||
| 23 | paths.[].[].parameters.[].allowEmptyValue. | allow-empty-value-for-query | for query parameter | before after | non-breaking | allow-empty-value-for-query | ||
| 24 | paths.[].[].parameters.[].allowEmptyValue. | prohibit-empty-value-for-query | for query parameter | before after | breaking | prohibit-empty-value-for-query | ||
| 25 | paths.[].[].parameters.[].allowEmptyValue. | allow-empty-value-for-not-query | for params other than query parameter | before after | unclassified | allow-empty-value-for-not-query | ||
| 26 | paths.[].[].parameters.[].allowEmptyValue. | prohibit-empty-value-for-not-query | for params other than query parameter | before after | unclassified | prohibit-empty-value-for-not-query | ||
| 27 | paths.[].[].parameters.[].style. | add-default-style-for-path-parameter | before after | [not supported] | add-default-style-for-path-parameter | |||
| 28 | paths.[].[].parameters.[].style. | update-style-for-path-parameter | update style for path parameter. Possible values: matrix label simple | before after | breaking | update-style-for-path-parameter | ||
| 29 | paths.[].[].parameters.[].style. | remove-default-style-from-path-parameter | before after | [not supported] | remove-default-style-from-path-parameter | |||
| 30 | paths.[].[].parameters.[].style. | add-default-style-for-query-parameter | before after | [not supported] | add-default-style-for-query-parameter | |||
| 31 | paths.[].[].parameters.[].style. | remove-default-style-from-query-parameter | before after | [not supported] | remove-default-style-from-query-parameter | |||
| 32 | paths.[].[].parameters.[].style. | add-default-style-for-header-parameter | before after | [not supported] | add-default-style-for-header-parameter | |||
| 33 | paths.[].[].parameters.[].style. | remove-default-style-from-header-parameter | before after | [not supported] | remove-default-style-from-header-parameter | |||
| 34 | paths.[].[].parameters.[].style. | add-default-style-for-cookie-parameter | before after | [not supported] | add-default-style-for-cookie-parameter | |||
| 35 | paths.[].[].parameters.[].style. | remove-default-style-from-cookie-parameter | before after | [not supported] | remove-default-style-from-cookie-parameter | |||
| 36 | paths.[].[].parameters.[].explode. | mark-primitive-parameter-as-exploded | When explode is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect | before after | [not supported] unclassified | mark-primitive-parameter-as-exploded | ||
| 37 | paths.[].[].parameters.[].explode. | mark-primitive-parameter-as-not-exploded | When explode is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect | before after | [not supported] unclassified | mark-primitive-parameter-as-not-exploded | ||
| 38 | paths.[].[].parameters.[].explode. | mark-array-parameter-with-not-form-style-as-exploded | When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. | before after | [not supported] breaking | mark-array-parameter-with-not-form-style-as-exploded | ||
| 39 | paths.[].[].parameters.[].explode. | mark-array-parameter-with-not-form-style-as-not-exploded | When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. | before after | [not supported] breaking | mark-array-parameter-with-not-form-style-as-not-exploded | ||
| 40 | paths.[].[].parameters.[].explode. | mark-array-parameter-with-form-style-as-not-exploded | When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. | before after | [not supported] breaking | mark-array-parameter-with-form-style-as-not-exploded | ||
| 41 | paths.[].[].parameters.[].explode. | mark-array-parameter-with-form-style-as-exploded | When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. | before after | [not supported] breaking | mark-array-parameter-with-form-style-as-exploded | ||
| 42 | paths.[].[].parameters.[].allowReserved. | add-allowReserved-attribute-with-default-value-for-query-parameter | before after | [not supported?] | add-allowReserved-attribute-with-default-value-for-query-parameter | |||
| 43 | paths.[].[].parameters.[].allowReserved. | remove-allowReserved-attribute-with-default-value-from-query-parameter | before after | [not supported?] | remove-allowReserved-attribute-with-default-value-from-query-parameter | |||
| 44 | paths.[].[].parameters.[].allowReserved. | allow-reserved-characters-for-query | before after | non-breaking | allow-reserved-characters-for-query | |||
| 45 | paths.[].[].parameters.[].allowReserved. | prohibit-reserved-characters-for-query | before after | breaking | prohibit-reserved-characters-for-query | |||
| 46 | paths.[].[].parameters.[].allowReserved. | allow-reserved-characters-for-not-query | add allowReserved = true for path/header/cookie param (allowReserved property only applies to parameters with an in value of query, therefore adding this value is unclassified change) | before after | unclassified | allow-reserved-characters-for-not-query | ||
| 47 | paths.[].[].parameters.[].allowReserved. | prohibit-reserved-characters-for-not-query | prohibit reserved characters for path/header/cookie param (allowReserved property only applies to parameters with an in value of query, therefore adding this value is unclassified change) | before after | unclassified | prohibit-reserved-characters-for-not-query | ||
| 48 | paths.[].[].parameters.[].example. | add-parameter-example | before after | annotation | add-parameter-example | |||
| 49 | paths.[].[].parameters.[].example. | update-parameter-example | before after | annotation | update-parameter-example | |||
| 50 | paths.[].[].parameters.[].example. | remove-parameter-example | before after | annotation | remove-parameter-example | |||
| 51 | paths.[].[].parameters.[].x-* | add-custom-property | OAS extensions, ER shall not depend on extension value - a primitive, an array, an object or null | before after | non-breaking [not supported] | add-custom-property | ||
| 52 | paths.[].[].parameters.[].x-* | update-custom-property-value | OAS extensions, ER shall not depend on extension value - a primitive, an array, an object or null | before after | non-breaking [not supported] | update-custom-property-value | ||
| 53 | paths.[].[].parameters.[].x-* | remove-custom-property | OAS extensions, ER shall not depend on extension value - a primitive, an array, an object or null | before after | non-breaking [not supported] | remove-custom-property | ||
| 54 | paths.[].[].parameters.[].description ($ref with sibling) | add-overriden-description | add description that overrides $ref (sibling) | before after | annotation | [3.1.0, 3.1.0], [3.0.0, 3.1.0] | add-overriden-description | |
| 55 | paths.[].[].parameters.[].description ($ref with sibling) | change-overriden-description | change description that overrides $ref (sibling) | before after | annotation | [3.1.0, 3.1.0] | change-overriden-description | |
| 56 | paths.[].[].parameters.[].description ($ref with sibling) | change-referenced-description-when-overridden-exists | change description in referenced schema when sibling override exists | before after | annotation | [3.1.0, 3.1.0] | change-referenced-description-when-overridden-exists | |
| 57 | paths.[].[].parameters.[].description ($ref with sibling) | remove-overriden-description | remove description that overrides $ref (sibling) | before after | annotation | [3.1.0, 3.1.0], [3.1.0, 3.0.0] | remove-overriden-description |