Package cn.sliew.carp.module.application.vela.api.v1

Interface ApplicationApi

public interface ApplicationApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<V1EmptyResponse>	addApplicationTrait(String appName, String compName, V1CreateApplicationTraitRequest body)
org.springframework.http.ResponseEntity<V1ApplicationStatisticsResponse>	applicationStatistics(String appName)
org.springframework.http.ResponseEntity<V1AppCompareResponse>	compareApp(V1AppCompareReq body, String appName)
org.springframework.http.ResponseEntity<V1ApplicationBase>	createApplication(V1CreateApplicationRequest body)
org.springframework.http.ResponseEntity<V1EnvBinding>	createApplicationEnv(String appName, V1CreateApplicationEnvbindingRequest body)
org.springframework.http.ResponseEntity<V1PolicyBase>	createApplicationPolicy(String appName, V1CreatePolicyRequest body)
org.springframework.http.ResponseEntity<V1ApplicationTriggerBase>	createApplicationTrigger(String appName, V1CreateApplicationTriggerRequest body)
org.springframework.http.ResponseEntity<V1ComponentBase>	createComponent(String appName, V1CreateComponentRequest body)
org.springframework.http.ResponseEntity<V1DetailWorkflowResponse>	createOrUpdateApplicationWorkflow(V1CreateWorkflowRequest body, String appName)
org.springframework.http.ResponseEntity<V1EmptyResponse>	deleteApplication(String appName)
org.springframework.http.ResponseEntity<V1EmptyResponse>	deleteApplicationEnv(String appName, String envName)
org.springframework.http.ResponseEntity<V1EmptyResponse>	deleteApplicationPolicy(String appName, String policyName, Boolean force)
org.springframework.http.ResponseEntity<V1ApplicationTrait>	deleteApplicationTrait(String appName, String compName, String traitType)
org.springframework.http.ResponseEntity<V1EmptyResponse>	deleteApplicationTrigger(String appName, String token)
org.springframework.http.ResponseEntity<V1EmptyResponse>	deleteComponent(String appName, String compName)
org.springframework.http.ResponseEntity<V1SimpleResponse>	deleteWorkflow(String appName, String workflowName)
org.springframework.http.ResponseEntity<V1ApplicationDeployResponse>	deployApplication(String appName, V1ApplicationDeployRequest body)
org.springframework.http.ResponseEntity<V1DetailApplicationResponse>	detailApplication(String appName)
org.springframework.http.ResponseEntity<V1DetailPolicyResponse>	detailApplicationPolicy(String appName, String policyName)
org.springframework.http.ResponseEntity<V1DetailRevisionResponse>	detailApplicationRevision(String appName, String revision)
org.springframework.http.ResponseEntity<V1DetailComponentResponse>	detailComponent(String appName, String compName)
org.springframework.http.ResponseEntity<V1DetailWorkflowResponse>	detailWorkflow(String appName, String workflowName)
org.springframework.http.ResponseEntity<V1DetailWorkflowRecordResponse>	detailWorkflowRecord(String appName, String workflowName, String record)
org.springframework.http.ResponseEntity<V1AppDryRunResponse>	dryRunAppOrRevision(V1AppDryRunReq body, String appName)
org.springframework.http.ResponseEntity<V1ApplicationStatusResponse>	getApplicationStatus(String appName, String envName)
org.springframework.http.ResponseEntity<V1ApplicationStatusListResponse>	getApplicationStatusFromAllEnvs(String appName)
org.springframework.http.ResponseEntity<V1GetPipelineRunInputResponse>	getWorkflowRecordInputs(String appName, String workflowName, String record, String step)
org.springframework.http.ResponseEntity<Void>	getWorkflowRecordLogs(String appName, String workflowName, String record, String step)
org.springframework.http.ResponseEntity<V1GetPipelineRunOutputResponse>	getWorkflowRecordOutputs(String appName, String workflowName, String record, String step)
org.springframework.http.ResponseEntity<V1ComponentListResponse>	listApplicationComponents(String appName, String envName)
org.springframework.http.ResponseEntity<V1ListApplicationEnvBinding>	listApplicationEnvs(String appName)
org.springframework.http.ResponseEntity<V1ListApplicationPolicy>	listApplicationPolicies(String appName)
org.springframework.http.ResponseEntity<Void>	listApplicationRecords(String appName)
org.springframework.http.ResponseEntity<V1ListRevisionsResponse>	listApplicationRevisions(String appName, String envName, String status, Integer page, Integer pageSize)
org.springframework.http.ResponseEntity<V1ListApplicationResponse>	listApplications(String query, String project, String env, String targetName)
org.springframework.http.ResponseEntity<V1ListApplicationTriggerResponse>	listApplicationTriggers(String appName)
org.springframework.http.ResponseEntity<V1ListWorkflowResponse>	listApplicationWorkflows(String appName)
org.springframework.http.ResponseEntity<V1ListWorkflowRecordsResponse>	listWorkflowRecords(String appName, String workflowName, Integer page, Integer pageSize)
org.springframework.http.ResponseEntity<V1ListWorkflowRecordsResponse>	listWorkflowRecordsFromEnv(String appName, String envName, Integer page, Integer pageSize)
org.springframework.http.ResponseEntity<V1ApplicationTemplateBase>	publishApplicationTemplate(String appName, V1CreateApplicationTemplateRequest body)
org.springframework.http.ResponseEntity<V1EmptyResponse>	recycleApplicationEnv(String appName, String envName)
org.springframework.http.ResponseEntity<V1AppResetResponse>	resetAppToLatestRevision(String appName)
org.springframework.http.ResponseEntity<V1EmptyResponse>	resumeWorkflowRecord(String appName, String workflowName, String record, String step)
org.springframework.http.ResponseEntity<V1ApplicationRollbackResponse>	rollbackApplicationWithRevision(String appName, String revision)
org.springframework.http.ResponseEntity<V1WorkflowRecordBase>	rollbackWorkflowRecord(String appName, String workflowName, String record, String rollbackVersion)
org.springframework.http.ResponseEntity<V1EmptyResponse>	terminateWorkflowRecord(String appName, String workflowName, String record)
org.springframework.http.ResponseEntity<V1ApplicationBase>	updateApplication(String appName, V1UpdateApplicationRequest body)
org.springframework.http.ResponseEntity<V1EnvBinding>	updateApplicationEnv(String appName, String envName, V1PutApplicationEnvBindingRequest body)
org.springframework.http.ResponseEntity<V1DetailPolicyResponse>	updateApplicationPolicy(String appName, String policyName, V1UpdatePolicyRequest body)
org.springframework.http.ResponseEntity<V1ApplicationTrait>	updateApplicationTrait(String appName, String compName, String traitType, V1UpdateApplicationTraitRequest body)
org.springframework.http.ResponseEntity<V1ApplicationTriggerBase>	updateApplicationTrigger(String appName, String token)
org.springframework.http.ResponseEntity<V1ComponentBase>	updateComponent(String appName, String compName, V1UpdateApplicationComponentRequest body)
org.springframework.http.ResponseEntity<V1DetailWorkflowResponse>	updateWorkflow(String appName, String workflowName, V1UpdateWorkflowRequest body)

