YouTrack App

JetBrains YouTrack App manifest file

Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/youtrack-app/latest.json
Source https://www.schemastore.org/youtrack-app.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Schema for the JetBrains YouTrack app manifest file

Properties

name string required

The name of the app. This is used as a unique identifier in YouTrack.

pattern=^[a-z0-9-_.~]+$
$schema string

The URL for the JSON schema that defines the structure of the manifest file.

aiToolPrefix string

The prefix for AI tool names in the app. The prefix is intended to separate the custom tools from the YouTrack predefined tools and avoid name collisions with other apps. If not set, the app name will be used as a prefix.

pattern=^[A-Za-z0-9._-]+$
title string

The title of the app. This is a user-friendly name that is shown in the JetBrains Marketplace and the YouTrack UI.

description string

The description of the app. You can see this description in the app details on the Apps administration page.

version string
minLength=5maxLength=14pattern=^(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)$
vendor object

An object that contains the description of the app vendor.

3 nested properties
name string required
url string
format=urlminLength=1maxLength=255
email string
format=email
icon string
pattern=.*\.(svg|png|jpg|jpeg|ico)$
iconDark string
pattern=.*\.(svg|png|jpg|jpeg|ico)$
minYouTrackVersion string
minLength=5maxLength=14pattern=^(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)$
maxYouTrackVersion string
minLength=5maxLength=14pattern=^(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)$
changeNotes string

A description of changes available in a specific version of the app. This information is only displayed in the JetBrains Marketplace.

url string
format=urlminLength=1maxLength=255
visual boolean
widgets object[]

An array of widget objects included in the app. Each widget represents a frontend extension.

minItems=1

Definitions

semver string
url string
expectedDimensions object

The expected dimensions of the widget in pixels. YouTrack will try to display the widget according to these dimensions if the monitor settings allow.

width integer
height integer
defaultDimensions object

The default width and height of the widget.

settingsSchemaPath string

The path to the JSON file that stores the settings scheme for Markdown and dashboard widgets.

icon string
pixelOrPercentValue string
fractionValue string
permissions string
extensionPoints string