Skip to content

Latest commit

 

History

History
224 lines (144 loc) · 7.34 KB

V2PipelineTemplatesControllerApi.md

File metadata and controls

224 lines (144 loc) · 7.34 KB
Raw

\V2PipelineTemplatesControllerApi

All URIs are relative to https://localhost

Method HTTP request Description
CreateUsingPOST1 Post /v2/pipelineTemplates Create a pipeline template.
DeleteUsingDELETE1 Delete /v2/pipelineTemplates/{id} Delete a pipeline template.
GetUsingGET1 Get /v2/pipelineTemplates/{id} Get a pipeline template.
ListPipelineTemplateDependentsUsingGET1 Get /v2/pipelineTemplates/{id}/dependents List all pipelines that implement a pipeline template
ListUsingGET1 Get /v2/pipelineTemplates List pipeline templates.
PlanUsingPOST Post /v2/pipelineTemplates/plan Plan a pipeline template configuration.
UpdateUsingPOST1 Post /v2/pipelineTemplates/{id} Update a pipeline template.

CreateUsingPOST1

CreateUsingPOST1(ctx, pipelineTemplate) Create a pipeline template.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
pipelineTemplate interface{} pipelineTemplate

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteUsingDELETE1

map[string]interface{} DeleteUsingDELETE1(ctx, id, optional) Delete a pipeline template.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string id
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
id string id
application string application

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUsingGET1

map[string]interface{} GetUsingGET1(ctx, id) Get a pipeline template.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string id

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListPipelineTemplateDependentsUsingGET1

[]interface{} ListPipelineTemplateDependentsUsingGET1(ctx, id) List all pipelines that implement a pipeline template

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string id

Return type

[]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListUsingGET1

[]interface{} ListUsingGET1(ctx, optional) List pipeline templates.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
scopes []string scopes

Return type

[]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PlanUsingPOST

map[string]interface{} PlanUsingPOST(ctx, pipeline) Plan a pipeline template configuration.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
pipeline interface{} pipeline

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateUsingPOST1

UpdateUsingPOST1(ctx, id, pipelineTemplate, optional) Update a pipeline template.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string id
pipelineTemplate interface{} pipelineTemplate
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
id string id
pipelineTemplate interface{} pipelineTemplate
skipPlanDependents bool skipPlanDependents [default to false]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]