resolvers

func AddExtension ¶

func AddExtension(ve *oaispec.VendorExtensible, key string, value any, skip bool)

func AppendEnumDesc ¶ added in v0.35.0

func AppendEnumDesc(description string, extensions oaispec.Extensions, skip bool) string

AppendEnumDesc folds the x-go-enum-desc const-name mapping (if any) into description, returning the resulting description. A newline separates the authored prose from the appended mapping.

When skip is true the description is returned unchanged — the mapping then rides x-go-enum-desc only. This is the single gate shared by the schema (model decl + struct field) and parameter builders so the SkipEnumDescriptions option behaves identically across every target that folds the mapping in. Response headers never fold the mapping into their description, so they don't call this — but they do carry it on x-go-enum-desc in both modes (spec >= v0.22.6 marshals header vendor extensions). See go-swagger/go-swagger#2922.

func ExplicitJSONName ¶ added in v0.35.0

func ExplicitJSONName(field *ast.Field) string

ExplicitJSONName returns the name set in a field's json struct tag — the part before the first comma — or "" when the field has no json tag, the tag sets no name (`json:",omitempty"`), or the tag skips the field (`json:"-"`).

Go's encoding/json treats an *embedded* struct field carrying an explicit json name as a regular named field: the embedded value nests under that name instead of being promoted. Callers use a non-empty result to distinguish a nesting embed from a flattening one (go-swagger#2038).

func FindASTField ¶

func FindASTField(file *ast.File, pos token.Pos) *ast.Field

func GetEnumDesc ¶ added in v0.34.1

func GetEnumDesc(extensions oaispec.Extensions) string

GetEnumDesc reads the x-go-enum-desc extension off a Swagger extensions map. Empty when absent.

Consumers typically check this after a build pass to know whether they should append the per-value docs to a Description (parameters do this for the parameter description; the schema builder folds it in differently — see `handlers/dispatch_schema.go:clearStaleEnumDesc` for the override-cleanup dance). Response headers carry the mapping on x-go-enum-desc but never fold it into the header description.

func IsAny ¶

func IsAny(o *types.TypeName) bool

func IsFieldStringable ¶

func IsFieldStringable(tpe ast.Expr) bool

IsFieldStringable check if the field type is a scalar. If the field type is *ast.StarExpr and is pointer type, check if it refers to a scalar. Otherwise, the ",string" directive doesn't apply.

func IsJSONMapKey ¶ added in v0.35.0

func IsJSONMapKey(key types.Type) bool

IsJSONMapKey reports whether a Go map with this key type marshals to a JSON object under encoding/json — i.e. whether the map is representable as {type: object, additionalProperties: V}.

The rule mirrors encoding/json's newMapEncoder: the key kind is string or any integer / unsigned-integer kind (int, int8…int64, uint, uint8…uint64, uintptr — all stringified), or the key implements encoding.TextMarshaler. Everything else (float, bool, struct without TextMarshaler, interface, func) makes json.Marshal fail; json.Marshaler is never consulted for keys.

func IsStdError ¶

func IsStdError(o *types.TypeName) bool

func IsStdJSONRawMessage ¶

func IsStdJSONRawMessage(o *types.TypeName) bool

func IsStdTime ¶

func IsStdTime(o *types.TypeName) bool

func IsTextMarshaler ¶

func IsTextMarshaler(tpe types.Type) bool

func MarkDeprecated ¶ added in v0.35.0

func MarkDeprecated(ps *oaispec.Schema)

MarkDeprecated sets `x-deprecated: true` on the schema. Idempotent.

func MustBeAType ¶ added in v0.34.1

func MustBeAType(tpe types.TypeAndValue)

func MustHaveRightHandSide ¶

func MustHaveRightHandSide(a *types.Alias)

func MustNotBeABuiltinType ¶

func MustNotBeABuiltinType(o *types.TypeName)

func ParseJSONTag ¶

func ParseJSONTag(field *ast.Field, goName string) (name string, ignore, isString, omitEmpty bool, err error)

ParseJSONTag derives the JSON property name and tag options for a struct field. goName is the field's Go identifier as reported by go/types; it is authoritative for the default name because a single AST field group may declare several names (`R, G, B, A uint8`), each a distinct go/types field promoted to its own property (go-swagger#2638). When goName is empty the first AST name is used as a fallback.

A json rename (`json:"foo"`) can only name a single field, so it is ignored for a multi-name group — each member keeps its own Go name — while the `-`, `,omitempty` and `,string` options still apply to every member.

func SwaggerSchemaForType ¶

func SwaggerSchemaForType(typeName string, prop ifaces.SwaggerTypable) error

SwaggerSchemaForType maps all Go builtin types that have Json representation to Swagger/Json types.

See https://golang.org/pkg/builtin/ and http://swagger.io/specification/

func UnsupportedBasic ¶

func UnsupportedBasic(tpe *types.Basic) bool

func UnsupportedBuiltin ¶

func UnsupportedBuiltin(tpe ifaces.Objecter) (skip bool)

UnsupportedBuiltin returns true when tpe is unsafe.Pointer.

Other "unsupported builtins" (complex64, complex128) cannot reach this function: they surface as *types.Basic, which does not satisfy ifaces.Objecter. Those are caught one layer down by UnsupportedBasic / UnsupportedBuiltinType when the *types.Basic surfaces directly.

Supported builtins:

• error

func UnsupportedBuiltinType ¶

func UnsupportedBuiltinType(tpe types.Type) bool