docs

Documentation

Overview

Package classification Coordinator Client API

The Client API is designed as an HTTP-REST interface. Responses follow the [JSend style](https://github.com/omniti-labs/jsend), though only the response types success and error are returned so far.

Schemes: https
BasePath: /
Version: 0.4.0

Consumes:
- application/json

Produces:
- application/json

swagger:meta

Index

• type CertQuoteResponse
• type ErrorResponse
• type ManifestPostRequest
• type ManifestResponse
• type RecoverPostRequest
• type RecoveryDataResponse
• type RecoveryStatusResponse
• type SecretsGetRequest
• type SecretsMapResponse
• type SecretsPostRequest
• type StatusResponse
• type SuccessResponse
• type UpdateLogResponse

Types

type CertQuoteResponse

type CertQuoteResponse struct {
	// in:body
	Body struct {
		// example: success
		Status string
		Data   server.CertQuoteResp
	}
}

swagger:response CertQuoteResponse

type ErrorResponse

type ErrorResponse struct {
	// in:body
	Body struct {
		// example: error
		Status string
		Data   interface{}
		// example: InternalServerError
		Message string
	}
}

swagger:response ErrorResponse

type ManifestPostRequest

type ManifestPostRequest struct {
	// in:body
	Manifest manifest.Manifest
}

swagger:parameters manifestPost updatePost

type ManifestResponse

type ManifestResponse struct {
	// in:body
	Body struct {
		// example: success
		Status string
		Data   server.ManifestSignatureResp
	}
}

swagger:response ManifestResponse

type RecoverPostRequest

type RecoverPostRequest struct {
	// in:body
	// The base64 decoded and decrypted recovery secret
	RecoverySecret []byte
}

swagger:parameters recoverPost

type RecoveryDataResponse

type RecoveryDataResponse struct {
	// in:body
	Body struct {
		// example: success
		Status string
		Data   server.RecoveryDataResp
	}
}

swagger:response RecoveryDataResponse

type RecoveryStatusResponse

type RecoveryStatusResponse struct {
	// in:body
	Body struct {
		// example: success
		Status string
		Data   server.RecoveryStatusResp
	}
}

swagger:response RecoveryStatusResponse

type SecretsGetRequest

type SecretsGetRequest struct {
	// in:query
	// collection format: multi
	// items.minItems: 1
	S []string `json:"s"`
}

swagger:parameters secretsGet

type SecretsMapResponse

type SecretsMapResponse struct {
	// in:body
	Body struct {
		// example: success
		Status string
		// A map containing key-value pairs for the requested secret.
		Data map[string]manifest.Secret
	}
}

swagger:response SecretsMapResponse

type SecretsPostRequest

type SecretsPostRequest struct {
	// in:body
	Secrets map[string]manifest.UserSecret
}

swagger:parameters secretsPost

type StatusResponse

type StatusResponse struct {
	// in:body
	Body struct {
		// example: success
		Status string
		Data   server.StatusResp
	}
}

swagger:response StatusResponse

type SuccessResponse

type SuccessResponse struct {
	// in:body
	Body struct {
		// example: success
		Status string
		Data   interface{}
	}
}

swagger:response SuccessResponse

type UpdateLogResponse

type UpdateLogResponse struct {
	// in:body
	Body struct {
		// example: success
		Status string
		// example: SecurityVersion increased {"user": "someuser", "package": "somepackage", "new version": 4}
		Data string
	}
}

swagger:response UpdateLogResponse