Changes to UUID schema generation

[swaggest]

Changes to UUID schema generation

[B87]

Hi! I'm facing the same issue, represent a google UUID as a string on my schema.

What is the best way of doing it? I see that jsonschema.InterceptType has been deprecated

[danicc097]

I append jsonschema.InterceptSchema to openapi3.Reflector's DefaultOptions with

// jsonschema.InterceptSchema(func(params jsonschema.InterceptSchemaParams) (stop bool, err error)
t := params.Schema.ReflectType
if t.Kind() == reflect.Ptr {
  t = t.Elem()
}
if t == reflect.TypeOf(uuid.New()) {
  params.Schema.Type = &jsonschema.Type{SimpleTypes: pointers.New(jsonschema.String)}
  params.Schema.Pattern = pointers.New("^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}")
  params.Schema.Items = &jsonschema.Items{}
  // oapi-codegen
  params.Schema.ExtraProperties = map[string]any{
	  "x-go-type": "uuid.UUID",
	  "x-go-type-import": map[string]any{
		  "name": "uuid",
		  "path": "github.com/google/uuid",
	  },
	  "x-is-generated": true,
  }
}

using:

• github.com/swaggest/jsonschema-go v0.3.64
• github.com/swaggest/openapi-go v0.2.44

[B87]

Thank you so much @danicc097, your approach worked like a charm. I noticed that when doing this you will need to add an example manually since the struct example for path parameters won't be used on the spec generation.

This is how my code looks like now:

reflector.DefaultOptions = append(reflector.DefaultOptions, jsonschema.InterceptSchema(
		func(params jsonschema.InterceptSchemaParams) (stop bool, err error) {
			t := params.Schema.ReflectType
			if t.Kind() == reflect.Ptr {
				t = t.Elem()
			}
			if t == reflect.TypeOf(uuid.New()) {
				params.Schema.Type = &jsonschema.Type{SimpleTypes: &strSchema}
				params.Schema.Pattern = &uuidPattern
				params.Schema.Items = &jsonschema.Items{}
				// oapi-codegen
				params.Schema.Examples = []interface{}{"cdb15f83-1c5d-4727-98d1-8924ccd1fc01"}
				params.Schema.ExtraProperties = map[string]any{
					"x-go-type": "uuid.UUID",
					"x-go-type-import": map[string]any{
						"name": "uuid",
						"path": "github.com/google/uuid",
					},
					"x-is-generated": true,
				}
			}
			return false, nil
		}))

using:

• github.com/swaggest/openapi-go v0.2.45
• github.com/swaggest/jsonschema-go v0.3.64

[vearutop]

I'm sorry this issue already took me so long, I'll try to come up with a proper solution soon. In meanwhile, one of the workarounds is to declare desired schema with type mapping:

https://github.com/swaggest/rest/blob/v0.2.61/_examples/advanced-generic-openapi31/router.go#L84-L89

	// Create custom schema mapping for 3rd party type.
	uuidDef := jsonschema.Schema{}
	uuidDef.AddType(jsonschema.String)
	uuidDef.WithFormat("uuid")
	uuidDef.WithExamples("248df4b7-aa70-47b8-a036-33ac447e668d")
	jsr.AddTypeMapping(uuid.UUID{}, uuidDef)

[B87]

@vearutop Thanks for the example, your approach looks cleaner. It would be nice to have a native uuid integration but this is good enough for me.