api

Documentation

Overview

Package api provides the API endpoints for the distributor.

Index

• Constants

Constants

const (
	// HTTPGetCheckpointN is the path of the URL to get a checkpoint with
	// at least N signatures.  The placeholders are:
	//  * first position is for the logID (an alphanumeric string)
	//  * second position is the number of signatures required
	HTTPGetCheckpointN = "/distributor/v0/logs/%s/checkpoint.%s"
	// HTTPCheckpointByWitness is the path of the URL to the latest checkpoint
	// for a given log by a given witness. This can take GET requests to fetch
	// the latest version, and PUT requests to update the latest checkpoint.
	//  * first position is for the logID (an alphanumeric string)
	//  * second position is the witness short name (alpha string)
	HTTPCheckpointByWitness = "/distributor/v0/logs/%s/byWitness/%s/checkpoint"
	// HTTPGetLogs is the path of the URL to get a list of all logs the
	// distributor is aware of.
	HTTPGetLogs = "/distributor/v0/logs"
	// HTTPGetWitnesses is the path of the URL to get a list of all witnesses
	// that the distributor is aware of.
	HTTPGetWitnesses = "/distributor/v0/witnesses"
)