openapi

package

v1.6.24 Latest Latest Go to latest Published: Apr 12, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Details

This section is empty.

This section is empty.

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

func Operations(pathitem *schema.PathItem, fn func(method string, op *schema.Operation))

Operations calls fn for each non-nil operation in the PathItem, passing the HTTP method name and a pointer to the operation.

type OperationOpt func(*opopt)

func WithDeprecated() OperationOpt

func WithDescription(description string) OperationOpt

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

func WithFormRequest(r *jsonschema.Schema) OperationOpt

func WithID(id string) OperationOpt

func WithJSONRequest(r *jsonschema.Schema) OperationOpt

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

func WithMultipartRequest(r *jsonschema.Schema) OperationOpt

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

func WithQuery(q *jsonschema.Schema) OperationOpt

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

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

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

func WithTags(tags ...string) OperationOpt

func WithTextResponse(status int, description string) OperationOpt

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

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