Skip to content

Commit

Permalink
Update dependencies including map abstraction and multi-types in kin-…
Browse files Browse the repository at this point in the history 
…openapi (#526)
  • Loading branch information
@dependabot
dependabot[bot] authored Apr 30, 2024
1 parent 6859bc7 commit 5ea1d0e
Show file tree
Hide file tree
Showing 172 changed files with 44,081 additions and 737 deletions.
43,203 changes: 43,203 additions & 0 deletions 2023-02-07.yaml
View file

Large diffs are not rendered by default.

609 changes: 306 additions & 303 deletions BREAKING-CHANGES-EXAMPLES.md
View file

Large diffs are not rendered by default.

89 changes: 0 additions & 89 deletions checker/check-request-parameters-type-changed.go
View file

This file was deleted.

0 checker/check-added-required-request-body.go → checker/check_added_required_request_body.go
View file
File renamed without changes.
0 checker/check-api-added.go → checker/check_api_added.go
View file
File renamed without changes.
0 checker/check-api-added_test.go → checker/check_api_added_test.go
View file
File renamed without changes.
0 checker/check-api-deprecation.go → checker/check_api_deprecation.go
View file
File renamed without changes.
0 checker/check-api-operation-id-updated.go → checker/check_api_operation_id_updated.go
View file
File renamed without changes.
0 ...er/check-api-operation-id-updated_test.go → ...er/check_api_operation_id_updated_test.go
View file
File renamed without changes.
0 checker/check-api-removed.go → checker/check_api_removed.go
View file
File renamed without changes.
0 checker/check-api-security-updated.go → checker/check_api_security_updated.go
View file
File renamed without changes.
0 checker/check-api-security-updated_test.go → checker/check_api_security_updated_test.go
View file
File renamed without changes.
0 checker/check-api-sunset-changed.go → checker/check_api_sunset_changed.go
View file
File renamed without changes.
0 checker/check-api-tag-updated.go → checker/check_api_tag_updated.go
View file
File renamed without changes.
0 checker/check-api-tag-updated_test.go → checker/check_api_tag_updated_test.go
View file
File renamed without changes.
0 checker/checker_breaking_min_max_test.go → checker/check_breaking_min_max_test.go
View file
File renamed without changes.
8 changes: 4 additions & 4 deletions checker/checker_breaking_property_test.go → checker/check_breaking_property_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ func TestBreaking_NewRequiredProperty(t *testing.T) {

s2.Spec.Paths.Value(installCommandPath).Get.Parameters.GetByInAndName(openapi3.ParameterInHeader, "network-policies").Schema.Value.Properties["courseId"] = &openapi3.SchemaRef{
Value: &openapi3.Schema{
Type: "string",
Type: &openapi3.Types{"string"},
Description: "Unique ID of the course",
},
}
Expand All @@ -43,7 +43,7 @@ func TestBreaking_NewNonRequiredProperty(t *testing.T) {

s2.Spec.Paths.Value(installCommandPath).Get.Parameters.GetByInAndName(openapi3.ParameterInHeader, "network-policies").Schema.Value.Properties["courseId"] = &openapi3.SchemaRef{
Value: &openapi3.Schema{
Type: "string",
Type: &openapi3.Types{"string"},
Description: "Unique ID of the course",
},
}
Expand All @@ -61,7 +61,7 @@ func TestBreaking_PropertyRequiredEnabled(t *testing.T) {

sr := openapi3.SchemaRef{
Value: &openapi3.Schema{
Type: "string",
Type: &openapi3.Types{"string"},
Description: "Unique ID of the course",
},
}
Expand All @@ -87,7 +87,7 @@ func TestBreaking_PropertyRequiredDisabled(t *testing.T) {

sr := openapi3.SchemaRef{
Value: &openapi3.Schema{
Type: "string",
Type: &openapi3.Types{"string"},
Description: "Unique ID of the course",
},
}
Expand Down
21 changes: 11 additions & 10 deletions ...ker_breaking_request_type_changed_test.go → ...eck_breaking_request_type_changed_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package checker_test
import (
"testing"

"github.com/getkin/kin-openapi/openapi3"
"github.com/stretchr/testify/require"
"github.com/tufin/oasdiff/checker"
"github.com/tufin/oasdiff/diff"
Expand All @@ -14,11 +15,11 @@ func TestBreaking_ReqTypeStringToNumber(t *testing.T) {

s1, err := open(file)
require.NoError(t, err)
s1.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = "string"
s1.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"string"}

s2, err := open(file)
require.NoError(t, err)
s2.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = "number"
s2.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"number"}

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand All @@ -34,11 +35,11 @@ func TestBreaking_ReqTypeNumberToString(t *testing.T) {

s1, err := open(file)
require.NoError(t, err)
s1.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = "number"
s1.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"number"}

s2, err := open(file)
require.NoError(t, err)
s2.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = "string"
s2.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"string"}

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand All @@ -54,11 +55,11 @@ func TestBreaking_ReqTypeNumberToInteger(t *testing.T) {

s1, err := open(file)
require.NoError(t, err)
s1.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = "number"
s1.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"number"}

s2, err := open(file)
require.NoError(t, err)
s2.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = "integer"
s2.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"integer"}

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand All @@ -74,11 +75,11 @@ func TestBreaking_ReqTypeIntegerToNumber(t *testing.T) {

s1, err := open(file)
require.NoError(t, err)
s1.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = "integer"
s1.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"integer"}

s2, err := open(file)
require.NoError(t, err)
s2.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = "number"
s2.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"number"}

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand All @@ -92,11 +93,11 @@ func TestBreaking_ReqTypeNumberToInt32(t *testing.T) {

s1, err := open(file)
require.NoError(t, err)
s1.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = "number"
s1.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"number"}

s2, err := open(file)
require.NoError(t, err)
s2.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = "integer"
s2.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"integer"}
s2.Spec.Paths.Value("/test").Post.RequestBody.Value.Content["application/json"].Schema.Value.Format = "int32"

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
Expand Down
21 changes: 11 additions & 10 deletions ...er_breaking_response_type_changed_test.go → ...ck_breaking_response_type_changed_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package checker_test
import (
"testing"

"github.com/getkin/kin-openapi/openapi3"
"github.com/stretchr/testify/require"
"github.com/tufin/oasdiff/checker"
"github.com/tufin/oasdiff/diff"
Expand All @@ -14,11 +15,11 @@ func TestBreaking_RespTypeStringToNumber(t *testing.T) {

s1, err := open(file)
require.NoError(t, err)
s1.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = "string"
s1.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"string"}

s2, err := open(file)
require.NoError(t, err)
s2.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = "number"
s2.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"number"}

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand All @@ -34,11 +35,11 @@ func TestBreaking_RespTypeNumberToString(t *testing.T) {

s1, err := open(file)
require.NoError(t, err)
s1.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = "number"
s1.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"number"}

s2, err := open(file)
require.NoError(t, err)
s2.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = "string"
s2.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"string"}

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand All @@ -54,11 +55,11 @@ func TestBreaking_RespTypeNumberToInteger(t *testing.T) {

s1, err := open(file)
require.NoError(t, err)
s1.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = "number"
s1.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"number"}

