parser

Documentation

Index

• Constants
• func ToSnakeCase(str string) string
• type Definition
  • func NewDefinition(name string, description string, operations []Operation) *Definition
• type OpenApiParser
  • func (p OpenApiParser) Parse(name string, data []byte) (*Definition, error)
• type Operation
  • func NewOperation(name string, summary string, description string, method string, ...) *Operation
• type OperationCategory
  • func NewOperationCategory(name string, description string) *OperationCategory
• type Parameter
  • func NewParameter(name string, t string, description string, in string, fieldName string, ...) *Parameter
• type Parser

Constants

const (
	ParameterTypeString       = "string"
	ParameterTypeBinary       = "binary"
	ParameterTypeInteger      = "integer"
	ParameterTypeNumber       = "number"
	ParameterTypeBoolean      = "boolean"
	ParameterTypeObject       = "object"
	ParameterTypeStringArray  = "stringArray"
	ParameterTypeIntegerArray = "integerArray"
	ParameterTypeNumberArray  = "numberArray"
	ParameterTypeBooleanArray = "booleanArray"
	ParameterTypeObjectArray  = "objectArray"
)

const (
	ParameterInPath   = "path"
	ParameterInQuery  = "query"
	ParameterInHeader = "header"
	ParameterInBody   = "body"
	ParameterInForm   = "form"
)

const CustomParameterNameExtension = "x-name"

const DefaultServerBaseUrl = "https://cloud.uipath.com"

const RawBodyParameterName = "$input"

Functions

func ToSnakeCase

func ToSnakeCase(str string) string

Types

type Definition

type Definition struct {
	Name        string
	Description string
	Operations  []Operation
}

func NewDefinition

func NewDefinition(name string, description string, operations []Operation) *Definition

type OpenApiParser

type OpenApiParser struct{}

func (OpenApiParser) Parse

func (p OpenApiParser) Parse(name string, data []byte) (*Definition, error)

type Operation

type Operation struct {
	Name        string
	Summary     string
	Description string
	Method      string
	BaseUri     url.URL
	Route       string
	ContentType string
	Parameters  []Parameter
	Plugin      plugin.CommandPlugin
	Hidden      bool
	Category    *OperationCategory
}

func NewOperation

func NewOperation(name string, summary string, description string, method string, baseUri url.URL, route string, contentType string, parameters []Parameter, plugin plugin.CommandPlugin, hidden bool, category *OperationCategory) *Operation

type OperationCategory

type OperationCategory struct {
	Name        string
	Description string
}

func NewOperationCategory

func NewOperationCategory(name string, description string) *OperationCategory

type Parameter

type Parameter struct {
	Name          string
	Type          string
	Description   string
	In            string
	FieldName     string
	Required      bool
	DefaultValue  interface{}
	AllowedValues []interface{}
	Parameters    []Parameter
}

func NewParameter

func NewParameter(name string, t string, description string, in string, fieldName string, required bool, defaultValue interface{}, allowedValues []interface{}, parameters []Parameter) *Parameter

type Parser

type Parser interface {
	Parse(name string, data []byte) (*Definition, error)
}