api

Documentation

Index

• Constants
• func ParseOperationType(input, def string) string
• type Operation
  • func (op *Operation) TrimSpace()
• type Operations
  • func (ops Operations) Table() ([]string, [][]string)
• type URLTransformer
  • func NewURLTransformer() URLTransformer
  • func (ut *URLTransformer) BuildReverseEndpointPattern(method, actualURL string) string
  • func (ut *URLTransformer) LoadPath(path string) error
  • func (ut *URLTransformer) LoadPaths(paths []string) error
  • func (ut *URLTransformer) URLActualToPattern(s string) string

Constants

const (
	TypeAPI               = "api"
	TypeMethod            = "method"
	TypeEvent             = "event"
	TypeEventAliasWebhook = "webhook"
)

Functions

func ParseOperationType

func ParseOperationType(input, def string) string

Types

type Operation

type Operation struct {
	Tags        []string
	Class       string // Object class for SDKs
	Type        string // Method or Event
	Path        string
	Summary     string
	Description string
	Link        string
}

func (*Operation) TrimSpace

func (op *Operation) TrimSpace()

type Operations

type Operations []Operation

func (Operations) Table

func (ops Operations) Table() ([]string, [][]string)

type URLTransformer

type URLTransformer struct {
	ExactPaths  []string
	RegexpPaths map[string]*regexp.Regexp
	// contains filtered or unexported fields
}

URLTransformer is useful for reading log files and converting actual request URls into pattners, such as those used in the OpenAPI Spec for reporting and categorization purposes.

func NewURLTransformer

func NewURLTransformer() URLTransformer

NewURLTransformer creates a new URLTransformer instance.

func (*URLTransformer) BuildReverseEndpointPattern

func (ut *URLTransformer) BuildReverseEndpointPattern(method, actualURL string) string

func (*URLTransformer) LoadPath

func (ut *URLTransformer) LoadPath(path string) error

LoadPath loads a single spec URL pattern.

func (*URLTransformer) LoadPaths

func (ut *URLTransformer) LoadPaths(paths []string) error

LoadPaths loads multiple spec URL patterns. See the test file for an example.

func (*URLTransformer) URLActualToPattern

func (ut *URLTransformer) URLActualToPattern(s string) string

URLActualToPattern is the "runtime" API that is called over and over for URL classification purposes.