schema

package

v1.260716.0 Latest Latest Go to latest Published: Jul 16, 2026 License: MIT Imports: 10 Imported by: 0

Documentation ¶

Index ¶

func EndpointCount() (int, error)
func SchemaCommand() *ffcli.Command
type Endpoint
type Parameter

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func EndpointCount ¶ added in v1.260519.0

func EndpointCount() (int, error)

EndpointCount returns the number of endpoints in the embedded schema index.

func SchemaCommand ¶

func SchemaCommand() *ffcli.Command

SchemaCommand returns the schema command.

Types ¶

type Endpoint ¶

type Endpoint struct {
	Method            string         `json:"method"`
	Path              string         `json:"path"`
	Parameters        []Parameter    `json:"parameters,omitempty"`
	RequestSchema     string         `json:"requestSchema,omitempty"`
	RequestAttributes map[string]any `json:"requestAttributes,omitempty"`
	ResponseSchema    string         `json:"responseSchema,omitempty"`
}

Endpoint is a compact representation of an API endpoint.

type Parameter ¶

type Parameter struct {
	Name     string   `json:"name"`
	In       string   `json:"in"`
	Enum     []string `json:"enum,omitempty"`
	Required bool     `json:"required,omitempty"`
}

Parameter describes a query/path parameter.

Source Files ¶

View all Source files

schema.go

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