catalog

package

Go to main page

Versions in this module

v0

v0.3.0

Jul 5, 2024

Changes in this version

type Catalog

+ func (c *Catalog) AddOperationID(d directive.Directive, id string) error

type HTTPInteraction

+ OperationId *string

v0.2.0

May 9, 2024

Changes in this version

type ExchangeJSightSchema

+ func (e *ExchangeJSightSchema) CastToObject() *ExchangeJSightSchema

+ func (e *ExchangeJSightSchema) Notation() notation.SchemaNotation

type ExchangeRegexSchema

+ func NewExchangeRegexSchema(regexStr bytes.Bytes) (*ExchangeRegexSchema, error)

+ func (e ExchangeRegexSchema) Notation() notation.SchemaNotation

type ExchangeSchema

+ Notation func() notation.SchemaNotation

v0.1.1

Nov 16, 2022

Changes in this version

+ const JDocExchangeVersion

+ func Annotation(s string) string

+ func StrPtr(s string) *string

+ type Catalog struct

+ Info *Info

+ Interactions *Interactions

+ JSightVersion string

+ Servers *Servers

+ Tags *Tags

+ UserEnums *UserRules

+ UserTypes *UserTypes

+ func NewCatalog() *Catalog

+ func (*Catalog) Read(coords directive.Coords) bytes.Bytes

+ func (c *Catalog) AddBaseURL(serverName, path string) error

+ func (c *Catalog) AddDescriptionToHTTPMethod(d directive.Directive, text string) error

+ func (c *Catalog) AddDescriptionToInfo(text string) error

+ func (c *Catalog) AddDescriptionToJsonRpcMethod(d directive.Directive, text string) error

+ func (c *Catalog) AddDescriptionToTag(name, description string) error

+ func (c *Catalog) AddEnum(d *directive.Directive, e *enum.Enum) *jerr.JApiError

+ func (c *Catalog) AddHTTPMethod(d directive.Directive) *jerr.JApiError

+ func (c *Catalog) AddInfo(d directive.Directive) error

+ func (c *Catalog) AddJSight(version string) error

+ func (c *Catalog) AddJsonRpcMethod(d directive.Directive) *jerr.JApiError

+ func (c *Catalog) AddJsonRpcParams(s *ExchangeJSightSchema, d directive.Directive) error

+ func (c *Catalog) AddJsonRpcResult(s *ExchangeJSightSchema, d directive.Directive) error

+ func (c *Catalog) AddQueryToCurrentMethod(d directive.Directive, q Query) error

+ func (c *Catalog) AddRequest(d directive.Directive) error

+ func (c *Catalog) AddRequestBody(s ExchangeSchema, f SerializeFormat, d directive.Directive) error

+ func (c *Catalog) AddRequestHeaders(s *ExchangeJSightSchema, d directive.Directive) error

+ func (c *Catalog) AddResponse(code, annotation string, d directive.Directive) error

+ func (c *Catalog) AddResponseBody(schemaBytes bytes.Bytes, bodyFormat SerializeFormat, ...) *jerr.JApiError

+ func (c *Catalog) AddResponseHeaders(s *ExchangeJSightSchema, d directive.Directive) error

+ func (c *Catalog) AddServer(name, annotation string) error

+ func (c *Catalog) AddTag(name, title string) error

+ func (c *Catalog) AddTagDescription(name, title string) error

+ func (c *Catalog) AddTitle(name string) error

+ func (c *Catalog) AddType(d directive.Directive, tt *UserSchemas, rr map[string]schema.Rule) *jerr.JApiError

+ func (c *Catalog) AddVersion(version string) error

+ func (c *Catalog) MarshalJSON() ([]byte, error)

+ func (c *Catalog) ToJson() ([]byte, error)

+ func (c *Catalog) ToJsonIndent() ([]byte, error)

+ type ExchangeContent struct

+ Children []*ExchangeContent

+ InheritedFrom string

+ IsKeyUserTypeRef bool

+ Key *string

+ Note string

+ Optional bool

+ Rules *Rules

+ ScalarValue string

+ TokenType string

+ Type string

+ func (c *ExchangeContent) IsObjectHaveProperty(k string) bool

+ func (c *ExchangeContent) MarshalJSON() (b []byte, err error)

+ func (c *ExchangeContent) ObjectProperty(k string) *ExchangeContent

+ func (c *ExchangeContent) ToUsedUserTypes(uut *StringSet)

+ func (c *ExchangeContent) Unshift(v *ExchangeContent)

+ type ExchangeJSightSchema struct

+ func NewExchangeJSightSchema(name string, b T, coreUserTypes *UserSchemas, coreRules map[string]schema.Rule, ...) (*ExchangeJSightSchema, error)

