6.6. Document

Documents are defined as being loadable from a file. The document type is the basis for the pipeline, operator, service, and template types. Therefore these types have all of the properties as the document type.

6.6.1. Properties

6.6.1.1. api-version

type: string

Semantic version formatted value intended to specify which version of Clara Deploy SDK the document was intended for.

See https://semver.org for more detals.

6.6.1.2. description

type: string

Human friendly description of the document and its intended uses.

6.6.1.3. name

type: string

Human friendly name for the document. Intended for use when information related to the document is displayed. For example, when pipeline job information is displayed.

See names for additional information about name in Clara Deploy SDK pipeline definitions.