Custom schemas properties using tags

[swaggest]

Custom schemas properties using tags

[vearutop]

Hello, that's true, default reflection ignores any unknown field tags.

It is possible to add them manually with jsonschema.InterceptProperty, please check an example:

https://go.dev/play/p/hQW4YL3kSuk

package main

import (
	"encoding/json"
	"fmt"
	"reflect"

	"github.com/swaggest/jsonschema-go"
)

type Recipient struct {
	Name  string `json:"name" title:"Name" default:"John Doe" colSpan:"col-span-6"`
	Email string `json:"email" required:"true" title:"Email" format:"email" default:"[email protected]" colSpan:"col-span-6"`
}

func main() {
	r := jsonschema.Reflector{}
	sh, _ := r.Reflect(Recipient{}, jsonschema.InterceptProperty(func(name string, field reflect.StructField, propertySchema *jsonschema.Schema) error {
		if colSpan, ok := field.Tag.Lookup("colSpan"); ok {
			propertySchema.WithExtraPropertiesItem("colSpan", colSpan)
		}

		return nil
	}))

	j, _ := json.MarshalIndent(sh, "", " ")
	fmt.Println(string(j))
}

{
 "required": [
  "email"
 ],
 "properties": {
  "email": {
   "title": "Email",
   "default": "[email protected]",
   "type": "string",
   "format": "email",
   "colSpan": "col-span-6"
  },
  "name": {
   "title": "Name",
   "default": "John Doe",
   "type": "string",
   "colSpan": "col-span-6"
  }
 },
 "type": "object"
}

[tpoxa]

Awesome. Thanks