pluginhttp

README

http Plugin

This plugin permorms an http request.

Configuration

Fields	Description
url	destination for the http call, including host, path and query params
method	http method (GET/POST/PUT/DELETE)
body	a string representing the payload to be sent with the request
headers	a list of headers, represented as objects composed of name and value
timeout_seconds	an unsigned int representing a custom HTTP client timeout in seconds
auth	a single object composed of either a basic object with user and password fields to enable HTTP basic auth, or bearer field to enable Bearer Token Authorization
deny_redirects	a boolean representing the policy of redirects
parameters	a list of HTTP query parameters, represented as objects composed of key and value
trim_prefix	prefix in the response that must be removed before unmarshalling (optional)

Example

An action of type http requires the following kind of configuration:

action:
  type: http
  configuration:
    # mandatory, string
    url: http://example.org/user
    # mandatory, string
    method: POST
    # optional, string as uint16
    timeout_seconds: "5"
    # optional, authentication you can user either basic or bearer auth
    auth:
      basic: 
        user: {{.config.basicAuth.user}}
        password: {{.config.basicAuth.password}}
      bearer: {{.config.auth.token}}
    # optional, string as boolean
    deny_redirects: "false"
    # optional, array of key and value fields
    parameters:
    - key: foo
      value: bar
    # optional, array of name and value fields
    headers:
    - name:  x-request-id
      value: xxx-yyy-zzz
    # optional, string
    body: |
      {
        "name": "pablo"
      }

Requirements

None by default. Sensitive data should be retrieved from configstore and accessed through {{.config.[itemKey]}} rather than hardcoded in your template.

Documentation

Index

• Variables
• func ExecutorMetadata() string
• type Auth
• type AuthBasic
• type HTTPClient
• type HTTPClientConfig
• type HTTPConfig
• type Header
• type Parameter

Variables

var NewHTTPClient = defaultHTTPClientFactory

NewHTTPClient is a factory of HTTPClient

var (
	Plugin = taskplugin.New("http", "0.7", exec,
		taskplugin.WithConfig(validConfig, HTTPConfig{}),
	)
)

the HTTP plugin performs an HTTP call

Functions

func ExecutorMetadata

func ExecutorMetadata() string

ExecutorMetadata generates json schema to validate the metadata returned by the http executor

Types

type Auth

type Auth struct {
	Basic  AuthBasic `json:"basic"`
	Bearer string    `json:"bearer"`
}

Auth represents HTTP authentication

type AuthBasic

type AuthBasic struct {
	User     string `json:"user"`
	Password string `json:"password"`
}

AuthBasic represents the embedded basic auth inside Auth struct

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient is an interface for decoupling http.Client

type HTTPClientConfig

type HTTPClientConfig struct {
	Timeout       time.Duration
	DenyRedirects bool
}

HTTPClientConfig is a set of options used to initialize a HTTPClient

type HTTPConfig

type HTTPConfig struct {
	URL            string      `json:"url"`
	Method         string      `json:"method"`
	Body           string      `json:"body,omitempty"`
	Headers        []Header    `json:"headers,omitempty"`
	TimeoutSeconds string      `json:"timeout_seconds,omitempty"`
	Auth           Auth        `json:"auth,omitempty"`
	DenyRedirects  string      `json:"deny_redirects,omitempty"`
	Parameters     []Parameter `json:"parameters,omitempty"`
	TrimPrefix     string      `json:"trim_prefix,omitempty"`
}

HTTPConfig is the configuration needed to perform an HTTP call

type Header

type Header struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

Header represents an HTTP header

type Parameter

type Parameter struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

Parameter represents HTTP parameters