| 1 |
paths.[<path>] |
add-new-path |
add new path with any method |
before after |
non-breaking |
Approved |
|
add-new-path |
| 2 |
paths.[<path>] |
remove-path |
remove path with all method under this path |
before after |
breaking |
Approved |
|
remove-path |
| 3 |
paths.[*].[<method>] |
add-new-method |
add any method |
before after |
non-breaking |
Approved |
|
add-new-method |
| 4 |
paths.[*].[<method>] |
remove-method |
remove (non deprecated) method |
before after |
breaking |
Approved |
|
remove-method |
| 5 |
paths.[*].[*].tags.<value> |
add-tag |
|
before after |
annotation |
|
|
add-tag |
| 6 |
paths.[*].[*].tags.<value> |
remove-tag |
|
before after |
annotation |
|
|
remove-tag |
| 7 |
paths.[*].[*].x-* |
add-custom-property-in-operation |
OAS extensions, ER is applicable to any type of extension value - a primitive, an array, an object or null |
before after |
non-breaking [not supported] |
|
|
add-custom-property-in-operation |
| 8 |
paths.[*].[*].x-* |
update-custom-property-value-in-operation |
OAS extensions, ER is applicable to any type of extension value - a primitive, an array, an object or null |
before after |
non-breaking [not supported] |
|
|
update-custom-property-value-in-operation |
| 9 |
paths.[*].[*].x-* |
remove-custom-property-in-operation |
OAS extensions, ER is applicable to any type of extension value - a primitive, an array, an object or null |
before after |
non-breaking [not supported] |
|
|
remove-custom-property-in-operation |
| 10 |
paths.[*].[*].x-* |
add-objects-custom-property-in-operation |
OAS extensions, ER is applicable to any type of extension value - a primitive, an array, an object or null |
before after |
non-breaking [not supported] |
|
|
add-objects-custom-property-in-operation |
| 11 |
paths.[*].[*].x-* |
update-objects-custom-property-value-in-operation |
OAS extensions, ER is applicable to any type of extension value - a primitive, an array, an object or null |
before after |
non-breaking [not supported] |
|
|
update-objects-custom-property-value-in-operation |
| 12 |
paths.[*].[*].x-* |
remove-objects-custom-property-in-operation |
OAS extensions, ER is applicable to any type of extension value - a primitive, an array, an object or null |
before after |
non-breaking [not supported] |
|
|
remove-objects-custom-property-in-operation |
| 13 |
paths.[*].[*].x-* |
add-new-object-custom-property |
OAS extensions, new object custom property |
before after |
non-breaking [not supported] |
|
|
add-new-object-custom-property |
| 14 |
paths.[*].x-* |
add-custom-property-in-path |
OAS extensions, ER is applicable to any type of extension value - a primitive, an array, an object or null |
before after |
non-breaking [not supported] |
|
|
add-custom-property-in-path |
| 15 |
paths.[*].x-* |
update-custom-property-value-in-path |
OAS extensions, ER is applicable to any type of extension value - a primitive, an array, an object or null |
before after |
non-breaking [not supported] |
|
|
update-custom-property-value-in-path |
| 16 |
paths.[*].x-* |
remove-custom-property-in-path |
OAS extensions, ER is applicable to any type of extension value - a primitive, an array, an object or null |
before after |
non-breaking [not supported] |
|
|
remove-custom-property-in-path |
| 17 |
paths.[*].[*].summary.<value> |
update-operation-summary |
|
before after |
annotation |
|
|
update-operation-summary |
| 18 |
paths.[*].[*].description.<value> |
add-operation-description |
|
before after |
annotation |
|
|
add-operation-description |
| 19 |
paths.[*].[*].description.<value> |
update-operation-description |
|
before after |
annotation |
|
|
update-operation-description |
| 20 |
paths.[*].[*].description.<value> |
remove-operation-description |
|
before after |
annotation |
|
|
remove-operation-description |
| 21 |
paths.[*].[*].externalDocs.[*] |
add-operation-external-doc |
add externalDocs on operation level |
before after |
annotation |
|
|
add-operation-external-doc |
| 22 |
paths.[*].[*].externalDocs.[*] |
remove-operation-external-doc |
remove externalDocs on operation level |
before after |
annotation |
|
|
remove-operation-external-doc |
| 23 |
paths.[*].[*].externalDocs.[*].url.<value> |
update-url-of-operation-external-doc |
|
before after |
annotation |
|
|
update-url-of-operation-external-doc |
| 24 |
paths.[*].[*].externalDocs.[*].description.<value> |
add-description-of-operation-external-doc |
|
before after |
annotation |
|
|
add-description-of-operation-external-doc |
| 25 |
paths.[*].[*].externalDocs.[*].description.<value> |
update-description-of-operation-external-doc |
|
before after |
annotation |
|
|
update-description-of-operation-external-doc |
| 26 |
paths.[*].[*].externalDocs.[*].description.<value> |
remove-description-of-operation-external-doc |
|
before after |
annotation |
|
|
remove-description-of-operation-external-doc |
| 27 |
paths.[*].[*].operationId.<value> |
add-operationId-value |
|
before after |
annotation |
|
|
add-operationId-value |
| 28 |
paths.[*].[*].operationId.<value> |
update-operationId-value |
|
before after |
annotation |
|
|
update-operationId-value |
| 29 |
paths.[*].[*].operationId.<value> |
remove-operationId-value |
|
before after |
annotation |
|
|
remove-operationId-value |
| 30 |
paths.[*].[*].deprecated.<value> |
add-deprecated-value |
add ‘deprecated: true’ for operation. Previously ‘deprecated’ was not specified for the operation. |
before after |
deprecated |
|
|
add-deprecated-value |
| 31 |
paths.[*].[*].deprecated.<value> |
remove-deprecated-value |
remove ‘deprecated: true’ |
before after |
deprecated |
|
|
remove-deprecated-value |
| 32 |
paths.[*].[*].deprecated.<value> |
update-deprecated-value |
change from ‘deprecated: true’ to ‘deprecated: false’ |
before after |
|
|
|
update-deprecated-value |
| 33 |
paths.[*].[*].servers.[*].url.<value> |
add-server-url |
|
before after |
annotation |
|
|
add-server-url |
| 34 |
paths.[*].[*].servers.[*].url.<value> |
update-server-url |
|
before after |
annotation |
|
|
update-server-url |
| 35 |
paths.[*].[*].servers.[*].url.<value> |
remove-server-url |
|
before after |
annotation |
|
|
remove-server-url |
| 36 |
paths.[*].[*].servers.[*].description.<value> |
add-server-description |
|
before after |
annotation |
|
|
add-server-description |
| 37 |
paths.[*].[*].servers.[*].description.<value> |
update-server-description |
|
before after |
annotation |
|
|
update-server-description |
| 38 |
paths.[*].[*].servers.[*].description.<value> |
remove-server-description |
|
before after |
annotation |
|
|
remove-server-description |
| 39 |
paths.[*].[*].servers.[*].variables.[*] |
add-variable |
add variable for server |
before after |
2 annotations: for change in URL for adding variable |
|
|
add-variable |
| 40 |
paths.[*].[*].servers.[*].variables.[*] |
remove-variable |
remove variable for server |
before after |
2 annotations: for changing URL for removing variable |
|
|
remove-variable |
| 41 |
paths.[*].[*].servers.[*].variables.[*].default.<value> |
update-variable-default-value |
|
before after |
annotation |
|
|
update-variable-default-value |
| 42 |
paths.[*].[*].servers.[*].variables.[*].enum.<value> |
add-variable-enum |
add enum for variable of server |
before after |
2 annotations for each enum value |
|
|
add-variable-enum |
| 43 |
paths.[*].[*].servers.[*].variables.[*].enum.<value> |
update-variable-enum |
update enum value for variable of server |
before after |
annotation |
|
|
update-variable-enum |
| 44 |
paths.[*].[*].servers.[*].variables.[*].enum.<value> |
remove-variable-enum |
remove enum value for variable of server |
before after |
annotations for each enum |
|
|
remove-variable-enum |
| 45 |
paths.[*].[*].servers.[*].variables.[*].description.<value> |
add-server-variable-description |
|
before after |
annotation |
|
|
add-server-variable-description |
| 46 |
paths.[*].[*].servers.[*].variables.[*].description.<value> |
update-server-variable-description |
|
before after |
annotation |
|
|
update-server-variable-description |
| 47 |
paths.[*].[*].servers.[*].variables.[*].description.<value> |
remove-server-variable-description |
|
before after |
annotation |
|
|
remove-server-variable-description |
| 48 |
paths.[*].[*].security.[*] |
add-security-with-authentication-method |
|
before after |
breaking |
Approved |
|
add-security-with-authentication-method |
| 49 |
paths.[*].[*].security.[*] |
add-alternative-authentication-method |
combine the security using logical OR |
before after |
non-breaking |
Approved |
|
add-alternative-authentication-method |
| 50 |
paths.[*].[*].security.[*] |
add-mandatory-authentication-method |
combine the security using logical AND |
before after |
breaking |
Approved |
|
add-mandatory-authentication-method |
| 51 |
paths.[*].[*].security.[*] |
remove-alternative-authentication-method |
with logical OR |
before after |
breaking |
Approved |
|
remove-alternative-authentication-method |
| 52 |
paths.[*].[*].security.[*] |
remove-mandatory-authentication-method |
with logical AND |
before after |
breaking |
Approved |
|
remove-mandatory-authentication-method |
| 53 |
paths.[*].[*].security.[*] |
remove-security-with-authentication-method |
|
before after |
breaking |
Approved |
|
remove-security-with-authentication-method |
| 54 |
paths.[*].[*].security.[*].[<scope>] (for OAuth) |
add-scope-for-authentication-method |
|
before after |
breaking |
Approved |
|
add-scope-for-authentication-method |
| 55 |
paths.[*].[*].security.[*].[<scope>] |
update-scope-for-authentication-method |
|
before after |
breaking |
Approved |
|
update-scope-for-authentication-method |
| 56 |
paths.[*].[*].security.[*].[<scope>] |
remove-scope-for-authentication-method |
|
before after |
non-breaking |
Approved |
|
remove-scope-for-authentication-method |
| 57 |
components.securitySchemes.x-* |
add-custom-property-in-security-schemes |
|
before after |
non-breaking |
|
|
add-custom-property-in-security-schemes |
| 58 |
components.securitySchemes.x-* |
update-custom-property-value-in-security-schemes |
|
before after |
non-breaking |
|
|
update-custom-property-value-in-security-schemes |
| 59 |
components.securitySchemes.x-* |
remove-custom-property-in-security-schemes |
|
before after |
non-breaking |
|
|
remove-custom-property-in-security-schemes |
| 60 |
pathItems.[*].[<method>] (OAS 3.1) |
add-method-in-path-item |
add method to pathItem (OAS 3.1 pathItems) |
before after |
non-breaking |
|
[3.1.0, 3.1.0] |
add-method-in-path-item |
| 61 |
pathItems.[*].[<method>] (OAS 3.1) |
add-unused-method-in-path-item |
add unused method to pathItem (OAS 3.1) |
before after |
annotation |
|
[3.1.0, 3.1.0] |
add-unused-method-in-path-item |
| 62 |
pathItems.[*].[<method>] (OAS 3.1) |
remove-method-in-path-item |
remove method from pathItem (OAS 3.1) |
before after |
breaking |
|
[3.1.0, 3.1.0] |
remove-method-in-path-item |
| 63 |
pathItems.[*].[<method>] (OAS 3.1) |
remove-unused-method-in-path-item |
remove unused method from pathItem (OAS 3.1) |
before after |
annotation |
|
[3.1.0, 3.1.0] |
remove-unused-method-in-path-item |
| 64 |
pathItems.[*] (OAS 3.1) |
replace-inline-path-item-to-ref |
replace inline pathItem with $ref (OAS 3.1) |
before after |
annotation |
|
[3.1.0, 3.1.0], [3.0.0, 3.1.0] |
replace-inline-path-item-to-ref |
| 65 |
pathItems.[*] (OAS 3.1) |
replace-ref-path-item-to-inline |
replace $ref pathItem with inline (OAS 3.1) |
before after |
annotation |
|
[3.1.0, 3.1.0], [3.1.0, 3.0.0] |
replace-ref-path-item-to-inline |