Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 3.79 KB

PipelineRefreshApi.md

File metadata and controls

76 lines (57 loc) · 3.79 KB
Raw

harness_python_sdk.PipelineRefreshApi

All URIs are relative to https://app.harness.io

Method HTTP request Description
validate_template_inputs GET /pipeline/api/refresh-template/validate-template-inputs Validates template inputs in a pipeline's YAML specification.

validate_template_inputs

ResponseDTOValidateTemplateInputsResponseDTO validate_template_inputs(account_identifier, org_identifier=org_identifier, project_identifier=project_identifier, identifier=identifier, load_from_cache=load_from_cache, branch=branch, repo_identifier=repo_identifier, get_default_from_other_repo=get_default_from_other_repo)

Validates template inputs in a pipeline's YAML specification.

Validates the template inputs in a pipeline's YAML specification. If the template inputs are invalid, the operation returns an error summary.

Example

from __future__ import print_function
import time
import harness_python_sdk
from harness_python_sdk.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = harness_python_sdk.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = harness_python_sdk.PipelineRefreshApi(harness_python_sdk.ApiClient(configuration))
account_identifier = 'account_identifier_example' # str | Account Identifier for the Entity.
org_identifier = 'org_identifier_example' # str | Organization Identifier for the Entity. (optional)
project_identifier = 'project_identifier_example' # str | Project Identifier for the Entity. (optional)
identifier = 'identifier_example' # str |  (optional)
load_from_cache = 'false' # str |  (optional) (default to false)
branch = 'branch_example' # str | Name of the branch. (optional)
repo_identifier = 'repo_identifier_example' # str | Git Sync Config Id. (optional)
get_default_from_other_repo = true # bool | if true, return all the default entities (optional)

try:
    # Validates template inputs in a pipeline's YAML specification.
    api_response = api_instance.validate_template_inputs(account_identifier, org_identifier=org_identifier, project_identifier=project_identifier, identifier=identifier, load_from_cache=load_from_cache, branch=branch, repo_identifier=repo_identifier, get_default_from_other_repo=get_default_from_other_repo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PipelineRefreshApi->validate_template_inputs: %s\n" % e)

Parameters

Name Type Description Notes
account_identifier str Account Identifier for the Entity.
org_identifier str Organization Identifier for the Entity. [optional]
project_identifier str Project Identifier for the Entity. [optional]
identifier str [optional]
load_from_cache str [optional] [default to false]
branch str Name of the branch. [optional]
repo_identifier str Git Sync Config Id. [optional]
get_default_from_other_repo bool if true, return all the default entities [optional]

Return type

ResponseDTOValidateTemplateInputsResponseDTO

Authorization

x-api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml

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