endpoints

package
v30.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 16, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RawOpenAPISpec

func RawOpenAPISpec() []byte

RawOpenAPISpec returns the embedded OpenAPI document bytes.

func RegisterScalarUI

func RegisterScalarUI(apiSvr *api.Server) error

RegisterScalarUI registers the Scalar UI <address>:<api-port>/scalar.

Types

type OpenAPIEndpoint

type OpenAPIEndpoint struct {
	Path           string
	Method         string
	OperationID    string
	Summary        string
	Tags           []string
	Parameters     []OpenAPIParameter
	ResponseSchema string
}

OpenAPIEndpoint contains the subset of metadata required by downstream consumers.

func GetOpenAPIEndpoints

func GetOpenAPIEndpoints() ([]OpenAPIEndpoint, error)

GetOpenAPIEndpoints returns all GET endpoints defined in the OpenAPI spec.

type OpenAPIParameter

type OpenAPIParameter struct {
	Name        string         `yaml:"name"`
	In          string         `yaml:"in"`
	Required    bool           `yaml:"required"`
	Description string         `yaml:"description"`
	Schema      *openAPISchema `yaml:"schema"`
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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