Method Details

listApplications

@GetMapping("/api/v1/applications")
org.springframework.http.ResponseEntity<V1ListApplicationResponse> listApplications(@RequestParam(value="query",required=false)
 String query,
 @RequestParam(value="project",required=false)
 String project,
 @RequestParam(value="env",required=false)
 String env,
 @RequestParam(value="targetName",required=false)
 String targetName)

detailApplication

@GetMapping("/api/v1/applications/{appName}")
org.springframework.http.ResponseEntity<V1DetailApplicationResponse> detailApplication(@PathVariable("appName")
 String appName)

listApplicationRevisions

@GetMapping("/api/v1/applications/{appName}/revisions")
org.springframework.http.ResponseEntity<V1ListRevisionsResponse> listApplicationRevisions(@PathVariable("appName")
 String appName,
 @RequestParam(value="envName",required=false)
 String envName,
 @RequestParam(value="status",required=false)
 String status,
 @RequestParam(value="page",required=false)
 Integer page,
 @RequestParam(value="pageSize",required=false)
 Integer pageSize)

detailApplicationRevision

@GetMapping("/api/v1/applications/{appName}/revisions/{revision}")
org.springframework.http.ResponseEntity<V1DetailRevisionResponse> detailApplicationRevision(@PathVariable("appName")
 String appName,
 @PathVariable("revision")
 String revision)

