specs

package
v0.17.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 6, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// ProtocolREST identifies LS REST APIs in the official OpenAPI guide.
	ProtocolREST = "REST"
	// ProtocolWebSocket identifies LS realtime APIs in the official OpenAPI guide.
	ProtocolWebSocket = "WEBSOCKET"
)

Variables

View Source
var DocumentedLSEndpointSpecs = map[string]LSEndpointSpec{}/* 359 elements not displayed */

DocumentedLSEndpointSpecs is generated from documented LS snapshot.

Functions

func DocumentedEndpointSpecCount

func DocumentedEndpointSpecCount() int

DocumentedEndpointSpecCount returns the number of generated LS endpoint specs.

func DocumentedRESTEndpointSpecCount

func DocumentedRESTEndpointSpecCount() int

DocumentedRESTEndpointSpecCount returns the number of generated LS REST endpoint specs.

func DocumentedWebSocketEndpointSpecCount

func DocumentedWebSocketEndpointSpecCount() int

DocumentedWebSocketEndpointSpecCount returns the number of generated LS WebSocket endpoint specs.

Types

type LSEndpointSpec

type LSEndpointSpec struct {
	Path              string
	TRCode            string
	Method            string
	Protocol          string
	GroupName         string
	APIName           string
	TRName            string
	TransactionPerSec string
	RequestHeaders    []LSFieldSpec
	RequestFields     []LSFieldSpec
	ResponseHeaders   []LSFieldSpec
	ResponseFields    []LSFieldSpec
}

LSEndpointSpec defines one LS path/tr_cd specification from official docs.

func LookupDocumentedEndpointSpec

func LookupDocumentedEndpointSpec(path, trCD string) (LSEndpointSpec, bool)

LookupDocumentedEndpointSpec finds one generated LS endpoint spec by path/tr_cd.

type LSFieldSpec

type LSFieldSpec struct {
	Code        string
	Name        string
	Type        string
	Length      string
	Order       string
	Required    bool
	Description string
}

LSFieldSpec describes one request/response/header field from the LS docs.

Jump to

Keyboard shortcuts

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