-
Notifications
You must be signed in to change notification settings - Fork 2
Response
Adil Bektursunov edited this page Aug 27, 2025
·
4 revisions
| Path | Change id | Comment | Example | ER | Link | |
|---|---|---|---|---|---|---|
| 1 | paths.[*].[*].responses. [] | add-new-response | add any response cod | before after | non-breaking | add-new-response |
| 2 | paths.[*].[*].responses. [] | remove-response | remove any response cod | before after | breaking | remove-response |
| 3 | paths.[*].[*].responses.[*].description. | add-response-description | before after | annotation | add-response-description | |
| 4 | paths.[*].[*].responses.[*].description. | update-response-description | before after | annotation | update-response-description | |
| 5 | paths.[*].[*].responses.[*].description. | remove-response-description | before after | annotation | remove-response-description | |
| 6 | paths.[*].[*].responses.[*]. headers | add-response-header | before after | non-breaking | add-response-header | |
| 7 | paths.[*].[*].responses.[*]. headers | remove-response-header | before after | breaking | remove-response-header | |
| 8 | paths.[*].[*].responses.[*].headers. [] | update-header-name | before after | update-header-name | ||
| 9 | paths.[*].[*].responses.[*].headers.[*].required. | add-required-attribute-with-default-value-for-header | before after | [not supported] | add-required-attribute-with-default-value-for-header | |
| 10 | paths.[*].[*].responses.[*].headers.[*].required. | remove-required-attribute-with-default-value-from-header | before after | [not supported] | remove-required-attribute-with-default-value-from-header | |
| 11 | paths.[*].[*].responses.[*].headers.[*].deprecated. | add-deprecated-attribute-with-default-value-for-header | before after | [not supported] | add-deprecated-attribute-with-default-value-for-header | |
| 12 | paths.[*].[*].responses.[*].headers.[*].deprecated. | remove-deprecated-attribute-with-default-value-from-header | before after | [not supported] | remove-deprecated-attribute-with-default-value-from-header | |
| 13 | paths.[*].[*].responses.[*].headers.[*]. allowEmptyValue . | add-allowEmptyValue-attribute-with-default-value-for-header | before after | [not supported] | add-allowEmptyValue-attribute-with-default-value-for-header | |
| 14 | paths.[*].[*].responses.[*].headers.[*]. allowEmptyValue . | remove-allowEmptyValue-attribute-with-default-value-from-header | before after | [not supported] | remove-allowEmptyValue-attribute-with-default-value-from-header | |
| 15 | paths.[*].[*].responses.[*].headers.[*]. allowReserved . | add-allowReserved-attribute-with-default-value-for-header | before after | [not supported] | add-allowReserved-attribute-with-default-value-for-header | |
| 16 | paths.[*].[*].responses.[*].headers.[*]. allowReserved . | remove-allowReserved-attribute-with-default-value-from-header | before after | [not supported] | remove-allowReserved-attribute-with-default-value-from-header | |
| 17 | paths.[*].[*].responses.[*].headers.[*]. required . | mark-header-as-required | before after | breaking [not supported] | mark-header-as-required | |
| 18 | paths.[*].[*].responses.[*].headers.[*]. required . | update-required-attribute-from-false-to-true-for-header | before after | breaking [not supported] | update-required-attribute-from-false-to-true-for-header | |
| 19 | paths.[*].[*].responses.[*].headers.[*]. required . | mark-header-as-optional | before after | non-breaking [not supported] | mark-header-as-optional | |
| 20 | paths.[*].[*].responses.[*].headers.[*]. examples | add-example-for-header | before after | annotation [not supported] | add-example-for-header | |
| 21 | paths.[*].[*].responses.[*].headers.[*]. examples.[*].value. | update-value-of-header-example | before after | annotation [not supported] | update-value-of-header-example | |
| 22 | paths.[*].[*].responses.[*].headers.[*]. examples | remove-example-from-header | before after | annotation [not supported] | remove-example-from-header | |
| 23 | paths.[*].[*].responses.[*].headers.[*].description. | add-header-description | before after | annotation | add-header-description | |
| 24 | paths.[*].[*].responses.[*].headers.[*].description. | update-header-description | before after | annotation | update-header-description | |
| 25 | paths.[*].[*].responses.[*].headers.[*].description. | remove-header-description | before after | annotation | remove-header-description | |
| 26 | paths.[*].[*].responses.[*].content.[*].encoding.[*].contentType . | add-allowReserved-attribute-with-default-value-for-response-parameter-encoding | before after | [not supported] | add-allowReserved-attribute-with-default-value-for-response-parameter-encoding | |
| 27 | paths.[*].[*].responses.[*].content.[*].encoding.[*].contentType . | remove-allowReserved-attribute-with-default-value-from-response-parameter-encoding | before after | [not supported] | remove-allowReserved-attribute-with-default-value-from-response-parameter-encoding | |
| 28 | paths.[*].[*].responses.[*]. [] | add-custom-property-for-response | 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-for-response |
| 29 | paths.[*].[*].responses.[*].[]. | update-custom-property-value-in-response | 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-in-response |
| 30 | paths.[*].[*].responses.[*]. [] | remove-custom-property-from-response | 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-from-response |
| 31 | paths.[*].[*].responses.[*]. links | add-link | OAS links, ER shall define subsequent actions based on the response - each link must reference a valid target operation | before after | non-breaking | add-link |
| 32 | remove-link | OAS links, ER shall define subsequent actions based on the response - each link must reference a valid target operation | before after | breaking | remove-link | |
| 33 | update-link | OAS links, ER shall define subsequent actions based on the response - each link must reference a valid target operation | before after | breaking | update-link | |
| 34 | update-operationRef | OAS links, ER shall define subsequent actions based on the response - operationRef is updated to point to another operation | before after | breaking | update-operationRef | |
| 35 | update-operationId | OAS links, ER shall define subsequent actions based on the response - operationId is updated to point to another operation | before after | breaking | update-operationId | |
| 36 | paths.[*].[*].responses.[*].links.[*] .parameters | add-parameters | OAS links, ER shall define subsequent actions based on the response - parameters adds map of parameters to pass | before after | non-breaking | add-parameters |
| 37 | remove-parameters | OAS links, ER shall define subsequent actions based on the response - parameters is removed | before after | breaking | remove-parameters | |
| 38 | update-parameters | OAS links, ER shall define subsequent actions based on the response - parameters is updated to pass new values | before after | breaking | update-parameters | |
| 39 | paths.[*].[*].responses.[*].links.[*] .requestBody | add-requestBody | OAS links, ER shall define subsequent actions based on the response - requestBody adds body to be passed to the linked operation | before after | non-breaking | add-requestBody |
| 40 | remove-requestBody | OAS links, ER shall define subsequent actions based on the response - requestBody is removed | before after | breaking | remove-requestBody | |
| 41 | update-requestBody | OAS links, ER shall define subsequent actions based on the response - requestBody is updated to pass new body content | before after | breaking | update-requestBody | |
| 42 | paths.[*].[*].responses.[*].links.[*] .description | add-description | OAS links, ER shall define subsequent actions based on the response - description adds context to the link | before after | annotation | add-description |
| 43 | remove-description | OAS links, ER shall define subsequent actions based on the response - description is removed | before after | annotation | remove-description | |
| 44 | update-description | OAS links, ER shall define subsequent actions based on the response - description is updated | before after | annotation | update-description | |
| 45 | paths.[*].[*].responses.[*].links.[*] .server | add-server | OAS links, ER shall define subsequent actions based on the response - server adds a server object to the link | before after | non-breaking | add-server |
| 46 | remove-server | OAS links, ER shall define subsequent actions based on the response - server is removed | before after | breaking | remove-server | |
| 47 | update-server | OAS links, ER shall define subsequent actions based on the response - server is updated to point to a different server | before after | breaking | update-server |