strfmt

package
v1.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 12, 2026 License: MIT Imports: 0 Imported by: 0

Documentation

Overview

Package strfmt holds the canonical catalogue of named string formats the `@format` decorator accepts. It is a leaf below both the analyser (which rejects an unknown `@format` name) and codegen (which emits a per-format runtime check and an OpenAPI `format` keyword), so the set of legal formats is decided in exactly ONE place. Without this the legality list and the validator catalogue lived in two packages: a name added to one but not the other made the editor accept a `@format` whose field then got no runtime check while OpenAPI still advertised it.

(Named `strfmt`, not `formats`, to stay clearly distinct from the `internal/format` printer package that renders DSL source.)

Index

Constants

This section is empty.

Variables

View Source
var Names = []string{
	"email", "url", "uri", "uuid", "datetime", "date", "time",
	"phone", "ipv4", "ipv6", "cidr", "mac",
	"creditcard", "base64", "base64url", "hexcolor", "json",
}

Names is the canonical list of `@format` values, in documentation order (README §"Decorators by level"). The analyser uses it as the `@format` argument enum; codegen must provide a validator for every entry.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL