design

Documentation

Index

• Variables

Variables

var JoinTokens = Type("JoinTokens", func() {
	Description("Docker Swarm Join Tokens")
	Attribute("worker", String)
	Attribute("manager", String)
})

var ServicePayload = Type("ServicePayload", func() {
	Attribute("image", String, func() {
		Description("Docker base image to attach to Service")
		Example(`hello-world`)
	})
	Attribute("environment", ArrayOf(String), func() {
		Description("Environment variables list")
	})
	Attribute("replicas", Integer, func() {
		Description("Amount of replicas to be deployed. (1 by default)")
	})
	Attribute("args", ArrayOf(String), func() {
		Description("Arguments to be passed to the container")
	})
	Attribute("tty", Boolean, func() {
		Description("Interactive shell requirement")
		Example(true)
	})
	Attribute("alias", String, func() {
		Description("Service alias, this will identify the Service")
		Example(`ALIAS`)
	})
	Attribute("fileid", String, func() {
		Description("ID of the Zipped contents that will be mounted and accesible inside the container, PREVIOUSLY UPLOADED")
	})
	Required("image", "alias")
})

var ServiceResponse = MediaType("application/atq.service+json", func() {
	Description("Created Relevant Service Information")
	Attributes(func() {
		Attribute("id", String, "Docker Service internal identifier")
		Attribute("fileId", String, "ATQ FileID if exists")
		Attribute("image", String, "Docker Image Name")
		Attribute("alias", String, "ATQ Service internal alias")
		Attribute("replicas", Integer, "Amount of Replicas")
		Attribute("tty", Boolean, "Interactive Shell")
		Attribute("args", ArrayOf(String), "Arguments passed to the containers")
	})

	View("default", func() {
		Attribute("id")
		Attribute("alias")
		Attribute("fileId")
	})

	View("minimal", func() {
		Attribute("id")
	})

	View("full", func() {
		Attribute("id")
		Attribute("fileId")
		Attribute("image")
		Attribute("alias")
		Attribute("replicas")
		Attribute("tty")
		Attribute("args")
	})
})

var Swarm = MediaType("application/atq.swarm+json", func() {
	Description("Swarm Details")
	Attributes(func() {
		Attribute("error", String, "Swarm Error Message")
		Attribute("joinTokens", JoinTokens)
	})
	View("default", func() {
		Attribute("joinTokens")
	})
	View("error", func() {
		Attribute("error")
	})
})

var Task = MediaType("application/atq.task+json", func() {
	Description("Task description")
	Attributes(func() {
		Attribute("id", String, "Task ID")
		Attribute("status", func() {
			Enum("initializing", "started", "stopped", "finished", "errored")
			Description("Status of the Task")
		})

		Attribute("master", ServiceResponse, "Master Service definition")
		Attribute("worker", ServiceResponse, "Worker Service definition")
		Attribute("waitCommand", WaitCommand)
		Attribute("delay", Integer, "Manual delay between starting Master and Worker services")
	})
	View("default", func() {
		Attribute("id")
		Attribute("status")
	})
	View("full", func() {
		Attribute("id")
		Attribute("status")
		Attribute("master")
		Attribute("worker")
		Attribute("waitCommand")
		Attribute("delay")
	})
})

var TaskPayload = Type("TaskPayload", func() {
	Attribute("name", String, func() {
		Description("Task Name Identifier")
		MinLength(3)
	})
	Attribute("master", ServicePayload)
	Attribute("worker", ServicePayload)
	Attribute("waitCommand", WaitCommand)
	Attribute("delay", Integer, func() {
		Minimum(0)
	})
	Required("name", "worker", "master")
})

var Upload = MediaType("application/atq.databind.upload+json", func() {
	Description("User upload files response")
	Attributes(func() {
		Attribute("id", String, "Upload ID")
		Attribute("error", String, "Error message if errored")
	})
	View("default", func() {
		Attribute("id")
	})
	View("error", func() {
		Attribute("error")
	})
})

var WaitCommand = Type("WaitCommand", func() {
	Description("Definition of a command to be executed")
	Attribute("command", String, "Command to be executed")
	Attribute("expectedResult", String, "Result expected")
	Attribute("timeout", Integer, "Maximum seconds to wait until succesfull response")
})