diff --git a/bundle/schema/schema.go b/bundle/schema/schema.go index 710eaf0d..e72f02e0 100644 --- a/bundle/schema/schema.go +++ b/bundle/schema/schema.go @@ -37,29 +37,31 @@ type Schema struct { Required []string `json:"required,omitempty"` } -// This function translates golang types into json schema. Here is the mapping -// between json schema types and golang types -// - GolangType -> Javascript type / Json Schema2 -// - bool -> boolean -// - string -> string -// - int (all variants) -> number -// - float (all variants) -> number -// - map[string]MyStruct -> { -// type: object -// additionalProperties: {} -// } -// for details visit: https://json-schema.org/understanding-json-schema/reference/object.html#additional-properties -// - []MyStruct -> { -// type: array -// items: {} -// } -// for details visit: https://json-schema.org/understanding-json-schema/reference/array.html#items -// - []MyStruct -> { -// type: object -// properties: {} -// additionalProperties: false -// } -// for details visit: https://json-schema.org/understanding-json-schema/reference/object.html#properties +/* +This function translates golang types into json schema. Here is the mapping +between json schema types and golang types + - GolangType -> Javascript type / Json Schema2 + - bool -> boolean + - string -> string + - int (all variants) -> number + - float (all variants) -> number + - map[string]MyStruct -> { + type: object + additionalProperties: {} + } + for details visit: https://json-schema.org/understanding-json-schema/reference/object.html#additional-properties + - []MyStruct -> { + type: array + items: {} + } + for details visit: https://json-schema.org/understanding-json-schema/reference/array.html#items + - []MyStruct -> { + type: object + properties: {} + additionalProperties: false + } + for details visit: https://json-schema.org/understanding-json-schema/reference/object.html#properties +*/ func NewSchema(golangType reflect.Type, docs *Docs) (*Schema, error) { seenTypes := map[reflect.Type]struct{}{} debugTrace := list.New()