root.description object

Describes your app to users. For apps submitted to AppSource, these values must match the information in your AppSource entry.

Properties that reference this object type:

• root.description

Syntax

Syntax

{
  "short": "{string}",
  "full": "{string}"
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "short": {
      "type": "string",
      "description": "A short description of the app used when space is limited. Maximum length is 80 characters.",
      "maxLength": 80
    },
    "full": {
      "type": "string",
      "description": "The full description of the app. Maximum length is 4000 characters.",
      "maxLength": 4000
    }
  },
  "required": [
    "short",
    "full"
  ]
}

Properties

short

A short description of the app, used when space is limited.

Type
string

Required
✅

Constraints
Maximum string length: 80.

Supported values

full

The full description of the app.

Type
string

Required
✅

Constraints
Maximum string length: 4000.

Supported values

Remarks

Ensure that your description accurately describes your experience and provides information to help potential customers understand what your experience does. You must note in the full description, if an external account is required for use. The values of short and full must be different. Your short description must not be repeated within the long description and must not include any other app name.

Examples

{
    "description": {
        "short": "Short description of your app",
        "full": "Full description of your app"
    }
}