io.continual.flowcontrol.svcapi.flowControlRoutes.conf Maven / Gradle / Ivy

Go to download
package io.continual.flowcontrol.endpoints

#######################################################################################################################

#
#	Get the jobs known to this service, filtered to the user's visibility.
#
GET		/jobs			FlowControlRoutes.getJobs

#
#	Get details on a particular job from this service.
#
GET		/jobs/{id}		FlowControlRoutes.getJob

#
#	Create a new job.
#
#	id is mandatory, everything else is optional (for job creation). Secrets
#	are references to externally provided secrets (if they exist). Alternatively
#	they're managed separately as key/values.
#
#	{
#		"id": 
#		"runtime": { "name": , "version":  },
#		"config": { "type": "application/json", "data":  },
#		"secrets": { "key":"value", "key2":"value2" }
#	}
#
POST	/jobs			FlowControlRoutes.createJob

#
#	Update a job. The runtime and config objects are overwritten if provided. The secrets object is updated.
#
#	{  }
#
PATCH	/jobs/{id}		FlowControlRoutes.patchJob

#
#	Add (or update) a secret.
#
#	{ "value":  }
#
PUT		/jobs/{id}/secrets/{secretId}		FlowControlRoutes.putSecret

#
#	Remove a secret
#
DELETE	/jobs/{id}/secrets/{secretId}		FlowControlRoutes.deleteSecret

#
#	delete a job
#
DELETE	/jobs/{id}		FlowControlRoutes.deleteJob

#######################################################################################################################

#
#	Deployments
#
#	{
#		job: 
#		instanceCount: 
#		env: {  }
#	}
#
POST	/deploys	FlowControlRoutes.createDeployment

#
#	Get deployments owned by the current user.
#
#	Limit to a specific job:  job=
#
GET		/deploys	FlowControlRoutes.getDeployments

#
#	Get a specific deployment by ID
#
GET		/deploys/{deployId}		FlowControlRoutes.getDeployment

#
#	Get the log from a deployment worker instance
#
GET		/deploys/{deployId}/log/{instanceId}	FlowControlRoutes.getLogs

#
#	tear down a deployment
#
DELETE	/deploys/{deployId}		FlowControlRoutes.undeploy