openapi

package

v0.1.0 Latest Latest Go to latest Published: Jul 23, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/legendnero/openapi-to-agent-tools

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func DescribeOp(op Operation) string
func FilterAuthHeader(name string, skipAuth bool) bool
func OpenAPIVersion(doc *openapi3.T) string
func ParamLocationOK(in string) bool
func PreferJSONMedia(content openapi3.Content) *openapi3.MediaType
func SchemaMap(ref *openapi3.SchemaRef) map[string]any
func SpecTitle(doc *openapi3.T) string
func SpecVersion(doc *openapi3.T) string
func SuccessResponse(responses *openapi3.Responses) (*openapi3.ResponseRef, string)
type LoadResult
- func Load(spec string, maxBytes int64, timeout time.Duration) (*LoadResult, error)
type Operation
- func Enumerate(doc *openapi3.T, includeDeprecated bool) []Operation

Constants ¶

View Source

const (
	DefaultMaxBytes = 10 * 1024 * 1024
	DefaultTimeout  = 30 * time.Second
)

Variables ¶

This section is empty.

Functions ¶

func DescribeOp ¶

func DescribeOp(op Operation) string

func FilterAuthHeader ¶

func FilterAuthHeader(name string, skipAuth bool) bool

func OpenAPIVersion ¶

func OpenAPIVersion(doc *openapi3.T) string

func ParamLocationOK ¶

func ParamLocationOK(in string) bool

func PreferJSONMedia ¶

func PreferJSONMedia(content openapi3.Content) *openapi3.MediaType

func SchemaMap ¶

func SchemaMap(ref *openapi3.SchemaRef) map[string]any

func SpecTitle ¶

func SpecTitle(doc *openapi3.T) string

func SpecVersion ¶

func SpecVersion(doc *openapi3.T) string

func SuccessResponse ¶

func SuccessResponse(responses *openapi3.Responses) (*openapi3.ResponseRef, string)

Types ¶

type LoadResult ¶

type LoadResult struct {
	Doc      *openapi3.T
	Raw      []byte
	SpecHash string
	Source   string
}

func Load ¶

func Load(spec string, maxBytes int64, timeout time.Duration) (*LoadResult, error)

type Operation ¶

type Operation struct {
	Method      string
	Path        string
	OperationID string
	Summary     string
	Description string
	Deprecated  bool
	Parameters  openapi3.Parameters
	RequestBody *openapi3.RequestBodyRef
	Responses   *openapi3.Responses
}

func Enumerate ¶

func Enumerate(doc *openapi3.T, includeDeprecated bool) []Operation

Source Files ¶

View all Source files

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