link

package
v0.5.0 Latest Latest
Warning

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

Go to latest
Published: Jul 16, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New(store *store.Store, opts ...Option) *v3.Link

New builds a response link and stores it as a component when referenced.

Types

type Option

type Option func(*v3.Link, *store.Store)

Option configures an OpenAPI response link.

func Description

func Description(s string) Option

Description sets the link description.

func OperationId

func OperationId(id string) Option

OperationId sets the name of an existing resolvable OAS operation.

func OperationRef

func OperationRef(ref string) Option

OperationRef sets a relative or absolute URI reference to an OAS operation.

func Parameter

func Parameter(name, expression string) Option

Parameter adds a parameter name to runtime expression mapping for the linked operation.

func Reference

func Reference(name string) Option

Reference sets a $ref to a named link component in components/links.

func RequestBody

func RequestBody(expression string) Option

RequestBody sets a runtime expression for the request body of the linked operation.

func Server

func Server(url, description string) Option

Server sets a server to use for the linked operation.

Jump to

Keyboard shortcuts

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