Skip to content

Don't lint default and examples siblings to $ref in Draft 7 and older #600

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

Open
staging-devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Don't lint default and examples siblings to $ref in Draft 7 and older #600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions src/linter/valid_default.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@ auto ValidDefault::condition(
return false;
}

// In Draft 7 and older, implementations MUST ignore keywords that are
// siblings to $ref
if (schema.defines("$ref") &&
!vocabularies.contains(
"https://json-schema.org/draft/2020-12/vocab/meta-data") &&
!vocabularies.contains(
"https://json-schema.org/draft/2019-09/vocab/meta-data")) {
return false;
}

const auto &root_base_dialect{frame.traverse(location.root.value_or(""))
.value_or(location)
.get()
Expand Down
10 changes: 10 additions & 0 deletions src/linter/valid_examples.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,16 @@ auto ValidExamples::condition(
return false;
}

// In Draft 7 and older, implementations MUST ignore keywords that are
// siblings to $ref
if (schema.defines("$ref") &&
!vocabularies.contains(
"https://json-schema.org/draft/2020-12/vocab/meta-data") &&
!vocabularies.contains(
"https://json-schema.org/draft/2019-09/vocab/meta-data")) {
return false;
}

const auto &root_base_dialect{frame.traverse(location.root.value_or(""))
.value_or(location)
.get()
Expand Down
170 changes: 170 additions & 0 deletions test/linter/linter_valid_default_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,3 +573,173 @@ TEST(Linter, valid_default_12) {

EXPECT_EQ(schema, expected);
}

TEST(Linter, valid_default_13_draft7_ref_sibling) {
sourcemeta::core::SchemaTransformer bundle;
bundle.add<sourcemeta::blaze::ValidDefault>(
sourcemeta::blaze::default_schema_compiler);

auto schema{sourcemeta::core::parse_json(R"JSON({
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"foo": { "$ref": "#/definitions/helper", "default": 1 }
},
"definitions": {
"helper": { "type": "string" }
}
})JSON")};

const auto result = bundle.apply(
schema, sourcemeta::core::schema_official_walker,
sourcemeta::core::schema_official_resolver, transformer_callback_error);

EXPECT_TRUE(result);

const auto expected{sourcemeta::core::parse_json(R"JSON({
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"foo": { "$ref": "#/definitions/helper", "default": 1 }
},
"definitions": {
"helper": { "type": "string" }
}
})JSON")};

EXPECT_EQ(schema, expected);
}

TEST(Linter, valid_default_14_draft6_ref_sibling) {
sourcemeta::core::SchemaTransformer bundle;
bundle.add<sourcemeta::blaze::ValidDefault>(
sourcemeta::blaze::default_schema_compiler);

auto schema{sourcemeta::core::parse_json(R"JSON({
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"foo": { "$ref": "#/definitions/helper", "default": 1 }
},
"definitions": {
"helper": { "type": "string" }
}
})JSON")};

const auto result = bundle.apply(
schema, sourcemeta::core::schema_official_walker,
sourcemeta::core::schema_official_resolver, transformer_callback_error);

EXPECT_TRUE(result);

const auto expected{sourcemeta::core::parse_json(R"JSON({
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"foo": { "$ref": "#/definitions/helper", "default": 1 }
},
"definitions": {
"helper": { "type": "string" }
}
})JSON")};

EXPECT_EQ(schema, expected);
}

TEST(Linter, valid_default_15_draft4_ref_sibling) {
sourcemeta::core::SchemaTransformer bundle;
bundle.add<sourcemeta::blaze::ValidDefault>(
sourcemeta::blaze::default_schema_compiler);

auto schema{sourcemeta::core::parse_json(R"JSON({
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"foo": { "$ref": "#/definitions/helper", "default": 1 }
},
"definitions": {
"helper": { "type": "string" }
}
})JSON")};

const auto result = bundle.apply(
schema, sourcemeta::core::schema_official_walker,
sourcemeta::core::schema_official_resolver, transformer_callback_error);

EXPECT_TRUE(result);

const auto expected{sourcemeta::core::parse_json(R"JSON({
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"foo": { "$ref": "#/definitions/helper", "default": 1 }
},
"definitions": {
"helper": { "type": "string" }
}
})JSON")};

EXPECT_EQ(schema, expected);
}

TEST(Linter, valid_default_16_2019_09_ref_sibling_removes) {
sourcemeta::core::SchemaTransformer bundle;
bundle.add<sourcemeta::blaze::ValidDefault>(
sourcemeta::blaze::default_schema_compiler);

auto schema{sourcemeta::core::parse_json(R"JSON({
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$defs": {
"helper": { "type": "string" }
},
"properties": {
"foo": { "$ref": "#/$defs/helper", "default": 1 }
}
})JSON")};

const auto result = bundle.apply(
schema, sourcemeta::core::schema_official_walker,
sourcemeta::core::schema_official_resolver, transformer_callback_error);

EXPECT_TRUE(result);

const auto expected{sourcemeta::core::parse_json(R"JSON({
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$defs": {
"helper": { "type": "string" }
},
"properties": {
"foo": { "$ref": "#/$defs/helper" }
}
})JSON")};

