parser

Documentation

Index

• Constants
• func ToSnakeCase(str string) string
• type Definition
  • func NewDefinition(name string, baseUri url.URL, description string, operations []Operation) *Definition
• type OpenApiParser
  • func (p OpenApiParser) Parse(name string, data []byte) (*Definition, error)
• type Operation
  • func NewOperation(name string, description string, method string, route string, ...) *Operation
• 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 DefaultServerBaseUrl = "https://cloud.uipath.com"

Functions

func ToSnakeCase

func ToSnakeCase(str string) string

Types

type Definition

type Definition struct {
	Name        string
	BaseUri     url.URL
	Description string
	Operations  []Operation
}

func NewDefinition

func NewDefinition(name string, baseUri url.URL, 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
	Description string
	Method      string
	Route       string
	Parameters  []Parameter
	Plugin      plugin.CommandPlugin
	Hidden      bool
}

func NewOperation

func NewOperation(name string, description string, method string, route string, parameters []Parameter, plugin plugin.CommandPlugin, hidden bool) *Operation

type Parameter

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

func NewParameter

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

type Parser

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