rollbackApplicationWithRevision

@PostMapping("/api/v1/applications/{appName}/revisions/{revision}/rollback")
org.springframework.http.ResponseEntity<V1ApplicationRollbackResponse> rollbackApplicationWithRevision(@PathVariable("appName")
 String appName,
 @PathVariable("revision")
 String revision)

resetAppToLatestRevision

@PostMapping("/api/v1/applications/{appName}/reset")
org.springframework.http.ResponseEntity<V1AppResetResponse> resetAppToLatestRevision(@PathVariable("appName")
 String appName)

compareApp

@PostMapping("/api/v1/applications/{appName}/compare")
org.springframework.http.ResponseEntity<V1AppCompareResponse> compareApp(@RequestBody
 V1AppCompareReq body,
 @PathVariable("appName")
 String appName)

createApplication

@PostMapping("/api/v1/applications")
org.springframework.http.ResponseEntity<V1ApplicationBase> createApplication(@RequestBody
 V1CreateApplicationRequest body)

updateApplication

@PutMapping("/api/v1/applications/{appName}")
org.springframework.http.ResponseEntity<V1ApplicationBase> updateApplication(@PathVariable("appName")
 String appName,
 @RequestBody
 V1UpdateApplicationRequest body)

deleteApplication

@DeleteMapping("/api/v1/applications/{appName}")
org.springframework.http.ResponseEntity<V1EmptyResponse> deleteApplication(@PathVariable("appName")
 String appName)

dryRunAppOrRevision

@PostMapping("/api/v1/applications/{appName}/dry-run")
org.springframework.http.ResponseEntity<V1AppDryRunResponse> dryRunAppOrRevision(@RequestBody
 V1AppDryRunReq body,
 @PathVariable("appName")
 String appName)

deployApplication

@PostMapping("/api/v1/applications/{appName}/deploy")
org.springframework.http.ResponseEntity<V1ApplicationDeployResponse> deployApplication(@PathVariable("appName")
 String appName,
 @RequestBody
 V1ApplicationDeployRequest body)

getApplicationStatusFromAllEnvs

@GetMapping("/api/v1/applications/{appName}/status")
org.springframework.http.ResponseEntity<V1ApplicationStatusListResponse> getApplicationStatusFromAllEnvs(@PathVariable("appName")
 String appName)

getApplicationStatus

@GetMapping("/api/v1/applications/{appName}/envs/{envName}/status")
org.springframework.http.ResponseEntity<V1ApplicationStatusResponse> getApplicationStatus(@PathVariable("appName")
 String appName,
 @PathVariable("envName")
 String envName)

listApplicationRecords

@GetMapping("/api/v1/applications/{appName}/records")
org.springframework.http.ResponseEntity<Void> listApplicationRecords(@PathVariable("appName")
 String appName)

applicationStatistics

@GetMapping("/api/v1/applications/{appName}/statistics")
org.springframework.http.ResponseEntity<V1ApplicationStatisticsResponse> applicationStatistics(@PathVariable("appName")
 String appName)

publishApplicationTemplate

@PostMapping("/api/v1/applications/{appName}/template")
org.springframework.http.ResponseEntity<V1ApplicationTemplateBase> publishApplicationTemplate(@PathVariable("appName")
 String appName,
 @RequestBody
 V1CreateApplicationTemplateRequest body)

listApplicationEnvs

