Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@reuvenharrison
reuvenharrison committed Nov 25, 2024
1 parent ac2f9e2 commit 9643eed
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions docs/BREAKING-CHANGES-EXAMPLES.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ These examples are automatically generated from unit tests.
[deleting an operation before sunset date is breaking](../checker/check_api_removed_test.go?plain=1#L11)
[deleting an operation is breaking](../checker/check_breaking_test.go?plain=1#L45)
[deleting sunset header for a deprecated endpoint is breaking](../checker/check_api_sunset_changed_test.go?plain=1#L11)
[deprecating an operation with a deprecation policy and an invalid stability level is breaking](../checker/check_api_deprecation_test.go?plain=1#L67)
[deprecating an operation with a deprecation policy and an invalid sunset date is breaking](../checker/check_api_deprecation_test.go?plain=1#L48)
[deprecating an operation with a deprecation policy and sunset date before required deprecation period is breaking](../checker/check_api_deprecation_test.go?plain=1#L214)
[deprecating an operation with a deprecation policy but without specifying sunset date is breaking](../checker/check_api_deprecation_test.go?plain=1#L103)
[deprecating an operation with a deprecation policy and an invalid stability level is breaking](../checker/check_api_deprecation_test.go?plain=1#L73)
[deprecating an operation with a deprecation policy and an invalid sunset date is breaking](../checker/check_api_deprecation_test.go?plain=1#L54)
[deprecating an operation with a deprecation policy and sunset date before required deprecation period is breaking](../checker/check_api_deprecation_test.go?plain=1#L220)
[deprecating an operation with a deprecation policy but without specifying sunset date is breaking](../checker/check_api_deprecation_test.go?plain=1#L109)
[inclreasing request body min items is breaking](../checker/check_request_property_min_items_increased_test.go?plain=1#L12)
[increasing max length in response is breaking](../checker/check_breaking_min_max_test.go?plain=1#L93)
[increasing min items in request is breaking](../checker/check_breaking_min_max_test.go?plain=1#L236)
Expand Down Expand Up @@ -129,21 +129,21 @@ These examples are automatically generated from unit tests.
[changing response's body schema type from number to integer is not breaking](../checker/check_breaking_response_type_changed_test.go?plain=1#L52)
[changing response's body schema type from number/none to integer/int32 is not breaking](../checker/check_breaking_response_type_changed_test.go?plain=1#L90)
[changing servers is not breaking](../checker/check_not_breaking_test.go?plain=1#L252)
[deleting a path after sunset date of all contained operations is not breaking](../checker/check_api_deprecation_test.go?plain=1#L255)
[deleting a path after sunset date of all contained operations is not breaking](../checker/check_api_deprecation_test.go?plain=1#L261)
[deleting a pattern from a schema is not breaking](../checker/check_breaking_test.go?plain=1#L459)
[deleting a required write-only property in response body is not breaking](../checker/check_breaking_property_test.go?plain=1#L495)
[deleting a tag is not breaking](../checker/check_not_breaking_test.go?plain=1#L71)
[deleting an operation after sunset date is not breaking](../checker/check_api_deprecation_test.go?plain=1#L33)
[deleting an operation after sunset date is not breaking](../checker/check_api_deprecation_test.go?plain=1#L39)
[deleting an operation without sunset date is not breaking](../checker/check_api_removed_test.go?plain=1#L29)
[deleting other extension (not sunset) header for a deprecated endpoint is not breaking](../checker/check_api_sunset_changed_test.go?plain=1#L84)
[deprecating a header is not breaking](../checker/check_not_breaking_test.go?plain=1#L226)
[deprecating a parameter is not breaking](../checker/check_not_breaking_test.go?plain=1#L213)
[deprecating a schema is not breaking](../checker/check_not_breaking_test.go?plain=1#L239)
[deprecating an operation with a default deprecation policy but without specifying sunset date is not breaking](../checker/check_api_deprecation_test.go?plain=1#L121)
[deprecating an operation with a deprecation policy and sunset date after required deprecation period is not breaking](../checker/check_api_deprecation_test.go?plain=1#L234)
[deprecating an operation without a deprecation policy and without specifying sunset date is not breaking for alpha level](../checker/check_api_deprecation_test.go?plain=1#L137)
[deprecating an operation without a deprecation policy and without specifying sunset date is not breaking for draft level](../checker/check_api_deprecation_test.go?plain=1#L171)
[deprecating an operation without a deprecation policy but without specifying sunset date is not breaking](../checker/check_api_deprecation_test.go?plain=1#L87)
[deprecating an operation with a default deprecation policy but without specifying sunset date is not breaking](../checker/check_api_deprecation_test.go?plain=1#L127)
[deprecating an operation with a deprecation policy and sunset date after required deprecation period is not breaking](../checker/check_api_deprecation_test.go?plain=1#L240)
[deprecating an operation without a deprecation policy and without specifying sunset date is not breaking for alpha level](../checker/check_api_deprecation_test.go?plain=1#L143)
[deprecating an operation without a deprecation policy and without specifying sunset date is not breaking for draft level](../checker/check_api_deprecation_test.go?plain=1#L177)
[deprecating an operation without a deprecation policy but without specifying sunset date is not breaking](../checker/check_api_deprecation_test.go?plain=1#L93)
[descreasing request body min items is not breaking](../checker/check_request_property_min_items_increased_test.go?plain=1#L35)
[increasing max length in request is not breaking](../checker/check_breaking_min_max_test.go?plain=1#L76)
[increasing min items in response is not breaking](../checker/check_breaking_min_max_test.go?plain=1#L250)
Expand All @@ -162,8 +162,8 @@ These examples are automatically generated from unit tests.
[reducing min length in request is not breaking](../checker/check_breaking_min_max_test.go?plain=1#L48)
[removing an existing response with error status is not breaking](../checker/check_breaking_test.go?plain=1#L406)
[removing an existing response with unparseable status is not breaking](../checker/check_breaking_test.go?plain=1#L390)
[removing the path without a deprecation policy and without specifying sunset date is not breaking for alpha level](../checker/check_api_deprecation_test.go?plain=1#L152)
[removing the path without a deprecation policy and without specifying sunset date is not breaking for draft level](../checker/check_api_deprecation_test.go?plain=1#L188)
[removing the path without a deprecation policy and without specifying sunset date is not breaking for alpha level](../checker/check_api_deprecation_test.go?plain=1#L158)
[removing the path without a deprecation policy and without specifying sunset date is not breaking for draft level](../checker/check_api_deprecation_test.go?plain=1#L194)
[renaming a path parameter is not breaking](../checker/check_breaking_test.go?plain=1#L136)

## Examples of info-level changes for changelog
Expand Down Expand Up @@ -306,8 +306,8 @@ These examples are automatically generated from unit tests.
[making request property required, while also giving it a default value](../checker/check_request_property_required_updated_test.go?plain=1#L58)
[new header, query and cookie request params](../checker/check_new_request_non_path_parameter_test.go?plain=1#L11)
[new paths or path operations](../checker/check_api_added_test.go?plain=1#L11)
[path operations that became deprecated](../checker/check_api_deprecation_test.go?plain=1#L270)
[path operations that were re-activated](../checker/check_api_deprecation_test.go?plain=1#L293)
[path operations that became deprecated](../checker/check_api_deprecation_test.go?plain=1#L276)
[path operations that were re-activated](../checker/check_api_deprecation_test.go?plain=1#L299)
[removing 'allOf' subschema from the request body or request body property](../checker/check_request_property_all_of_updated_test.go?plain=1#L46)
[removing 'allOf' subschema from the response body or response body property](../checker/check_response_property_all_of_updated_test.go?plain=1#L46)
[removing 'anyOf' schema from the request body or request body property](../checker/check_request_property_any_of_updated_test.go?plain=1#L46)
Expand Down

0 comments on commit 9643eed

Please sign in to comment.