s2, err := open(file)
require.NoError(t, err)
s2.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = "integer"
s2.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"integer"}

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand All @@ -72,11 +73,11 @@ func TestBreaking_RespTypeIntegerToNumber(t *testing.T) {

s1, err := open(file)
require.NoError(t, err)
s1.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = "integer"
s1.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"integer"}

s2, err := open(file)
require.NoError(t, err)
s2.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = "number"
s2.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"number"}

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand All @@ -92,11 +93,11 @@ func TestBreaking_RespTypeNumberToInt32(t *testing.T) {

s1, err := open(file)
require.NoError(t, err)
s1.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = "number"
s1.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"number"}

s2, err := open(file)
require.NoError(t, err)
s2.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = "integer"
s2.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Type = &openapi3.Types{"integer"}
s2.Spec.Paths.Value("/test").Get.Responses.Value("200").Value.Content["application/json"].Schema.Value.Format = "int32"

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
Expand Down
8 changes: 4 additions & 4 deletions checker/checker_breaking_test.go → checker/check_breaking_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ func TestBreaking_ResponseSuccessStatusUpdated(t *testing.T) {
s1 := l(t, 1)
s2 := l(t, 1)

delete(s2.Spec.Paths.Value(securityScorePath).Get.Responses.Map(), "200")
s2.Spec.Paths.Value(securityScorePath).Get.Responses.Delete("200")

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand All @@ -273,7 +273,7 @@ func TestBreaking_ResponseNonSuccessStatusUpdated(t *testing.T) {
s1 := l(t, 1)
s2 := l(t, 1)

delete(s2.Spec.Paths.Value(securityScorePath).Get.Responses.Map(), "400")
s2.Spec.Paths.Value(securityScorePath).Get.Responses.Delete("400")

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand Down Expand Up @@ -393,7 +393,7 @@ func TestBreaking_ResponseUnparseableStatusRemoved(t *testing.T) {
s1 := l(t, 1)
s2 := l(t, 1)

delete(s2.Spec.Paths.Value(installCommandPath).Get.Responses.Map(), "default")
s2.Spec.Paths.Value(installCommandPath).Get.Responses.Delete("default")

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand All @@ -409,7 +409,7 @@ func TestBreaking_ResponseErrorStatusRemoved(t *testing.T) {
s1 := l(t, 1)
s2 := l(t, 1)

delete(s2.Spec.Paths.Value(securityScorePath).Get.Responses.Map(), "400")
s2.Spec.Paths.Value(securityScorePath).Get.Responses.Delete("400")

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand Down
0 checker/check-components-schemas-removed.go → checker/check_components_schemas_removed.go
View file
File renamed without changes.
0 checker/check-components-security-updated.go → checker/check_components_security_updated.go
View file
File renamed without changes.
0 ...check-components-security-updated_test.go → ...check_components_security_updated_test.go
View file
File renamed without changes.
8 changes: 4 additions & 4 deletions checker/checker_deprecation_test.go → checker/check_deprecation_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ func TestBreaking_RemovedPathForAlpha(t *testing.T) {
s2, err := open(getDeprecationFile("base-alpha-stability.yaml"))
require.NoError(t, err)

delete(s2.Spec.Paths.Map(), "/api/test")
s2.Spec.Paths.Delete("/api/test")

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand All @@ -143,7 +143,7 @@ func TestBreaking_RemovedPathForAlphaBreaking(t *testing.T) {
s2, err := open(getDeprecationFile("base-alpha-stability.yaml"))
require.NoError(t, err)

delete(s2.Spec.Paths.Map(), "/api/test")
s2.Spec.Paths.Delete("/api/test")

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand Down Expand Up @@ -183,7 +183,7 @@ func TestBreaking_RemovedPathForDraft(t *testing.T) {
s2, err := open(getDeprecationFile("base-alpha-stability.yaml"))
require.NoError(t, err)

delete(s2.Spec.Paths.Map(), "/api/test")
s2.Spec.Paths.Delete("/api/test")

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand All @@ -201,7 +201,7 @@ func TestBreaking_RemovedPathForDraftBreaking(t *testing.T) {
s2, err := open(getDeprecationFile("base-alpha-stability.yaml"))
require.NoError(t, err)

delete(s2.Spec.Paths.Map(), "/api/test")
s2.Spec.Paths.Delete("/api/test")

d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
Expand Down
0 ...new-request-non-path-default-parameter.go → ...new_request_non_path_default_parameter.go
View file
File renamed without changes.
0 ...equest-non-path-default-parameter_test.go → ...equest_non_path_default_parameter_test.go
View file
File renamed without changes.
0 ...r/check-new-request-non-path-parameter.go → ...r/check_new_request_non_path_parameter.go
View file
File renamed without changes.
0 ...ck-new-request-non-path-parameter_test.go → ...ck_new_request_non_path_parameter_test.go
View file
File renamed without changes.
0 ...k-new-requried-request-header-property.go → ...k_new_requried_request_header_property.go
View file
File renamed without changes.
0 checker/checker_not_breaking_test.go → checker/check_not_breaking_test.go
View file
File renamed without changes.
0 checker/check-request-body-became-enum.go → checker/check_request_body_became_enum.go
View file
File renamed without changes.
0 checker/check-request-body-enum-deleted.go → checker/check_request_body_enum_deleted.go
View file
File renamed without changes.
0 ...r/check-request-body-mediatype-updated.go → ...r/check_request_body_mediatype_updated.go
View file
File renamed without changes.
0 ...ck-request-body-mediatype-updated_test.go → ...ck_request_body_mediatype_updated_test.go
View file
File renamed without changes.
0 ...ck-request-body-required-value-updated.go → ...ck_request_body_required_value_updated.go
View file
File renamed without changes.
0 ...quest-body-required-value-updated_test.go → ...quest_body_required_value_updated_test.go
View file
File renamed without changes.
0 ...er/check-request-discriminator-updated.go → ...er/check_request_discriminator_updated.go
View file
File renamed without changes.
0 ...eck-request-discriminator-updated_test.go → ...eck_request_discriminator_updated_test.go
View file
File renamed without changes.
0 ...ck-request-header-property-became-enum.go → ...ck_request_header_property_became_enum.go
View file
File renamed without changes.
0 ...equest-header-property-became-required.go → ...equest_header_property_became_required.go
View file
File renamed without changes.
0 ...er/check-request-parameter-became-enum.go → ...er/check_request_parameter_became_enum.go
View file
File renamed without changes.
0 ...eck-request-parameter-became-enum_test.go → ...eck_request_parameter_became_enum_test.go
View file
File renamed without changes.
0 ...k-request-parameter-enum-value-updated.go → ...k_request_parameter_enum_value_updated.go
View file
File renamed without changes.
0 ...uest-parameter-enum-value-updated_test.go → ...uest_parameter_enum_value_updated_test.go
View file
File renamed without changes.
0 ...est-parameter-pattern-added-or-changed.go → ...est_parameter_pattern_added_or_changed.go
View file
File renamed without changes.
0 ...arameter-pattern-added-or-changed_test.go → ...arameter_pattern_added_or_changed_test.go
View file
File renamed without changes.
0 checker/check-request-parameter-removed.go → checker/check_request_parameter_removed.go
View file
File renamed without changes.
0 ...quest-parameter-required-value-updated.go → ...quest_parameter_required_value_updated.go
View file
File renamed without changes.
0 ..._parameter_required_value_updated_test.go → ..._parameter_required_value_updated_test.go
View file
File renamed without changes.
0 ...ameter-x-extensible-enum-value-removed.go → ...ameter_x_extensible_enum_value_removed.go
View file
File renamed without changes.
0 ...quest-parameters-default-value-changed.go → ...quest_parameters_default_value_changed.go
View file
File renamed without changes.
0 ...-parameters-default-value-changed_test.go → ..._parameters_default_value_changed_test.go
View file
File renamed without changes.
0 ...k-request-parameters-max-items-updated.go → ...k_request_parameters_max_items_updated.go
View file
File renamed without changes.
0 ...uest-parameters-max-items-updated_test.go → ...uest_parameters_max_items_updated_test.go
View file
File renamed without changes.
0 ...heck-request-parameters-max-length-set.go → ...heck_request_parameters_max_length_set.go
View file
File renamed without changes.
0 ...-request-parameters-max-length-updated.go → ..._request_parameters_max_length_updated.go
View file
File renamed without changes.
0 ...est-parameters-max-length-updated_test.go → ...est_parameters_max_length_updated_test.go
View file
File renamed without changes.
0 checker/check-request-parameters-max-set.go → checker/check_request_parameters_max_set.go
View file
File renamed without changes.
0 ...r/check-request-parameters-max-updated.go → ...r/check_request_parameters_max_updated.go
View file
File renamed without changes.
0 ...ck-request-parameters-max-updated_test.go → ...ck_request_parameters_max_updated_test.go
View file
File renamed without changes.
0 ...check-request-parameters-min-items-set.go → ...check_request_parameters_min_items_set.go
View file
File renamed without changes.
0 ...k-request-parameters-min-items-updated.go → ...k_request_parameters_min_items_updated.go
View file
File renamed without changes.
0 ...uest-parameters-min-items-updated_test.go → ...uest_parameters_min_items_updated_test.go
View file
File renamed without changes.
0 ...-request-parameters-min-length-updated.go → ..._request_parameters_min_length_updated.go
View file
File renamed without changes.
0 ...est-parameters-min-length-updated_test.go → ...est_parameters_min_length_updated_test.go
View file
File renamed without changes.
0 checker/check-request-parameters-min-set.go → checker/check_request_parameters_min_set.go
View file
File renamed without changes.
0 ...r/check-request-parameters-min-updated.go → ...r/check_request_parameters_min_updated.go
View file
File renamed without changes.
0 ...ck-request-parameters-min-updated_test.go → ...ck_request_parameters_min_updated_test.go
View file
File renamed without changes.
Loading

0 comments on commit 5ea1d0e

Please sign in to comment.