components

Documentation

Overview

Package components provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.8.1 DO NOT EDIT.

Index

• func GetSwagger() (swagger *openapi3.T, err error)
• func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
• type IdPathParam
• type IdQueryParam
• type Pager
• type PagerPageQueryParam
• type PagerSizeQueryParam
• type SortQueryParam

Functions

func GetSwagger

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type IdPathParam

type IdPathParam string

IdPathParam defines model for IdPathParam.

type IdQueryParam

type IdQueryParam string

IdQueryParam defines model for IdQueryParam.

type Pager

type Pager struct {
	CurrentPage int `json:"currentPage"`
	MaxPage     int `json:"maxPage"`
}

Pager defines model for Pager.

type PagerPageQueryParam

type PagerPageQueryParam int

PagerPageQueryParam defines model for PagerPageQueryParam.

type PagerSizeQueryParam

type PagerSizeQueryParam int

PagerSizeQueryParam defines model for PagerSizeQueryParam.

type SortQueryParam

type SortQueryParam []string

SortQueryParam defines model for SortQueryParam.