You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/BREAKING-CHANGES-EXAMPLES.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,6 @@
1
1
# Examples of Breaking and Non-Breaking Changes
2
2
These examples are automatically generated from unit tests.
3
3
## Examples of breaking changes
4
-
[Deleting a value from an x-extensible-enum parameter is breaking](../checker/check_request_parameter_x_extensible_enum_value_removed_test.go?plain=1#L11)
5
-
[Deleting a value from an x-extensible-enum property is breaking](../checker/check_request_property_x_extensible_enum_value_removed_test.go?plain=1#L11)
6
4
[adding 'allOf' subschema to the request body or request body property is breaking](../checker/check_breaking_test.go?plain=1#L703)
7
5
[adding 'oneOf' schema to the response body or response body property is breaking](../checker/check_response_property_one_of_updated_test.go?plain=1#L12)
8
6
[adding a new required property in request body is breaking](../checker/check_breaking_property_test.go?plain=1#L353)
@@ -60,6 +58,8 @@ These examples are automatically generated from unit tests.
60
58
[deleting a required property in request is breaking with warn](../checker/check_breaking_property_test.go?plain=1#L369)
61
59
[deleting a required property in response body is breaking](../checker/check_breaking_property_test.go?plain=1#L421)
62
60
[deleting a required property under AllOf in response body is breaking](../checker/check_breaking_property_test.go?plain=1#L451)
61
+
[Deleting a value from an x-extensible-enum parameter is breaking](../checker/check_request_parameter_x_extensible_enum_value_removed_test.go?plain=1#L11)
62
+
[Deleting a value from an x-extensible-enum property is breaking](../checker/check_request_property_x_extensible_enum_value_removed_test.go?plain=1#L11)
63
63
[deleting an embedded optional property in request is breaking with warn](../checker/check_breaking_property_test.go?plain=1#L386)
64
64
[deleting an enum value is breaking](../checker/check_breaking_test.go?plain=1#L77)
65
65
[deleting an operation before sunset date is breaking](../checker/check_api_removed_test.go?plain=1#L51)
@@ -174,8 +174,8 @@ These examples are automatically generated from unit tests.
174
174
[increasing min items in response is not breaking](../checker/check_breaking_min_max_test.go?plain=1#L250)
175
175
[increasing stability level is not breaking](../checker/checker_test.go?plain=1#L33)
176
176
[modifying a media type name in response to make it more specific is not breaking](../checker/check_response_mediatype_name_updated_test.go?plain=1#L26)
177
-
[modifying a pattern to ".*" in a schema is not breaking](../checker/check_breaking_test.go?plain=1#L532)
178
177
[modifying a pattern to .* in a schema is not breaking](../checker/check_breaking_test.go?plain=1#L501)
178
+
[modifying a pattern to ".*" in a schema is not breaking](../checker/check_breaking_test.go?plain=1#L532)
179
179
[modifying the default value of a required request parameter is not breaking](../checker/check_breaking_test.go?plain=1#L600)
180
180
[new optional header param is not breaking](../checker/check_not_breaking_test.go?plain=1#L118)
181
181
[new optional property in request header is not breaking](../checker/check_breaking_property_test.go?plain=1#L39)
@@ -300,15 +300,15 @@ These examples are automatically generated from unit tests.
300
300
[decreasing max length of request body](../checker/check_request_property_max_length_updated_test.go?plain=1#L40)
301
301
[decreasing max length of request property](../checker/check_request_property_max_length_updated_test.go?plain=1#L68)
302
302
[decreasing max length of request read-only property](../checker/check_request_property_max_length_updated_test.go?plain=1#L96)
303
+
[decreasing maximum value of request parameter](../checker/check_request_parameters_max_updated_test.go?plain=1#L34)
303
304
[decreasing maxItems of request parameters](../checker/check_request_parameters_max_items_updated_test.go?plain=1#L35)
304
305
[decreasing maxLength of request parameters](../checker/check_request_parameters_max_length_updated_test.go?plain=1#L33)
305
-
[decreasing maximum value of request parameter](../checker/check_request_parameters_max_updated_test.go?plain=1#L34)
306
+
[decreasing minimum value of request parameter](../checker/check_request_parameters_min_updated_test.go?plain=1#L34)
307
+
[decreasing minimum value of request property](../checker/check_request_property_min_updated_test.go?plain=1#L60)
306
308
[decreasing minItems value of request parameter](../checker/check_request_parameters_min_items_updated_test.go?plain=1#L34)
307
309
[decreasing minLength of request body](../checker/check_request_property_min_length_updated_test.go?plain=1#L84)
308
310
[decreasing minLength of request property](../checker/check_request_property_min_length_updated_test.go?plain=1#L12)
309
311
[decreasing minLength value of request parameter](../checker/check_request_parameters_min_length_updated_test.go?plain=1#L35)
310
-
[decreasing minimum value of request parameter](../checker/check_request_parameters_min_updated_test.go?plain=1#L34)
311
-
[decreasing minimum value of request property](../checker/check_request_property_min_updated_test.go?plain=1#L60)
312
312
[decreasing request body maximum value](../checker/check_request_property_max_updated_test.go?plain=1#L119)
313
313
[decreasing request property maximum value](../checker/check_request_property_max_updated_test.go?plain=1#L12)
314
314
[decreasing request read-only property maximum value](../checker/check_request_property_max_updated_test.go?plain=1#L38)
@@ -319,16 +319,16 @@ These examples are automatically generated from unit tests.
319
319
[generalizing request's query param property type from integer to number](../checker/check_request_parameters_type_changed_test.go?plain=1#L242)
320
320
[increasing max length of request body](../checker/check_request_property_max_length_updated_test.go?plain=1#L12)
321
321
[increasing max length of request property](../checker/check_request_property_max_length_updated_test.go?plain=1#L126)
322
+
[increasing maximum value of request parameter](../checker/check_request_parameters_max_updated_test.go?plain=1#L12)
322
323
[increasing maxItems of request parameters](../checker/check_request_parameters_max_items_updated_test.go?plain=1#L13)
323
324
[increasing maxLength of request parameters](../checker/check_request_parameters_max_length_updated_test.go?plain=1#L12)
324
-
[increasing maximum value of request parameter](../checker/check_request_parameters_max_updated_test.go?plain=1#L12)
325
+
[increasing minimum value of request parameter](../checker/check_request_parameters_min_updated_test.go?plain=1#L12)
326
+
[increasing minimum value of request property](../checker/check_request_property_min_updated_test.go?plain=1#L12)
327
+
[increasing minimum value of request read-only property](../checker/check_request_property_min_updated_test.go?plain=1#L35)
325
328
[increasing minItems value of request parameter](../checker/check_request_parameters_min_items_updated_test.go?plain=1#L12)
326
329
[increasing minLength of request body](../checker/check_request_property_min_length_updated_test.go?plain=1#L60)
327
330
[increasing minLength of request property](../checker/check_request_property_min_length_updated_test.go?plain=1#L36)
328
331
[increasing minLength value of request parameter](../checker/check_request_parameters_min_length_updated_test.go?plain=1#L12)
329
-
[increasing minimum value of request parameter](../checker/check_request_parameters_min_updated_test.go?plain=1#L12)
330
-
[increasing minimum value of request property](../checker/check_request_property_min_updated_test.go?plain=1#L12)
331
-
[increasing minimum value of request read-only property](../checker/check_request_property_min_updated_test.go?plain=1#L35)
332
332
[increasing request body maximum value](../checker/check_request_property_max_updated_test.go?plain=1#L91)
333
333
[increasing request property maximum value](../checker/check_request_property_max_updated_test.go?plain=1#L65)
334
334
[making request property required, while also giving it a default value](../checker/check_request_property_required_updated_test.go?plain=1#L58)
0 commit comments