Documentation
¶
Index ¶
- Constants
- type Client
- type ClientError
- type ClientRequest
- type ClientRequestContext
- type ClientRequestRequest
- type ClientRequestSettings
- type ClientResponse
- type ClientResponseResponse
- type ContentType
- type Header
- type Server
- type ServerRequest
- type ServerResponse
- type ServerResponseBody
- type ServerSettings
- type ServerStart
- type ServerStartContext
- type ServerStartControl
- type ServerStatus
- type ServerStop
- type ServerStopControl
Constants ¶
View Source
const ( ClientComponent = "http_client" ClientRequestPort = "request" ClientResponsePort = "response" ClientErrorPort = "error" )
View Source
const ( HeaderContentType = "Content-Type" MIMEApplicationJSON = "application/json" MIMEApplicationXML = "application/xml" MIMETextXML = "text/xml" MimeTextPlain = "text/plain" MIMETextHTML = "text/html" MIMEApplicationForm = "application/x-www-form-urlencoded" MIMEMultipartForm = "multipart/form-data" )
View Source
const ( ServerComponent string = "http_server" ServerResponsePort = "response" ServerRequestPort = "request" ServerStartPort = "start" ServerStopPort = "stop" ServerStatusPort = "status" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) GetInfo ¶
func (h *Client) GetInfo() module.ComponentInfo
type ClientError ¶
type ClientError struct {
Context ClientRequestContext `json:"context" configurable:"true" required:"true" title:"Context" description:"Message to be sent further"`
Request ClientRequestRequest `json:"request" required:"true"`
Response ClientResponseResponse `json:"response"`
Error string `json:"error" required:"true"`
}
type ClientRequest ¶
type ClientRequest struct {
Context ClientRequestContext `json:"context,omitempty" configurable:"true" title:"Context" description:"Message to be sent further"`
Request ClientRequestRequest `json:"request" title:"Request" required:"true" description:"HTTP Request"`
}
type ClientRequestContext ¶
type ClientRequestContext any
type ClientRequestRequest ¶
type ClientRequestRequest struct {
Method string `` /* 137-byte string literal not displayed */
Timeout int `json:"timeout" required:"true" title:"Request Timeout" colSpan:"col-span-6"`
URL string `json:"url" required:"true" title:"URL" format:"uri"`
ContentType ContentType `json:"contentType" title:"Request Content Type" required:"true"`
Headers []Header `json:"headers" required:"true" title:"Headers"`
Body any `json:"body" configurable:"true" title:"Request Body"`
ResponseContentType ContentType `json:"responseContentType,omitempty" title:"Response Content Type" description:"Override response content type"`
}
type ClientRequestSettings ¶
type ClientRequestSettings struct {
EnableErrorPort bool `` /* 137-byte string literal not displayed */
}
type ClientResponse ¶
type ClientResponse struct {
Context ClientRequestContext `json:"context" configurable:"true" required:"true" title:"Context" description:"Message to be sent further"`
Request ClientRequestRequest `json:"request" title:"Request" required:"true" description:"HTTP Request"`
Response ClientResponseResponse `json:"response" title:"Response" required:"true" description:"HTTP Response"`
}
type ClientResponseResponse ¶
type ContentType ¶
type ContentType string
func (ContentType) JSONSchema ¶
func (c ContentType) JSONSchema() (jsonschema.Schema, error)
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
func (*Server) GetInfo ¶
func (h *Server) GetInfo() module.ComponentInfo
type ServerRequest ¶
type ServerRequest struct {
Context ServerStartContext `json:"context"`
RequestID string `json:"requestID" required:"true"`
RequestURI string `json:"requestURI" required:"true"`
RequestParams url.Values `json:"requestParams" required:"true"`
Host string `json:"host" required:"true"`
Method string `json:"method" required:"true" title:"Method" enum:"GET,POST,PATCH,PUT,DELETE" enumTitles:"GET,POST,PATCH,PUT,DELETE"`
RealIP string `json:"realIP"`
Headers []Header `json:"headers,omitempty"`
Body any `json:"body"`
Scheme string `json:"scheme"`
}
type ServerResponse ¶
type ServerResponse struct {
RequestID string `` /* 143-byte string literal not displayed */
StatusCode int `` /* 139-byte string literal not displayed */
ContentType ContentType `json:"contentType" required:"true"`
Headers []Header `json:"headers" title:"Response headers"`
Body ServerResponseBody `json:"body" title:"Response body" configurable:"true"`
}
type ServerResponseBody ¶
type ServerResponseBody any
type ServerSettings ¶
type ServerSettings struct {
EnableStatusPort bool `` /* 127-byte string literal not displayed */
EnableStopPort bool `json:"enableStopPort" required:"true" title:"Enable stop port" description:"Stop port allows you to stop the server"`
EnableStartPort bool `json:"enableStartPort" required:"true" title:"Enable start port" description:"Start port allows you to start the server"`
}
type ServerStart ¶
type ServerStart struct {
Context ServerStartContext `json:"context" configurable:"true" title:"Context" description:"Start context"`
AutoHostName bool `json:"autoHostName" title:"Automatically generate hostname" description:"Use cluster auto subdomain setup if any."`
Hostnames []string `json:"hostnames" title:"Hostnames" required:"false" description:"List of virtual host this server should be bound to."` //requiredWhen:"['kind', 'equal', 'enum 1']"
ReadTimeout int `` /* 215-byte string literal not displayed */
WriteTimeout int `` /* 204-byte string literal not displayed */
}
type ServerStartContext ¶
type ServerStartContext any
type ServerStartControl ¶
type ServerStatus ¶
type ServerStatus struct {
Context ServerStartContext `json:"context" title:"Context"`
ListenAddr []string `json:"listenAddr" title:"Listen Address" readonly:"true"`
IsRunning bool `json:"isRunning" title:"Is running" readonly:"true"`
}
type ServerStop ¶
type ServerStop struct {
}
type ServerStopControl ¶
Click to show internal directories.
Click to hide internal directories.