@GetMapping("/api/v1/applications/{appName}/envs")
org.springframework.http.ResponseEntity<V1ListApplicationEnvBinding> listApplicationEnvs(@PathVariable("appName")
 String appName)

createApplicationEnv

@PostMapping("/api/v1/applications/{appName}/envs")
org.springframework.http.ResponseEntity<V1EnvBinding> createApplicationEnv(@PathVariable("appName")
 String appName,
 @RequestBody
 V1CreateApplicationEnvbindingRequest body)

updateApplicationEnv

@PutMapping("/api/v1/applications/{appName}/envs/{envName}")
org.springframework.http.ResponseEntity<V1EnvBinding> updateApplicationEnv(@PathVariable("appName")
 String appName,
 @PathVariable("envName")
 String envName,
 @RequestBody
 V1PutApplicationEnvBindingRequest body)

deleteApplicationEnv

@DeleteMapping("/api/v1/applications/{appName}/envs/{envName}")
org.springframework.http.ResponseEntity<V1EmptyResponse> deleteApplicationEnv(@PathVariable("appName")
 String appName,
 @PathVariable("envName")
 String envName)

recycleApplicationEnv

@PostMapping("/api/v1/applications/{appName}/envs/{envName}/recycle")
org.springframework.http.ResponseEntity<V1EmptyResponse> recycleApplicationEnv(@PathVariable("appName")
 String appName,
 @PathVariable("envName")
 String envName)

addApplicationTrait

@PostMapping("/api/v1/applications/{appName}/components/{compName}/traits")
org.springframework.http.ResponseEntity<V1EmptyResponse> addApplicationTrait(@PathVariable("appName")
 String appName,
 @PathVariable("compName")
 String compName,
 @RequestBody
 V1CreateApplicationTraitRequest body)

updateApplicationTrait

@PutMapping("/api/v1/applications/{appName}/components/{compName}/traits/{traitType}")
org.springframework.http.ResponseEntity<V1ApplicationTrait> updateApplicationTrait(@PathVariable("appName")
 String appName,
 @PathVariable("compName")
 String compName,
 @PathVariable("traitType")
 String traitType,
 @RequestBody
 V1UpdateApplicationTraitRequest body)

deleteApplicationTrait

@DeleteMapping("/api/v1/applications/{appName}/components/{compName}/traits/{traitType}")
org.springframework.http.ResponseEntity<V1ApplicationTrait> deleteApplicationTrait(@PathVariable("appName")
 String appName,
 @PathVariable("compName")
 String compName,
 @PathVariable("traitType")
 String traitType)

listApplicationPolicies

@GetMapping("/api/v1/applications/{appName}/policies")
org.springframework.http.ResponseEntity<V1ListApplicationPolicy> listApplicationPolicies(@PathVariable("appName")
 String appName)

detailApplicationPolicy

@GetMapping("/api/v1/applications/{appName}/policies/{policyName}")
org.springframework.http.ResponseEntity<V1DetailPolicyResponse> detailApplicationPolicy(@PathVariable("appName")
 String appName,
 @PathVariable("policyName")
 String policyName)

createApplicationPolicy

@PostMapping("/api/v1/applications/{appName}/policies")
org.springframework.http.ResponseEntity<V1PolicyBase> createApplicationPolicy(@PathVariable("appName")
 String appName,
 @RequestBody
 V1CreatePolicyRequest body)

updateApplicationPolicy

@PutMapping("/api/v1/applications/{appName}/policies/{policyName}")
org.springframework.http.ResponseEntity<V1DetailPolicyResponse> updateApplicationPolicy(@PathVariable("appName")
 String appName,
 @PathVariable("policyName")
 String policyName,
 @RequestBody
 V1UpdatePolicyRequest body)

deleteApplicationPolicy

@DeleteMapping("/api/v1/applications/{appName}/policies/{policyName}")
org.springframework.http.ResponseEntity<V1EmptyResponse> deleteApplicationPolicy(@PathVariable("appName")
 String appName,
 @PathVariable("policyName")
 String policyName,
 @RequestParam(value="force",required=false)
 Boolean force)

