config

Documentation

Index

• Constants
• func Handler(plugin Plugin, secret string, logs logger.Logger) http.Handler
• type Plugin
  • func Client(endpoint, secret string, skipverify bool) Plugin
• type Request

Constants

const V1 = "application/vnd.drone.config.v1+json"

V1 is version 1 of the configuration API

Functions

func Handler

func Handler(plugin Plugin, secret string, logs logger.Logger) http.Handler

Handler returns a http.Handler that accepts JSON-encoded HTTP requests for a config file, invokes the underlying config plugin, and writes the JSON-encoded config to the HTTP response.

The handler verifies the authenticity of the HTTP request using the http-signature, and returns a 400 Bad Request if the signature is missing or invalid.

The handler can optionally encrypt the response body using aesgcm if the HTTP request includes the Accept-Encoding header set to aesgcm.

Types

type Plugin

type Plugin interface {
	Find(context.Context, *Request) (*drone.Config, error)
}

Plugin responds to a configuration request.

func Client

func Client(endpoint, secret string, skipverify bool) Plugin

Client returns a new plugin client.

type Request

type Request struct {
	Build drone.Build `json:"build,omitempty"`
	Repo  drone.Repo  `json:"repo,omitempty"`
	Token drone.Token `json:"token,omitempty"`
}

Request defines a configuration request.