The JSON Validation schema for your profile type. Use this to describe the expected structure and contents of your profile, as well as provide option definitions for create & update profile commands

### 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

## Index

### Properties

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

## Properties

### description

description: string

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

A description of your type of profile

### properties

properties: {}

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

These are the properties of your profile object. If your profile deals with information about bananas, some properties might be "color", "sweetness", and "origin" of type "string". For each one, you can provide an Imperative option definition (The same format as your normal command option definitions) which will be used for auto-generating profile commands.

#### Type declaration

- ##### [key: string]: IProfileProperty

  General mapping of property name to an IProfileProperty object.

### Optional required

required: string[]

- 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

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

A short, descriptive title of your profile type

### type

type: string

- 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

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

Generated using TypeDoc