Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove-hardcoded-quotes #455

Merged
merged 5 commits into from
Dec 7, 2023
Merged

remove-hardcoded-quotes #455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
334339d
remove quotes
Dec 7, 2023
bc90ddd
add tests
Dec 7, 2023
4d0b45d
remove quotes
Dec 7, 2023
0273e61
add tests
Dec 7, 2023
8b2d850
Merge branch 'remove-hardcoded-quotes' of https://github.com/Tufin/oa…
Dec 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 36 additions & 36 deletions BREAKING-CHANGES-EXAMPLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Examples of Breaking and Non-Breaking Changes
These examples are automatically generated from unit tests.
## Examples of breaking changes
[adding 'allOf' subschema to the request body or request body property is breaking](checker/checker_breaking_test.go?plain=1#L693)
[adding 'allOf' subschema to the request body or request body property is breaking](checker/checker_breaking_test.go?plain=1#L718)
[adding a new required property in request body is breaking](checker/checker_breaking_property_test.go?plain=1#L352)
[adding a pattern to a schema is breaking for recursive properties](checker/checker_breaking_test.go?plain=1#L474)
[adding a pattern to a schema is breaking](checker/checker_breaking_test.go?plain=1#L458)
[adding a required request body is breaking](checker/checker_breaking_test.go?plain=1#L65)
[adding a pattern to a schema is breaking for recursive properties](checker/checker_breaking_test.go?plain=1#L496)
[adding a pattern to a schema is breaking](checker/checker_breaking_test.go?plain=1#L479)
[adding a required request body is breaking](checker/checker_breaking_test.go?plain=1#L67)
[changing a request body to enum is breaking](checker/checker_breaking_property_test.go?plain=1#L122)
[changing a request body type and changing it to enum simultaneously is breaking](checker/checker_breaking_property_test.go?plain=1#L152)
[changing a request property to not nullable is breaking](checker/checker_breaking_property_test.go?plain=1#L232)
Expand All @@ -14,7 +14,7 @@ These examples are automatically generated from unit tests.
[changing a response property to nullable is breaking](checker/checker_breaking_property_test.go?plain=1#L248)
[changing a response property to optional under AllOf, AnyOf or OneOf is breaking](checker/checker_breaking_property_test.go?plain=1#L643)
[changing an embedded response property to nullable is breaking](checker/checker_breaking_property_test.go?plain=1#L264)
[changing an existing header param from optional to required is breaking](checker/checker_breaking_test.go?plain=1#L187)
[changing an existing header param from optional to required is breaking](checker/checker_breaking_test.go?plain=1#L196)
[changing an existing header param to enum is breaking](checker/checker_breaking_property_test.go?plain=1#L184)
[changing an existing property in request body anyOf to required is breaking](checker/checker_breaking_property_test.go?plain=1#L611)
[changing an existing property in request body items to required is breaking](checker/checker_breaking_property_test.go?plain=1#L595)
Expand All @@ -24,9 +24,9 @@ These examples are automatically generated from unit tests.
[changing an existing property in request header to required is breaking](checker/checker_breaking_property_test.go?plain=1#L56)
[changing an existing property in response body to optional is breaking](checker/checker_breaking_property_test.go?plain=1#L106)
[changing an existing property under another property in request body to required is breaking](checker/checker_breaking_property_test.go?plain=1#L627)
[changing an existing request body from optional to required is breaking](checker/checker_breaking_test.go?plain=1#L82)
[changing an existing request body from optional to required is breaking](checker/checker_breaking_test.go?plain=1#L85)
[changing an existing required property in response body to not-write-only is breaking](checker/checker_breaking_property_test.go?plain=1#L560)
[changing an existing response header from required to optional is breaking](checker/checker_breaking_test.go?plain=1#L210)
[changing an existing response header from required to optional is breaking](checker/checker_breaking_test.go?plain=1#L220)
[changing max length in request from nil to any value is breaking](checker/checker_breaking_min_max_test.go?plain=1#L110)
[changing max length in response from any value to nil is breaking](checker/checker_breaking_min_max_test.go?plain=1#L160)
[changing request's body schema type from number to integer is breaking](checker/checker_breaking_request_type_changed_test.go?plain=1#L51)
Expand All @@ -37,52 +37,52 @@ These examples are automatically generated from unit tests.
[changing response's body schema type from number to string is breaking](checker/checker_breaking_response_type_changed_test.go?plain=1#L31)
[changing response's body schema type from string to number is breaking](checker/checker_breaking_response_type_changed_test.go?plain=1#L11)
[changing response's embedded property schema type from string/none to integer/int32 is breaking](checker/checker_breaking_response_type_changed_test.go?plain=1#L108)
[deleting a media-type from response is breaking](checker/checker_breaking_test.go?plain=1#L428)
[deleting a media-type from response is breaking](checker/checker_breaking_test.go?plain=1#L448)
[deleting a non-required non-write-only property in response body is breaking with warning](checker/checker_breaking_property_test.go?plain=1#L511)
[deleting a path is breaking](checker/checker_breaking_test.go?plain=1#L43)
[deleting a path with some operations having sunset date in the future is breaking](checker/checker_deprecation_test.go?plain=1#L271)
[deleting a required property in request is breaking with warn](checker/checker_breaking_property_test.go?plain=1#L368)
[deleting a required property in response body is breaking](checker/checker_breaking_property_test.go?plain=1#L420)
[deleting a required property under AllOf in response body is breaking](checker/checker_breaking_property_test.go?plain=1#L450)
[deleting an embedded optional property in request is breaking with warn](checker/checker_breaking_property_test.go?plain=1#L385)
[deleting an enum value is breaking](checker/checker_breaking_test.go?plain=1#L103)
[deleting an enum value is breaking](checker/checker_breaking_test.go?plain=1#L107)
[deleting an operation before sunset date is breaking](checker/checker_deprecation_test.go?plain=1#L33)
[deleting an operation is breaking](checker/checker_breaking_test.go?plain=1#L50)
[deleting an operation is breaking](checker/checker_breaking_test.go?plain=1#L51)
[deleting an operation without sunset date is breaking](checker/checker_deprecation_test.go?plain=1#L50)
[deleting sunset header for a deprecated endpoint is breaking](checker/checker_deprecation_test.go?plain=1#L288)
[deprecating an operation with a deprecation policy and sunset date before required deprecation period is breaking](checker/checker_deprecation_test.go?plain=1#L216)
[deprecating an operation with a deprecation policy but without specifying sunset date is breaking](checker/checker_deprecation_test.go?plain=1#L82)
[increasing max length in response is breaking](checker/checker_breaking_min_max_test.go?plain=1#L93)
[increasing min items in request is breaking](checker/checker_breaking_min_max_test.go?plain=1#L236)
[modifying a pattern in a schema is breaking](checker/checker_breaking_test.go?plain=1#L490)
[modifying a pattern in request parameter is breaking](checker/checker_breaking_test.go?plain=1#L506)
[modifying the default value of an optional request parameter is breaking](checker/checker_breaking_test.go?plain=1#L536)
[modifying a pattern in a schema is breaking](checker/checker_breaking_test.go?plain=1#L513)
[modifying a pattern in request parameter is breaking](checker/checker_breaking_test.go?plain=1#L530)
[modifying the default value of an optional request parameter is breaking](checker/checker_breaking_test.go?plain=1#L561)
[new header, query and cookie required request default param is breaking](checker/check-new-request-non-path-default-parameter_test.go?plain=1#L11)
[new required header param is breaking](checker/checker_breaking_test.go?plain=1#L171)
[new required path param is breaking](checker/checker_breaking_test.go?plain=1#L155)
[new required header param is breaking](checker/checker_breaking_test.go?plain=1#L179)
[new required path param is breaking](checker/checker_breaking_test.go?plain=1#L162)
[new required property in request header is breaking](checker/checker_breaking_property_test.go?plain=1#L17)
[reducing max in request is breaking](checker/checker_breaking_min_max_test.go?plain=1#L264)
[reducing max length in request is breaking](checker/checker_breaking_min_max_test.go?plain=1#L12)
[reducing min items in response is breaking](checker/checker_breaking_min_max_test.go?plain=1#L220)
[reducing min length in response is breaking](checker/checker_breaking_min_max_test.go?plain=1#L62)
[removing 'allOf' subschema from the request body or request body property is breaking with warn](checker/checker_breaking_test.go?plain=1#L715)
[removing 'anyOf' schema from the request body or request body property is breaking](checker/checker_breaking_test.go?plain=1#L650)
[removing 'oneOf' schema from the request body or request body property is breaking](checker/checker_breaking_test.go?plain=1#L672)
[removing a media type from request body is breaking](checker/checker_breaking_test.go?plain=1#L634)
[removing 'allOf' subschema from the request body or request body property is breaking with warn](checker/checker_breaking_test.go?plain=1#L740)
[removing 'anyOf' schema from the request body or request body property is breaking](checker/checker_breaking_test.go?plain=1#L675)
[removing 'oneOf' schema from the request body or request body property is breaking](checker/checker_breaking_test.go?plain=1#L697)
[removing a media type from request body is breaking](checker/checker_breaking_test.go?plain=1#L659)
[removing a success status is breaking](checker/check-response-status-updated_test.go?plain=1#L86)
[removing an existing optional response header is breaking as warn](checker/checker_breaking_test.go?plain=1#L409)
[removing an existing required response header is breaking as error](checker/checker_breaking_test.go?plain=1#L226)
[removing an existing response with non-successful status is breaking (optional)](checker/checker_breaking_test.go?plain=1#L263)
[removing an existing response with successful status is breaking](checker/checker_breaking_test.go?plain=1#L245)
[removing an schema object from components is breaking (optional)](checker/checker_breaking_test.go?plain=1#L609)
[removing the default value of an optional request parameter is breaking](checker/checker_breaking_test.go?plain=1#L572)
[removing an existing optional response header is breaking as warn](checker/checker_breaking_test.go?plain=1#L428)
[removing an existing required response header is breaking as error](checker/checker_breaking_test.go?plain=1#L237)
[removing an existing response with non-successful status is breaking (optional)](checker/checker_breaking_test.go?plain=1#L276)
[removing an existing response with successful status is breaking](checker/checker_breaking_test.go?plain=1#L257)
[removing an schema object from components is breaking (optional)](checker/checker_breaking_test.go?plain=1#L634)
[removing the default value of an optional request parameter is breaking](checker/checker_breaking_test.go?plain=1#L597)
[removing the path without a deprecation policy and without specifying sunset date is breaking if some APIs are not alpha stability level](checker/checker_deprecation_test.go?plain=1#L135)
[removing the path without a deprecation policy and without specifying sunset date is breaking if some APIs are not draft stability level](checker/checker_deprecation_test.go?plain=1#L189)
[removing/updating a property enum in response is breaking (optional)](checker/checker_breaking_test.go?plain=1#L323)
[removing/updating a tag is breaking (optional)](checker/checker_breaking_test.go?plain=1#L340)
[removing/updating an enum in request body is breaking (optional)](checker/checker_breaking_test.go?plain=1#L301)
[removing/updating an operation id is breaking (optional)](checker/checker_breaking_test.go?plain=1#L281)
[setting the default value of an optional request parameter is breaking](checker/checker_breaking_test.go?plain=1#L554)
[removing/updating a property enum in response is breaking (optional)](checker/checker_breaking_test.go?plain=1#L339)
[removing/updating a tag is breaking (optional)](checker/checker_breaking_test.go?plain=1#L357)
[removing/updating an enum in request body is breaking (optional)](checker/checker_breaking_test.go?plain=1#L316)
[removing/updating an operation id is breaking (optional)](checker/checker_breaking_test.go?plain=1#L295)
[setting the default value of an optional request parameter is breaking](checker/checker_breaking_test.go?plain=1#L579)

## Examples of non-breaking changes
[adding a media-type to response is not breaking](checker/checker_not_breaking_test.go?plain=1#L185)
Expand Down Expand Up @@ -115,7 +115,7 @@ These examples are automatically generated from unit tests.
[changing response's body schema type from number/none to integer/int32 is not breaking](checker/checker_breaking_response_type_changed_test.go?plain=1#L89)
[changing servers is not breaking](checker/checker_not_breaking_test.go?plain=1#L253)
[deleting a path after sunset date of all contained operations is not breaking](checker/checker_deprecation_test.go?plain=1#L256)
[deleting a pattern from a schema is not breaking](checker/checker_breaking_test.go?plain=1#L444)
[deleting a pattern from a schema is not breaking](checker/checker_breaking_test.go?plain=1#L465)
[deleting a required write-only property in response body is not breaking](checker/checker_breaking_property_test.go?plain=1#L494)
[deleting a tag is not breaking](checker/checker_not_breaking_test.go?plain=1#L71)
[deleting an operation after sunset date is not breaking](checker/checker_deprecation_test.go?plain=1#L67)
Expand All @@ -127,8 +127,8 @@ These examples are automatically generated from unit tests.
[deprecating an operation without a deprecation policy and without specifying sunset date is not breaking](checker/checker_deprecation_test.go?plain=1#L101)
[increasing max length in request is not breaking](checker/checker_breaking_min_max_test.go?plain=1#L76)
[increasing min items in response is not breaking](checker/checker_breaking_min_max_test.go?plain=1#L250)
[modifying a pattern to ".*" in a schema is not breaking](checker/checker_breaking_test.go?plain=1#L522)
[modifying the default value of a required request parameter is not breaking](checker/checker_breaking_test.go?plain=1#L590)
[modifying a pattern to ".*" in a schema is not breaking](checker/checker_breaking_test.go?plain=1#L547)
[modifying the default value of a required request parameter is not breaking](checker/checker_breaking_test.go?plain=1#L615)
[new optional header param is not breaking](checker/checker_not_breaking_test.go?plain=1#L119)
[new optional property in request header is not breaking](checker/checker_breaking_property_test.go?plain=1#L38)
[new required response header param is not breaking](checker/checker_not_breaking_test.go?plain=1#L153)
Expand All @@ -137,11 +137,11 @@ These examples are automatically generated from unit tests.
[reducing max length in response is not breaking](checker/checker_breaking_min_max_test.go?plain=1#L31)
[reducing min items in request is not breaking](checker/checker_breaking_min_max_test.go?plain=1#L206)
[reducing min length in request is not breaking](checker/checker_breaking_min_max_test.go?plain=1#L48)
[removing an existing response with error status is not breaking](checker/checker_breaking_test.go?plain=1#L393)
[removing an existing response with unparseable status is not breaking](checker/checker_breaking_test.go?plain=1#L377)
[removing an existing response with error status is not breaking](checker/checker_breaking_test.go?plain=1#L412)
[removing an existing response with unparseable status is not breaking](checker/checker_breaking_test.go?plain=1#L396)
[removing the path without a deprecation policy and without specifying sunset date is not breaking for alpha level](checker/checker_deprecation_test.go?plain=1#L116)
[removing the path without a deprecation policy and without specifying sunset date is not breaking for draft level](checker/checker_deprecation_test.go?plain=1#L170)
[renaming a path parameter is not breaking](checker/checker_breaking_test.go?plain=1#L135)
[renaming a path parameter is not breaking](checker/checker_breaking_test.go?plain=1#L142)

## Examples of info-level changes for changelog
[adding 'allOf' subschema to the request body or request body property](checker/check-request-property-all-of-updated_test.go?plain=1#L11)
Expand Down
Loading
Loading