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.

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

Add test for FieldNameTag #75

Merged
merged 2 commits into from
Sep 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 23 additions & 0 deletions fixtures/test_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://github.com/invopop/jsonschema/config",
"$ref": "#/$defs/Config",
"$defs": {
"Config": {
"properties": {
"name": {
"type": "string"
},
"count": {
"type": "integer"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"count"
]
}
}
}
9 changes: 8 additions & 1 deletion reflect.go
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,9 @@ type Reflector struct {
// root as opposed to a definition with a reference.
ExpandedStruct bool

// FieldNameTag will change the tag used to get field names. json tags are used by default.
FieldNameTag string

// IgnoredTypes defines a slice of types that should be ignored in the schema,
// switching to just allowing additional properties instead.
IgnoredTypes []interface{}
Expand Down Expand Up @@ -989,7 +992,11 @@ func ignoredByJSONSchemaTags(tags []string) bool {
}

func (r *Reflector) reflectFieldName(f reflect.StructField) (string, bool, bool, bool) {
jsonTagString, _ := f.Tag.Lookup("json")
tagKey := r.FieldNameTag
if tagKey == "" {
tagKey = "json"
}
jsonTagString := f.Tag.Get(tagKey)
jsonTags := strings.Split(jsonTagString, ",")

if ignoredByJSONTags(jsonTags) {
Expand Down
12 changes: 12 additions & 0 deletions reflect_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -545,3 +545,15 @@ func TestArrayFormat(t *testing.T) {
pt := p.Items.Format
require.Equal(t, pt, "uri")
}

func TestFieldNameTag(t *testing.T) {
type Config struct {
Name string `yaml:"name"`
Count int `yaml:"count"`
}

r := Reflector{
FieldNameTag: "yaml",
}
compareSchemaOutput(t, "fixtures/test_config.json", &r, &Config{})
}