+ func (e *ExchangeJSightSchema) Compile() (err error)

+ func (e *ExchangeJSightSchema) Example() ([]byte, error)

+ func (e *ExchangeJSightSchema) MarshalJSON() ([]byte, error)

+ type ExchangePseudoSchema struct

+ Notation notation.SchemaNotation

+ func NewExchangePseudoSchema(n notation.SchemaNotation) *ExchangePseudoSchema

+ func (e ExchangePseudoSchema) MarshalJSON() ([]byte, error)

+ type ExchangeRegexSchema struct

+ func PrepareRegexSchema(name string, regexStr bytes.Bytes) (*ExchangeRegexSchema, error)

+ func (e ExchangeRegexSchema) MarshalJSON() ([]byte, error)

+ type ExchangeSchema interface

+ MarshalJSON func() ([]byte, error)

+ type HTTPInteraction struct

+ Annotation *string

+ Description *string

+ HttpMethod HTTPMethod

+ Id string

+ PathVal Path

+ PathVariables *PathVariables

+ Protocol Protocol

+ Query *Query

+ Request *HTTPRequest

+ Responses []HTTPResponse

+ Tags []TagName

+ func (h *HTTPInteraction) SetPathVariables(p *PathVariables)

+ func (h HTTPInteraction) Path() Path

+ type HTTPInteractionID struct

+ func (h HTTPInteractionID) MarshalText() ([]byte, error)

+ func (h HTTPInteractionID) Method() HTTPMethod

+ func (h HTTPInteractionID) Path() Path

+ func (h HTTPInteractionID) Protocol() Protocol

+ func (h HTTPInteractionID) String() string

+ type HTTPMethod uint8

+ const DELETE

+ const GET

+ const OPTIONS

+ const PATCH

+ const POST

+ const PUT

+ func NewHTTPMethod(de directive.Enumeration) (HTTPMethod, error)

+ func NewHTTPMethodFromString(s string) (HTTPMethod, error)

+ func (e HTTPMethod) MarshalText() ([]byte, error)

+ func (e HTTPMethod) String() string

+ type HTTPRequest struct

+ Directive directive.Directive

+ type HTTPRequestBody struct

+ Directive directive.Directive

+ Format SerializeFormat

+ Schema ExchangeSchema

+ type HTTPRequestHeaders struct

+ Directive directive.Directive

+ Schema *ExchangeJSightSchema

+ type HTTPResponse struct

+ Annotation string

+ Body *HTTPResponseBody

+ Code string

+ Directive directive.Directive

+ Headers *HTTPResponseHeaders

+ type HTTPResponseBody struct

+ Directive directive.Directive

+ Format SerializeFormat

+ Schema ExchangeSchema

+ func NewHTTPResponseBody(b bytes.Bytes, f SerializeFormat, sn notation.SchemaNotation, ...) (HTTPResponseBody, *jerr.JApiError)

+ type HTTPResponseHeaders struct

+ Directive directive.Directive

+ Schema *ExchangeJSightSchema

+ type Info struct

+ Description *string

+ Directive directive.Directive

+ Title string

+ Version string

+ type Interaction interface

+ Path func() Path

+ type InteractionID interface

+ MarshalText func() ([]byte, error)

+ Path func() Path

+ Protocol func() Protocol

+ String func() string

+ type Interactions struct

+ func (m *Interactions) Each(fn eachInteractionsFunc) error

+ func (m *Interactions) EachReverse(fn eachInteractionsFunc) error

+ func (m *Interactions) EachSafe(fn eachSafeInteractionsFunc)

+ func (m *Interactions) Find(fn findInteractionsFunc) (InteractionsItem, bool)

+ func (m *Interactions) Get(k InteractionID) (Interaction, bool)

+ func (m *Interactions) GetValue(k InteractionID) Interaction

+ func (m *Interactions) Has(k InteractionID) bool

+ func (m *Interactions) Len() int

+ func (m *Interactions) Map(fn mapInteractionsFunc) error

+ func (m *Interactions) MarshalJSON() ([]byte, error)

+ func (m *Interactions) Set(k InteractionID, v Interaction)

+ func (m *Interactions) SetToTop(k InteractionID, v Interaction)

+ func (m *Interactions) Update(k InteractionID, fn func(v Interaction) Interaction)

+ type InteractionsItem struct

+ Key InteractionID

+ Value Interaction

+ type JSchemaObject struct

+ func (s *JSchemaObject) ObjectFirstLevelProperties(ut map[string]*jschema.JSchema) map[string]ischema.Node

+ func (s *JSchemaObject) ObjectProperty(key string) (ischema.Node, bool)

