api

package
v0.0.0-...-136c4f7 Latest Latest
Warning

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

Go to latest
Published: Aug 4, 2018 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ContainerConfig = Type("ContainerConfig", func() {
	Attribute("defaultShell", String)
})
View Source
var ContainerConfigOK = MediaType("vpn.application/goa.container.config", func() {
	Reference(ContainerConfig)
	Attributes(func() {
		Attribute("defaultShell")
	})

	View("default", func() {
		Attribute("defaultShell")
	})
})
View Source
var ContainerCreateOK = MediaType("vnd.application/goa.container.create.results+json", func() {
	Description("The results of container creation")
	Attributes(func() {
		Attribute("id", Integer, "container id")
		Attribute("endpoints", ArrayOf(String), "endpoint URL")

		Required("id", "endpoints")
	})

	View("default", func() {
		Attribute("id")
		Attribute("endpoints")
	})
})
View Source
var ContainerDownloadOK = MediaType("vpn.application/goa.container.download.result", func() {
	Attributes(func() {
		Attribute("file", File)
	})

	View("default", func() {
		Attribute("file")
	})
})
View Source
var ContainerInspectMedia = MediaType("vpn.application/goa.container.inspect", func() {
	Attributes(func() {
		Attribute("name", String, "Assign the specified name to the container. Must match /?[a-zA-Z0-9_-]+.")
		Attribute("id", Integer, "ID")
		Attribute("image", String, "The name of the image to use when creating the container")
		Attribute("imageID", String, "The container's image ID")
		Attribute("path", String, "The path to the command being run")
		Attribute("args", ArrayOf(String), "The arguments to the command being run")
		Attribute("created", DateTime, "The time the container was created")
		Attribute("volumes", ArrayOf(String), "Paths to mount volumes in")

		Attribute("status", String, func() {
			Enum("Image Downloading", "Created", "Running", "Stopped", "Error")
		})
		Attribute("raw_state", ContainerInspectRawStateMedia)

		Required("name", "id", "image", "imageID", "path", "args", "created", "status", "raw_state", "volumes")
	})

	View("default", func() {
		Attribute("name")
		Attribute("id")
		Attribute("image")
		Attribute("imageID")
		Attribute("path")
		Attribute("args")
		Attribute("created")
		Attribute("volumes")
		Attribute("status")
		Attribute("raw_state")
	})
})
View Source
var ContainerInspectRawStateMedia = MediaType("vnd.application/goa.container.inspect.raw_state", func() {
	Attributes(func() {
		Attribute("exitCode", Integer)
		Attribute("finishedAt", DateTime)
		Attribute("oomKilled", Boolean)
		Attribute("dead", Boolean)
		Attribute("paused", Boolean)
		Attribute("pid", Integer)
		Attribute("restarting", Boolean)
		Attribute("running", Boolean)
		Attribute("startedAt", DateTime)
		Attribute("status", String, func() {
			Enum("created", "running", "paused", "restarting", "removing", "exited", "dead")
		})

		Required("exitCode", "finishedAt", "oomKilled", "dead", "paused", "pid", "restarting", "running", "startedAt", "status")
	})

	View("default", func() {
		Attribute("exitCode")
		Attribute("finishedAt")
		Attribute("oomKilled")
		Attribute("dead")
		Attribute("paused")
		Attribute("pid")
		Attribute("restarting")
		Attribute("running")
		Attribute("startedAt")
		Attribute("status")
	})
})
View Source
var ContainerListEachMedia = MediaType("vpn.application/goa.container.list.each", func() {
	Attributes(func() {
		Attribute("name", String, "Assign the specified name to the container. Must match /?[a-zA-Z0-9_-]+.")
		Attribute("id", Integer, "ID")
		Attribute("image", String, "The name of the image to use when creating the container")
		Attribute("imageID", String, "The container's image ID")
		Attribute("command", String, "Command to run when starting the container")
		Attribute("created", DateTime, "The time the container was created")
		Attribute("volumes", ArrayOf(String), "Paths to mount volumes in")
		Attribute("status", String, func() {
			Enum("Creating", "Created", "Running", "Stopped", "Error")
		})

		Required("name", "id", "image", "imageID", "command", "created", "status", "volumes")
	})

	View("default", func() {
		Attribute("name")
		Attribute("id")
		Attribute("image")
		Attribute("imageID")
		Attribute("command")
		Attribute("created")
		Attribute("volumes")
		Attribute("status")
	})
})
View Source
var JWT = JWTSecurity("jwt", func() {
	Header("Authorization")
	Scope("api:access", "API access")
})
View Source
var UploadPayload = Type("UploadPayload", func() {
	Attribute("path", String, "Path in the container to save files")
	Attribute("data", File, "File tar archive")
	Attribute("allowOverwrite", Boolean, func() {
		Description("Allow for a existing directory to be replaced by a file")
		Default(false)
	})
	Attribute("copyUIDGID", Boolean, func() {
		Description("Copy all uid/gid information")
		Default(false)
	})

	Required("path", "data", "copyUIDGID")
})
View Source
var UserAuthorizedKeyOK = MediaType("vpn.application/goa.user.authorizedKey", func() {
	Reference(UserAuthorizedKeyType)

	Attributes(func() {
		Attribute("key")
		Attribute("label")

		Required("key", "label")
	})

	View("default", func() {
		Attribute("key")
		Attribute("label")
	})
})
View Source
var UserAuthorizedKeyType = Type("UserAuthorizedKey", func() {
	Attribute("key", String, func() {
		MaxLength(2048)
	})
	Attribute("label", String, func() {
		Pattern("^[a-zA-Z0-9_]+$")
		MaxLength(32)
		MinLength(1)
	})

	Required("key", "label")
})
View Source
var UserConfig = Type("UserConfig", func() {
	Attribute("defaultShell", String)
	Attribute("authorizedKeys", ArrayOf(UserAuthorizedKeyType))
})
View Source
var UserConfigOK = MediaType("vpn.application/goa.user.config", func() {
	Attributes(func() {
		Attribute("defaultShell", String)
		Attribute("authorizedKeys", CollectionOf(UserAuthorizedKeyOK))

		Required("defaultShell", "authorizedKeys")
	})

	View("default", func() {
		Attribute("defaultShell")
		Attribute("authorizedKeys")
	})
})
View Source
var UserDefaultShellOK = MediaType("vpn.application/goa.user.defaultShell", func() {
	Attributes(func() {
		Attribute("defaultShell", String)

		Required("defaultShell")
	})

	View("default", func() {
		Attribute("defaultShell")
	})
})

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

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