schema

Documentation

Index

• Constants
• Variables
• func GetSchemaObject() *oas.SchemaObject
• type DECL
• type Parser
  • func NewParser(utils model.Utils, openAPIObject *OpenAPIObject) Parser
  • func SetupUpSchemaParseMocks(schemaObject *oas.SchemaObject, err error) Parser

Constants

const EnumValueSeparator = ","

Variables

var AuthorizationHeaderSchema = &oas.SchemaObject{
	ID:          "Authorization",
	FieldName:   "AuthorizationFieldName",
	Type:        "string",
	Description: "Authorization Description",
	Example:     "Bearer 123",
}

var ContentTypeHeaderSchema = &oas.SchemaObject{
	ID:          "ContentType",
	FieldName:   "ContentTypeFieldName",
	Type:        "string",
	Description: "Content Type Description",
	Example:     "json",
}

var VersionHeaderSchema = &oas.SchemaObject{
	ID:          "Version",
	FieldName:   "VersionFieldName",
	Type:        "int",
	Description: "Version Description",
	Example:     "101",
}

Functions

func GetSchemaObject

func GetSchemaObject() *oas.SchemaObject

Types

type DECL

type DECL struct {
	Type struct {
		Name string
	}
}

type Parser

type Parser interface {
	GetPkgAst(pkgPath string) (map[string]*ast.Package, error)
	RegisterType(pkgPath, pkgName, typeName string, astExpr ast.Expr) (string, error)
	ParseSchemaObject(pkgPath, pkgName, typeName string, astExpr ast.Expr) (*SchemaObject, error)
}

func NewParser

func NewParser(utils model.Utils, openAPIObject *OpenAPIObject) Parser

func SetupUpSchemaParseMocks

func SetupUpSchemaParseMocks(schemaObject *oas.SchemaObject, err error) Parser