EXPECT_EQ(schema, expected);
}

TEST(Linter, valid_default_17_2020_12_ref_sibling_removes) {
sourcemeta::core::SchemaTransformer bundle;
bundle.add<sourcemeta::blaze::ValidDefault>(
sourcemeta::blaze::default_schema_compiler);

auto schema{sourcemeta::core::parse_json(R"JSON({
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$defs": {
"helper": { "type": "string" }
},
"properties": {
"foo": { "$ref": "#/$defs/helper", "default": 1 }
}
})JSON")};

const auto result = bundle.apply(
schema, sourcemeta::core::schema_official_walker,
sourcemeta::core::schema_official_resolver, transformer_callback_error);

EXPECT_TRUE(result);

const auto expected{sourcemeta::core::parse_json(R"JSON({
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$defs": {
"helper": { "type": "string" }
},
"properties": {
"foo": { "$ref": "#/$defs/helper" }
}
})JSON")};

EXPECT_EQ(schema, expected);
}
136 changes: 136 additions & 0 deletions test/linter/linter_valid_examples_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -615,3 +615,139 @@ TEST(Linter, valid_examples_13) {

EXPECT_EQ(schema, expected);
}

TEST(Linter, valid_examples_14_draft7_ref_sibling) {
sourcemeta::core::SchemaTransformer bundle;
bundle.add<sourcemeta::blaze::ValidExamples>(
sourcemeta::blaze::default_schema_compiler);

auto schema{sourcemeta::core::parse_json(R"JSON({
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"foo": { "$ref": "#/definitions/helper", "examples": [ 1 ] }
},
"definitions": {
"helper": { "type": "string" }
}
})JSON")};

const auto result = bundle.apply(
schema, sourcemeta::core::schema_official_walker,
sourcemeta::core::schema_official_resolver, transformer_callback_error);

EXPECT_TRUE(result);

const auto expected{sourcemeta::core::parse_json(R"JSON({
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"foo": { "$ref": "#/definitions/helper", "examples": [ 1 ] }
},
"definitions": {
"helper": { "type": "string" }
}
})JSON")};

EXPECT_EQ(schema, expected);
}

TEST(Linter, valid_examples_15_draft6_ref_sibling) {
sourcemeta::core::SchemaTransformer bundle;
bundle.add<sourcemeta::blaze::ValidExamples>(
sourcemeta::blaze::default_schema_compiler);

auto schema{sourcemeta::core::parse_json(R"JSON({
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"foo": { "$ref": "#/definitions/helper", "examples": [ 1 ] }
},
"definitions": {
"helper": { "type": "string" }
}
})JSON")};

const auto result = bundle.apply(
schema, sourcemeta::core::schema_official_walker,
sourcemeta::core::schema_official_resolver, transformer_callback_error);

EXPECT_TRUE(result);

const auto expected{sourcemeta::core::parse_json(R"JSON({
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"foo": { "$ref": "#/definitions/helper", "examples": [ 1 ] }
},
"definitions": {
"helper": { "type": "string" }
}
})JSON")};

EXPECT_EQ(schema, expected);
}

TEST(Linter, valid_examples_16_2019_09_ref_sibling_removes) {
sourcemeta::core::SchemaTransformer bundle;
bundle.add<sourcemeta::blaze::ValidExamples>(
sourcemeta::blaze::default_schema_compiler);

auto schema{sourcemeta::core::parse_json(R"JSON({
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$defs": {
"helper": { "type": "string" }
},
"properties": {
"foo": { "$ref": "#/$defs/helper", "examples": [ 1 ] }
}
})JSON")};

const auto result = bundle.apply(
schema, sourcemeta::core::schema_official_walker,
sourcemeta::core::schema_official_resolver, transformer_callback_error);

EXPECT_TRUE(result);

const auto expected{sourcemeta::core::parse_json(R"JSON({
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$defs": {
"helper": { "type": "string" }
},
"properties": {
"foo": { "$ref": "#/$defs/helper" }
}
})JSON")};

EXPECT_EQ(schema, expected);
}

TEST(Linter, valid_examples_17_2020_12_ref_sibling_removes) {
sourcemeta::core::SchemaTransformer bundle;
bundle.add<sourcemeta::blaze::ValidExamples>(
sourcemeta::blaze::default_schema_compiler);

auto schema{sourcemeta::core::parse_json(R"JSON({
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$defs": {
"helper": { "type": "string" }
},
"properties": {
"foo": { "$ref": "#/$defs/helper", "examples": [ 1 ] }
}
})JSON")};

const auto result = bundle.apply(
schema, sourcemeta::core::schema_official_walker,
sourcemeta::core::schema_official_resolver, transformer_callback_error);

EXPECT_TRUE(result);

const auto expected{sourcemeta::core::parse_json(R"JSON({
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$defs": {
"helper": { "type": "string" }
},
"properties": {
"foo": { "$ref": "#/$defs/helper" }
}
})JSON")};

EXPECT_EQ(schema, expected);
}