listApplicationTriggers

@GetMapping("/api/v1/applications/{appName}/triggers")
org.springframework.http.ResponseEntity<V1ListApplicationTriggerResponse> listApplicationTriggers(@PathVariable("appName")
 String appName)

createApplicationTrigger

@PostMapping("/api/v1/applications/{appName}/triggers")
org.springframework.http.ResponseEntity<V1ApplicationTriggerBase> createApplicationTrigger(@PathVariable("appName")
 String appName,
 @RequestBody
 V1CreateApplicationTriggerRequest body)

updateApplicationTrigger

@PutMapping("/api/v1/applications/{appName}/triggers/{token}")
org.springframework.http.ResponseEntity<V1ApplicationTriggerBase> updateApplicationTrigger(@PathVariable("appName")
 String appName,
 @PathVariable("token")
 String token)

deleteApplicationTrigger

@DeleteMapping("/api/v1/applications/{appName}/triggers/{token}")
org.springframework.http.ResponseEntity<V1EmptyResponse> deleteApplicationTrigger(@PathVariable("appName")
 String appName,
 @PathVariable("token")
 String token)

listApplicationComponents

@GetMapping("/api/v1/applications/{appName}/components")
org.springframework.http.ResponseEntity<V1ComponentListResponse> listApplicationComponents(@PathVariable("appName")
 String appName,
 @RequestParam(value="envName",required=false)
 String envName)

detailComponent

@GetMapping("/api/v1/applications/{appName}/components/{compName}")
org.springframework.http.ResponseEntity<V1DetailComponentResponse> detailComponent(@PathVariable("appName")
 String appName,
 @PathVariable("compName")
 String compName)

createComponent

@PostMapping("/api/v1/applications/{appName}/components")
org.springframework.http.ResponseEntity<V1ComponentBase> createComponent(@PathVariable("appName")
 String appName,
 @RequestBody
 V1CreateComponentRequest body)

updateComponent

@PutMapping("/api/v1/applications/{appName}/components/{compName}")
org.springframework.http.ResponseEntity<V1ComponentBase> updateComponent(@PathVariable("appName")
 String appName,
 @PathVariable("compName")
 String compName,
 @RequestBody
 V1UpdateApplicationComponentRequest body)

deleteComponent

@DeleteMapping("/api/v1/applications/{appName}/components/{compName}")
org.springframework.http.ResponseEntity<V1EmptyResponse> deleteComponent(@PathVariable("appName")
 String appName,
 @PathVariable("compName")
 String compName)

listApplicationWorkflows

@GetMapping("/api/v1/applications/{appName}/workflows")
org.springframework.http.ResponseEntity<V1ListWorkflowResponse> listApplicationWorkflows(@PathVariable("appName")
 String appName)

detailWorkflow

@GetMapping("/api/v1/applications/{appName}/workflows/{workflowName}")
org.springframework.http.ResponseEntity<V1DetailWorkflowResponse> detailWorkflow(@PathVariable("appName")
 String appName,
 @PathVariable("workflowName")
 String workflowName)

createOrUpdateApplicationWorkflow

@PostMapping("/api/v1/applications/{appName}/workflows")
org.springframework.http.ResponseEntity<V1DetailWorkflowResponse> createOrUpdateApplicationWorkflow(@RequestBody
 V1CreateWorkflowRequest body,
 @PathVariable("appName")
 String appName)

updateWorkflow

@PutMapping("/api/v1/applications/{appName}/workflows/{workflowName}")
org.springframework.http.ResponseEntity<V1DetailWorkflowResponse> updateWorkflow(@PathVariable("appName")
 String appName,
 @PathVariable("workflowName")
 String workflowName,
 @RequestBody
 V1UpdateWorkflowRequest body)

deleteWorkflow

@DeleteMapping("/api/v1/applications/{appName}/workflows/{workflowName}")
org.springframework.http.ResponseEntity<V1SimpleResponse> deleteWorkflow(@PathVariable("appName")
 String appName,
 @PathVariable("workflowName")
 String workflowName)