+ func (s *JSchemaObject) RootObjectNode() (*ischema.ObjectNode, bool)

+ type JsonRpcInteraction struct

+ Annotation *string

+ Description *string

+ Id string

+ Method string

+ Params *jsonRpcParams

+ PathVal Path

+ Protocol Protocol

+ Result *jsonRpcResult

+ Tags []TagName

+ func (j JsonRpcInteraction) Path() Path

+ type JsonRpcInteractionId struct

+ func (j JsonRpcInteractionId) MarshalText() ([]byte, error)

+ func (j JsonRpcInteractionId) Path() Path

+ func (j JsonRpcInteractionId) Protocol() Protocol

+ func (j JsonRpcInteractionId) String() string

+ type ObjectBuilder struct

+ func NewObjectBuilder() ObjectBuilder

+ func (b ObjectBuilder) AddProperty(key string, node ischema.Node, types map[string]ischema.Type)

+ func (b ObjectBuilder) AddType(name string, sc schema.Schema)

+ func (b ObjectBuilder) Build() *jschema.JSchema

+ func (b ObjectBuilder) Len() int

+ func (b ObjectBuilder) UserTypeNames() []string

+ type Path string

+ func (p Path) String() string

+ type PathVariables struct

+ Schema *ExchangeJSightSchema

+ type PathVariablesBuilder struct

+ func NewPathVariablesBuilder(catalogUserTypes *UserTypes) PathVariablesBuilder

+ func (b PathVariablesBuilder) AddProperty(key string, node ischema.Node, types map[string]ischema.Type)

+ func (b PathVariablesBuilder) Build() *PathVariables

+ func (b PathVariablesBuilder) Len() int

+ type Prop struct

+ ASTNode schema.ASTNode

+ Directive directive.Directive

+ Parameter string

+ type Protocol string

+ const HTTP

+ const JsonRpc

+ type Query struct

+ Directive directive.Directive

+ Example string

+ Format string

+ Schema *ExchangeJSightSchema

+ func NewQuery(d directive.Directive) Query

+ type Rule struct

+ Children []Rule

+ Key string

+ Note string

+ ScalarValue string

+ TokenType RuleTokenType

+ func (r Rule) MarshalJSON() (b []byte, err error)

+ type RuleTokenType string

+ const RuleTokenTypeAnnotation

+ const RuleTokenTypeArray

+ const RuleTokenTypeBoolean

+ const RuleTokenTypeNull

+ const RuleTokenTypeNumber

+ const RuleTokenTypeObject

+ const RuleTokenTypeReference

+ const RuleTokenTypeString

+ type Rules struct

+ func NewRules(d []Rule) *Rules

+ func (rr *Rules) Each(fn findRulesFunc) error

+ func (rr *Rules) Get(k string) (Rule, bool)

+ func (rr *Rules) Has(k string) bool

+ func (rr *Rules) Len() int

+ func (rr *Rules) MarshalJSON() ([]byte, error)

+ type RulesBuilder struct

+ func (b *RulesBuilder) Append(r Rule)

+ func (b *RulesBuilder) Rules() *Rules

+ func (b *RulesBuilder) Set(k string, r Rule)

+ type SerializeFormat string

+ const SerializeFormatBinary

+ const SerializeFormatJSON

+ const SerializeFormatPlainString

+ func SchemaSerializeFormat(n notation.SchemaNotation) (SerializeFormat, error)

+ type Server struct

+ Annotation string

+ BaseUrl string

+ BaseUrlVariables *baseURLVariables

+ type Servers struct

+ func (m *Servers) Each(fn eachServersFunc) error

+ func (m *Servers) EachReverse(fn eachServersFunc) error

+ func (m *Servers) EachSafe(fn eachSafeServersFunc)

+ func (m *Servers) Find(fn findServersFunc) (ServersItem, bool)

+ func (m *Servers) Get(k string) (*Server, bool)

+ func (m *Servers) GetValue(k string) *Server

+ func (m *Servers) Has(k string) bool

+ func (m *Servers) Len() int

+ func (m *Servers) Map(fn mapServersFunc) error

+ func (m *Servers) MarshalJSON() ([]byte, error)

+ func (m *Servers) Set(k string, v *Server)

+ func (m *Servers) SetToTop(k string, v *Server)

+ func (m *Servers) Update(k string, fn func(v *Server) *Server)

+ type ServersItem struct

+ Key string

+ Value *Server

+ type StringSet struct

+ func NewStringSet(vv ...string) *StringSet

+ func (m *StringSet) Add(v string)

+ func (m *StringSet) Data() []string

+ func (m *StringSet) Has(v string) bool

+ func (m *StringSet) Len() int

+ type Tag struct

+ Children *Tags

+ Description *string

