spec

Documentation

Index

• func DiscoverSpecFiles(root string, patterns []string) ([]string, error)
• type OpenApiSpec
  • func Load(filename string) (*OpenApiSpec, error)
• type Operation
• type Parameter
• type RequestBody
• type Response

Functions

func DiscoverSpecFiles

func DiscoverSpecFiles(root string, patterns []string) ([]string, error)

Types

type OpenApiSpec

type OpenApiSpec struct {
	BaseURL string                          `yaml:"baseUrl"`
	Paths   map[string]map[string]Operation `yaml:"paths"`
}

func Load

func Load(filename string) (*OpenApiSpec, error)

type Operation

type Operation struct {
	Summary     string              `yaml:"summary"`
	Parameters  []Parameter         `yaml:"parameters"`
	RequestBody *RequestBody        `yaml:"requestBody"`
	Responses   map[string]Response `yaml:"responses"`
}

type Parameter

type Parameter struct {
	Name     string `yaml:"name"`
	In       string `yaml:"in"`
	Required bool   `yaml:"required"`
	Schema   struct {
		Type string `yaml:"type"`
	} `yaml:"schema"`
}

type RequestBody

type RequestBody struct {
	Content map[string]struct {
		Schema map[string]any `yaml:"schema"`
	} `yaml:"content"`
}

type Response

type Response struct {
	Description string `yaml:"description"`
}