api

package
v0.0.0-...-564ba19 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 27, 2018 License: Apache-2.0 Imports: 0 Imported by: 0

README

Malice Engine API

The Engine API is an HTTP API used by the command-line client to communicate with the daemon. It can also be used by third-party software to control the daemon.

It consists of various components in this repository:

  • api/apiary.apib A API Blueprint definition of the API.
  • api/types/ Types shared by both the client and server, representing various objects, options, responses, etc.
  • cmd/ The command-line client.
  • client/ The Go client used by the command-line client. It can also be used by third-party Go programs.
  • daemon/ The daemon, which serves the API.

Documentation

Index

Constants

View Source
const (
	// DefaultVersion of Current REST API
	DefaultVersion = "1.0"
)

Common constants for daemon and client.

View Source
const MinVersion = "1.0"

MinVersion represents Minimum REST API version supported

Variables

This section is empty.

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
Package errdefs defines a set of error interfaces that packages should use for communicating classes of errors.
Package errdefs defines a set of error interfaces that packages should use for communicating classes of errors.
filters
Package filters provides tools for encoding a mapping of keys to a set of multiple values.
Package filters provides tools for encoding a mapping of keys to a set of multiple values.
web

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL