The profile "type" configuration document. Provides all configuration information for the "type". A profile "type" is an arbitrary (implementation defined) category used to isolate configuration documents, provide ease of configuration for complex CLIs (user only configures what they'll use), and allows the CLI to be extendable in an isolated fashion. See the "IProfile" for more detailed profile info.

export
interface

  IProfileTypeConfiguration

### Hierarchy

- IProfileTypeConfiguration
  - ICommandProfileTypeConfiguration

## Index

### Properties

- dependencies
- schema
- type
- validationPlanModule

## Properties

### Optional dependencies

dependencies: IProfileDependency[]

- Defined in @zowe/imperative/src/profiles/src/doc/config/IProfileTypeConfiguration.ts:51

The profile dependency specification. Indicates the required or optional profiles that a profile is depedent on. Dependencies are written as part of the profile, but you do NOT need to specify dependencies in your schema document - this is automatically generated based on your specifications.

memberof

  IProfileTypeConfiguration

deprecated

  Only applies to V1 profiles. For team config, use nested profiles instead.

### schema

schema: IProfileSchema

- Defined in @zowe/imperative/src/profiles/src/doc/config/IProfileTypeConfiguration.ts:41

The JSON schema document. The schema document provides a way to enforce the contents of a profile. The schema conforms exactly to the JSON schema specification. You must supply all properties you would like validated for correctness on the schema, except for "dependencies". Dependency schema checking is generated automatically if you populate the dependencies property of this document.

memberof

  IProfileTypeConfiguration

### type

type: string

- Defined in @zowe/imperative/src/profiles/src/doc/config/IProfileTypeConfiguration.ts:31

The name of the profile "type" (e.g. "banana"). The type should be indicative of the profile contents (defined by the profile schema on this document). A "type" is analogous to a category.

memberof

  IProfileTypeConfiguration

### Optional validationPlanModule

validationPlanModule: string

- Defined in @zowe/imperative/src/profiles/src/doc/config/IProfileTypeConfiguration.ts:61

Path to a module that contains an object that matches the interface IProfileValidationPlan. This is optional, but if provided a "validate profile" command will be generated to give the user a report on the validity of their profile.

memberof

  IProfileTypeConfiguration

deprecated

  Only applies to V1 profiles. For team config, validate with JSON schema instead.

Generated using TypeDoc