asyncapi

Documentation

Index

• Variables
• func IsMajorVersionSupported(version int) bool
• func IsVersionSupported(version string) bool
• type Specification
• type Validations

Variables

var SupportedVersions = []string{
	"2.0.0",
	"2.1.0",
	"2.2.0",
	"2.3.0",
	"2.4.0",
	"2.5.0",
	"2.6.0",

	"3.0.0",
}

SupportedVersions describe the asyncapi-codegen supported versions.

Functions

func IsMajorVersionSupported

func IsMajorVersionSupported(version int) bool

IsMajorVersionSupported checks that the major version is supported.

func IsVersionSupported

func IsVersionSupported(version string) bool

IsVersionSupported checks that the version is supported.

Types

type Specification

type Specification interface {
	// MajorVersion returns the major version of the AsyncAPI specification.
	MajorVersion() int
	// Process processes all information in specification in order to link the
	// references, apply the traits and generating other information for code
	// generation.
	//
	// WARNING: this will alter the specification as you will find, by example,
	// traits applied in the specification.
	Process() error
	// AddDependency adds a dependency to the specification.
	AddDependency(path string, spec Specification) error
}

Specification only contains common functions between each version. This should be casted to get all other functions, base on the version.

type Validations

type Validations[T any] struct {
	Required         []string `json:"required"`
	MultipleOf       []string `json:"multipleOf"`
	Maximum          float64  `json:"maximum"`
	ExclusiveMaximum float64  `json:"exclusiveMaximum"`
	Minimum          float64  `json:"minimum"`
	ExclusiveMinimum float64  `json:"exclusiveMinimum"`
	MaxLength        uint     `json:"maxLength"`
	MinLength        uint     `json:"minLength"`
	Pattern          string   `json:"pattern"`
	MaxItems         uint     `json:"maxItems"`
	MinItems         uint     `json:"minItems"`
	UniqueItems      bool     `json:"uniqueItems"`
	MaxProperties    uint     `json:"maxProperties"`
	MinProperties    uint     `json:"minProperties"`
	Enum             []any    `json:"enum"`
	Const            any      `json:"const"`

	AllOf []*T `json:"allOf"`
	AnyOf []*T `json:"anyOf"`
	OneOf []*T `json:"oneOf"`

	// --- Non JSON Schema/AsyncAPI fields -------------------------------------
	IsRequired bool `json:"-"`
}

Validations is a representation of the JSON-Object validation fields supported by asyncapi These fields are in common for v2 and v3.