Externally exposed version of the profile schema with command options for auto-generated commands

export
interface

  ICommandProfileSchema

### Hierarchy

- IProfileSchema
  - ICommandProfileSchema

### Indexable

[key: string]: any

Any other advanced options available from the JSON schema specification http://json-schema.org/latest/json-schema-validation.html

export
interface

  ICommandProfileSchema

## Index

### Properties

- description
- properties
- required
- title
- type
- version

## Properties

### description

description: string

Inherited from IProfileSchema.description

- Defined in @zowe/imperative/src/profiles/src/doc/definition/IProfileSchema.ts:27

A description of your type of profile

### properties

properties: {}

Overrides IProfileSchema.properties

- Defined in @zowe/imperative/src/cmd/src/doc/profiles/definition/ICommandProfileSchema.ts:24

Command version of the properties field on the schema

#### Type declaration

- ##### [key: string]: ICommandProfileProperty

  General mapping of property name to an ICommandProfileProperty object. ICommandProfileProperty is the same as IProfileProperty except that it can contain option definitions for auto-generated commands

### Optional required

required: string[]

Inherited from IProfileSchema.required

- Defined in @zowe/imperative/src/profiles/src/doc/definition/IProfileSchema.ts:55

An array of properties that must be present in the finished profile. If any of these fields are missing, profile validation will fail.

### title

title: string

Inherited from IProfileSchema.title

- Defined in @zowe/imperative/src/profiles/src/doc/definition/IProfileSchema.ts:23

A short, descriptive title of your profile type

### type

type: string

Inherited from IProfileSchema.type

- Defined in @zowe/imperative/src/profiles/src/doc/definition/IProfileSchema.ts:33

Specify "object". This is not the type name of the profile, but rather a description of the type of data structure (e.g. string, array). Your profile will be an object with one or more properties.

### Optional version

version: string

Inherited from IProfileSchema.version

- Defined in @zowe/imperative/src/profiles/src/doc/definition/IProfileSchema.ts:49

Generated using TypeDoc