codegen

type AuthScheme ¶

type AuthScheme struct {
	Key      string
	Type     string
	Name     string
	Location string
}

AuthScheme describes one supported authentication scheme.

type BodySchema ¶

type BodySchema struct {
	Name     string
	Type     string
	Format   string
	Required bool
	Raw      string
	Fields   []BodySchema
	Items    *BodySchema
}

BodySchema captures a recursive request body schema tree.

type ConflictResult ¶ added in v0.8.0

type ConflictResult struct {
	Path        string
	WrittenPath string
	Status      ConflictStatus
}

ConflictResult reports how one file write was resolved.

func WriteFileWithStrategy(targetPath string, content []byte, strategy string) (ConflictResult, error)

type ConflictStatus ¶ added in v0.8.0

type ConflictStatus string

const (
	ConflictStatusWritten     ConflictStatus = "written"
	ConflictStatusSkipped     ConflictStatus = "skipped"
	ConflictStatusConflict    ConflictStatus = "conflict"
	ConflictStatusOverwritten ConflictStatus = "overwritten"
)

type Group ¶

type Group struct {
	Name     string
	Requests []Request
}

Group collects related requests, usually by tag or a stable path segment.

type Header ¶

type Header struct {
	Name     string
	Value    string
	Required bool
}

Header describes one request header requirement.

type Param ¶

type Param struct {
	Name     string
	In       string
	Type     string
	Format   string
	Required bool
}

Param describes one non-header request parameter.

type Request ¶

type Request struct {
	Method    string
	Path      string
	Name      string
	Summary   string
	Comments  []string
	Headers   []Header
	Params    []Param
	Body      *BodySchema
	Responses []Response
}

Request describes one generated API request shape.

type Response ¶

type Response struct {
	StatusCode  string
	Description string
}

Response captures one response status and description from the source spec.

type Spec ¶

type Spec struct {
	Title       string
	Version     string
	BasePath    string
	Groups      []Group
	AuthSchemes []AuthScheme
}

Spec is the top-level intermediate representation of an API specification.