openapi

package
v1.6.20 Latest Latest
Warning

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

Go to latest
Published: Mar 31, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Operation

func Operation(summary string, opts ...OperationOpt) schema.Operation

Types

type OperationOpt

type OperationOpt func(*opopt)

func WithDeprecated

func WithDeprecated() OperationOpt

func WithDescription

func WithDescription(description string) OperationOpt

func WithErrorResponse

func WithErrorResponse(status int, description ...string) OperationOpt

func WithFormRequest

func WithFormRequest(r *jsonschema.Schema) OperationOpt

func WithID

func WithID(id string) OperationOpt

func WithJSONRequest

func WithJSONRequest(r *jsonschema.Schema) OperationOpt

func WithJSONResponse

func WithJSONResponse(status int, r *jsonschema.Schema) OperationOpt

func WithMultipartRequest

func WithMultipartRequest(r *jsonschema.Schema) OperationOpt

func WithQuery

func WithQuery(q *jsonschema.Schema) OperationOpt

func WithRequest

func WithRequest(contentType string, r *jsonschema.Schema) OperationOpt

func WithResponse

func WithResponse(status int, contentType string, r *jsonschema.Schema, description ...string) OperationOpt

func WithSecurity

func WithSecurity(schemeName string, scopes ...string) OperationOpt

func WithTags

func WithTags(tags ...string) OperationOpt

func WithTextResponse

func WithTextResponse(status int, description string) OperationOpt

Directories

Path Synopsis
Package httphandler provides HTTP handler functions for an httprouter.Router.
Package httphandler provides HTTP handler functions for an httprouter.Router.
Package schema provides Go types for the OpenAPI 3.1 specification.
Package schema provides Go types for the OpenAPI 3.1 specification.
Package static contains embedded static files for the OpenAPI handler.
Package static contains embedded static files for the OpenAPI handler.

Jump to

Keyboard shortcuts

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