botdoc

package

v0.0.0-...-bd3da21 Latest Latest Go to latest Published: Jan 23, 2025 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gotd/botapi

Links

Open Source Insights

Documentation ¶

Overview ¶

Package botdoc implement types definition extraction from documentation.

Index ¶

func IndexOneOf(s string, subs ...string) (idx int, variant string)
type API
- func Extract(doc *goquery.Document) (a API)
- func (a API) OAS() (*ogen.Spec, error)
type Definition
type Field
type Kind
type Primitive
- func (p Primitive) String() string
type Type
- func ParseType(s string) Type
- func (t Type) String() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func IndexOneOf ¶

func IndexOneOf(s string, subs ...string) (idx int, variant string)

IndexOneOf is like strings.Index, but for multiple substrings.

It returns index like strings.Index and found substring.

Types ¶

type API ¶

type API struct {
	Version string
	Types   []Definition
	Methods []Definition
}

API definition.

func Extract ¶

func Extract(doc *goquery.Document) (a API)

Extract API definition from goquery document.

func (API) OAS ¶

func (a API) OAS() (*ogen.Spec, error)

OAS generates OpenAPI v3 Specification from API definition.

type Definition ¶

type Definition struct {
	Name              string
	RawText           string
	PrettyDescription string
	Fields            []Field
	Ret               *Type
}

Definition of structure (method or object).

type Field ¶

type Field struct {
	Type              Type
	Name              string
	RawText           string
	PrettyDescription string
	Enum              []string
	Optional          bool
}

Field of object or argument of function.

type Kind ¶

type Kind string

Kind of Type.

const (
	KindPrimitive Kind = "primitive"
	KindArray     Kind = "array"
	KindObject    Kind = "object"
	KindSum       Kind = "sum"
)

Possible types.

type Primitive ¶

type Primitive string

Primitive type.

const (
	String  Primitive = "String"
	Integer Primitive = "Integer"
	Float   Primitive = "Float"
	Boolean Primitive = "Boolean"
)

Possible primitives.

func (Primitive) String ¶

func (p Primitive) String() string

type Type ¶

type Type struct {
	Name      string
	Kind      Kind
	Primitive Primitive
	Item      *Type
	Sum       []Type
}

Type of field or parameter.

func ParseType ¶

func ParseType(s string) Type

ParseType parses telegram documentation Type from string

func (Type) String ¶

func (t Type) String() string

Source Files ¶

View all Source files

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