changed comment type

This commit is contained in:
Shreyas Goenka 2023-01-20 16:24:39 +01:00
parent 93e5c83091
commit 9599e63ffb
No known key found for this signature in database
GPG Key ID: 92A07DF49CCB0622
1 changed files with 21 additions and 23 deletions

View File

@ -37,29 +37,27 @@ 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) {
tracker := newTracker()
schema, err := safeToSchema(golangType, docs, "", tracker)