Function GenerateGoSchema

pkg/codegen/schema.go:326–657

(sref *openapi3.SchemaRef, path []string)

}

func GenerateGoSchema(sref *openapi3.SchemaRef, path []string) (Schema, error) {
	// Add a fallback value in case the sref is nil.
	// i.e. the parent schema defines a type:array, but the array has
	// no items defined. Therefore, we have at least valid Go-Code.
	if sref == nil {
		return Schema{GoType: "interface{}"}, nil
	}

	schema := sref.Value
	extensions := combinedSchemaExtensions(sref)

	// Check x-go-type-skip-optional-pointer, which will override if the type
	// should be a pointer or not when the field is optional.
	// NOTE skipOptionalPointer will be defaulted to the global value, but can be overridden on a per-type/-field basis
	skipOptionalPointer := globalState.options.OutputOptions.PreferSkipOptionalPointer
	if extension, ok := extensions[extPropGoTypeSkipOptionalPointer]; ok {
		var err error
		skipOptionalPointer, err = extParsePropGoTypeSkipOptionalPointer(extension)
		if err != nil {
			return Schema{}, fmt.Errorf("invalid value for %q: %w", extPropGoTypeSkipOptionalPointer, err)
		}
	}

	// If Ref is set on the SchemaRef, it means that this type is actually a reference to
	// another type. We're not de-referencing, so simply use the referenced type.
	if IsGoTypeReference(sref.Ref) {
		var refType string

		// check if there is an x-go-type extension next to the $ref and use that over the overrided type.
		if extension, ok := sref.Extensions[extPropGoType]; ok {
			var ok bool
			refType, ok = extension.(string)
			if !ok {
				return Schema{}, fmt.Errorf("error turning '%s: %v' into string",
					extPropGoType, extension)
			}
		} else {
			// Convert the reference path to Go type
			var err error
			refType, err = RefPathToGoType(sref.Ref)
			if err != nil {
				return Schema{}, fmt.Errorf("error turning reference (%s) into a Go type: %s",
					sref.Ref, err)
			}
		}

		return Schema{
			GoType:              refType,
			Description:         schema.Description,
			DefineViaAlias:      true,
			SkipOptionalPointer: skipOptionalPointer,
			OAPISchema:          schema,
		}, nil
	}

	outSchema := Schema{
		Description:         schema.Description,
		OAPISchema:          schema,