param

Documentation

Overview

Package param provides a set of shortcuts to define parameters for the route Options. See the github.com/go-fuego/fuego/option package for more information.

Index

• Variables

Variables

var Bool = fuego.ParamBool

Bool sets the parameter type to boolean. The query parameter is transmitted as a string in the URL, but it is parsed as a boolean. Please prefer QueryBool for clarity.

var Default = fuego.ParamDefault

Default sets the default value for the parameter. Type is checked at start-time.

var Description = fuego.ParamDescription

Description sets the description for the parameter.

var Example = fuego.ParamExample

Example adds an example to the parameter. As per the OpenAPI 3.0 standard, the example must be given a name.

var Integer = fuego.ParamInteger

Integer sets the parameter type to integer. The query parameter is transmitted as a string in the URL, but it is parsed as an integer. Please prefer QueryInt for clarity.

var Nullable = fuego.ParamNullable

Nullable sets the parameter as nullable.

var Required = fuego.ParamRequired

Required sets the parameter as required. If the parameter is not present, the request will fail.

var StatusCodes = fuego.ParamStatusCodes

StatusCodes sets the status codes for which this parameter is required. Only used for response parameters. If empty, it is required for 200 status codes.