listWorkflowRecords

@GetMapping("/api/v1/applications/{appName}/workflows/{workflowName}/records")
org.springframework.http.ResponseEntity<V1ListWorkflowRecordsResponse> listWorkflowRecords(@PathVariable("appName")
 String appName,
 @PathVariable("workflowName")
 String workflowName,
 @RequestParam(value="page",required=false)
 Integer page,
 @RequestParam(value="pageSize",required=false)
 Integer pageSize)

listWorkflowRecordsFromEnv

@GetMapping("/api/v1/applications/{appName}/envs/{envName}/records")
org.springframework.http.ResponseEntity<V1ListWorkflowRecordsResponse> listWorkflowRecordsFromEnv(@PathVariable("appName")
 String appName,
 @PathVariable("envName")
 String envName,
 @RequestParam(value="page",required=false)
 Integer page,
 @RequestParam(value="pageSize",required=false)
 Integer pageSize)

detailWorkflowRecord

@GetMapping("/api/v1/applications/{appName}/workflows/{workflowName}/records/{record}")
org.springframework.http.ResponseEntity<V1DetailWorkflowRecordResponse> detailWorkflowRecord(@PathVariable("appName")
 String appName,
 @PathVariable("workflowName")
 String workflowName,
 @PathVariable("record")
 String record)

getWorkflowRecordInputs

@GetMapping("/api/v1/applications/{appName}/workflows/{workflowName}/records/{record}/inputs")
org.springframework.http.ResponseEntity<V1GetPipelineRunInputResponse> getWorkflowRecordInputs(@PathVariable("appName")
 String appName,
 @PathVariable("workflowName")
 String workflowName,
 @PathVariable("record")
 String record,
 @RequestParam(value="step",required=true)
 String step)

getWorkflowRecordOutputs

@GetMapping("/api/v1/applications/{appName}/workflows/{workflowName}/records/{record}/outputs")
org.springframework.http.ResponseEntity<V1GetPipelineRunOutputResponse> getWorkflowRecordOutputs(@PathVariable("appName")
 String appName,
 @PathVariable("workflowName")
 String workflowName,
 @PathVariable("record")
 String record,
 @RequestParam(value="step",required=true)
 String step)

getWorkflowRecordLogs

@GetMapping("/api/v1/applications/{appName}/workflows/{workflowName}/records/{record}/logs")
org.springframework.http.ResponseEntity<Void> getWorkflowRecordLogs(@PathVariable("appName")
 String appName,
 @PathVariable("workflowName")
 String workflowName,
 @PathVariable("record")
 String record,
 @RequestParam(value="step",required=true)
 String step)

resumeWorkflowRecord

@GetMapping("/api/v1/applications/{appName}/workflows/{workflowName}/records/{record}/resume")
org.springframework.http.ResponseEntity<V1EmptyResponse> resumeWorkflowRecord(@PathVariable("appName")
 String appName,
 @PathVariable("workflowName")
 String workflowName,
 @PathVariable("record")
 String record,
 @RequestParam(value="step",required=false)
 String step)

rollbackWorkflowRecord

@GetMapping("/api/v1/applications/{appName}/workflows/{workflowName}/records/{record}/rollback")
org.springframework.http.ResponseEntity<V1WorkflowRecordBase> rollbackWorkflowRecord(@PathVariable("appName")
 String appName,
 @PathVariable("workflowName")
 String workflowName,
 @PathVariable("record")
 String record,
 @RequestParam(value="rollbackVersion",required=false)
 String rollbackVersion)

terminateWorkflowRecord

@GetMapping("/api/v1/applications/{appName}/workflows/{workflowName}/records/{record}/terminate")
org.springframework.http.ResponseEntity<V1EmptyResponse> terminateWorkflowRecord(@PathVariable("appName")
 String appName,
 @PathVariable("workflowName")
 String workflowName,
 @PathVariable("record")
 String record)