+ InteractionGroups map[Protocol]TagInteractionGroup

+ Name TagName

+ Title string

+ func NewTag(name, title string) *Tag

+ func (t *Tag) MarshalJSON() ([]byte, error)

+ type TagHTTPInteractionGroup struct

+ Interactions []InteractionID

+ Protocol Protocol

+ type TagInteractionGroup interface

+ type TagJsonRpcInteractionGroup struct

+ Interactions []InteractionID

+ Protocol Protocol

+ type TagName string

+ func (t TagName) MarshalText() ([]byte, error)

+ type Tags struct

+ func (m *Tags) Each(fn eachTagsFunc) error

+ func (m *Tags) EachReverse(fn eachTagsFunc) error

+ func (m *Tags) EachSafe(fn eachSafeTagsFunc)

+ func (m *Tags) Find(fn findTagsFunc) (TagsItem, bool)

+ func (m *Tags) Get(k TagName) (*Tag, bool)

+ func (m *Tags) GetValue(k TagName) *Tag

+ func (m *Tags) Has(k TagName) bool

+ func (m *Tags) Len() int

+ func (m *Tags) Map(fn mapTagsFunc) error

+ func (m *Tags) MarshalJSON() ([]byte, error)

+ func (m *Tags) Set(k TagName, v *Tag)

+ func (m *Tags) SetToTop(k TagName, v *Tag)

+ func (m *Tags) Update(k TagName, fn func(v *Tag) *Tag)

+ type TagsItem struct

+ Key TagName

+ Value *Tag

+ type UserRule struct

+ Annotation string

+ Description string

+ Directive *directive.Directive

+ Value Rule

+ type UserRules struct

+ func (m *UserRules) Each(fn eachUserRulesFunc) error

+ func (m *UserRules) EachReverse(fn eachUserRulesFunc) error

+ func (m *UserRules) EachSafe(fn eachSafeUserRulesFunc)

+ func (m *UserRules) Find(fn findUserRulesFunc) (UserRulesItem, bool)

+ func (m *UserRules) Get(k string) (*UserRule, bool)

+ func (m *UserRules) GetValue(k string) *UserRule

+ func (m *UserRules) Has(k string) bool

+ func (m *UserRules) Len() int

+ func (m *UserRules) Map(fn mapUserRulesFunc) error

+ func (m *UserRules) MarshalJSON() ([]byte, error)

+ func (m *UserRules) Set(k string, v *UserRule)

+ func (m *UserRules) SetToTop(k string, v *UserRule)

+ func (m *UserRules) Update(k string, fn func(v *UserRule) *UserRule)

+ type UserRulesItem struct

+ Key string

+ Value *UserRule

+ type UserSchemas struct

+ func (m *UserSchemas) Each(fn eachUserSchemasFunc) error

+ func (m *UserSchemas) EachSafe(fn eachSafeUserSchemasFunc)

+ func (m *UserSchemas) Get(k string) (schema.Schema, bool)

+ func (m *UserSchemas) GetValue(k string) schema.Schema

+ func (m *UserSchemas) Has(k string) bool

+ func (m *UserSchemas) Len() int

+ func (m *UserSchemas) Map(fn mapUserSchemasFunc) error

+ func (m *UserSchemas) MarshalJSON() ([]byte, error)

+ func (m *UserSchemas) Set(k string, v schema.Schema)

+ func (m *UserSchemas) Update(k string, fn func(v schema.Schema) schema.Schema)

+ type UserSchemasItem struct

+ Key string

+ Value schema.Schema

+ type UserType struct

+ Annotation string

+ Description string

+ Directive directive.Directive

+ Schema ExchangeSchema

+ type UserTypes struct

+ func (m *UserTypes) Each(fn eachUserTypesFunc) error

+ func (m *UserTypes) EachReverse(fn eachUserTypesFunc) error

+ func (m *UserTypes) EachSafe(fn eachSafeUserTypesFunc)

+ func (m *UserTypes) Find(fn findUserTypesFunc) (UserTypesItem, bool)

+ func (m *UserTypes) Get(k string) (*UserType, bool)

+ func (m *UserTypes) GetValue(k string) *UserType

+ func (m *UserTypes) Has(k string) bool

+ func (m *UserTypes) Len() int

+ func (m *UserTypes) Map(fn mapUserTypesFunc) error

+ func (m *UserTypes) MarshalJSON() ([]byte, error)

+ func (m *UserTypes) Set(k string, v *UserType)

+ func (m *UserTypes) SetToTop(k string, v *UserType)

+ func (m *UserTypes) Update(k string, fn func(v *UserType) *UserType)

+ type UserTypesItem struct

+ Key string

+ Value *UserType

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