Skip to content

Latest commit

 

History

History
243 lines (159 loc) · 8.03 KB

PipelineTemplatesControllerApi.md

File metadata and controls

243 lines (159 loc) · 8.03 KB
Raw

\PipelineTemplatesControllerApi

All URIs are relative to https://localhost

Method HTTP request Description
CreateUsingPOST Post /pipelineTemplates Create a pipeline template.
DeleteUsingDELETE Delete /pipelineTemplates/{id} Delete a pipeline template.
GetUsingGET Get /pipelineTemplates/{id} Get a pipeline template.
ListPipelineTemplateDependentsUsingGET Get /pipelineTemplates/{id}/dependents List all pipelines that implement a pipeline template
ListUsingGET Get /pipelineTemplates List pipeline templates.
ResolveTemplatesUsingGET Get /pipelineTemplates/resolve Resolve a pipeline template.
UpdateUsingPOST Post /pipelineTemplates/{id} Update a pipeline template.

CreateUsingPOST

CreateUsingPOST(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]

DeleteUsingDELETE

map[string]interface{} DeleteUsingDELETE(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]

GetUsingGET

map[string]interface{} GetUsingGET(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]

ListPipelineTemplateDependentsUsingGET

[]interface{} ListPipelineTemplateDependentsUsingGET(ctx, id, optional) 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
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
recursive bool recursive

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]

ListUsingGET

[]interface{} ListUsingGET(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]

ResolveTemplatesUsingGET

map[string]interface{} ResolveTemplatesUsingGET(ctx, source, optional) Resolve a pipeline template.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
source string source
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
source string source
executionId string executionId
pipelineConfigId string pipelineConfigId

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]

UpdateUsingPOST

UpdateUsingPOST(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]