vss-extension.json

Azure DevOps Extensions

Type object
File match vss-extension.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/vss-extension-json/latest.json
Source https://www.schemastore.org/vss-extension.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

manifestVersion integer required

This should be 1.

Default: 1
Values: 1
id string required

This is a string that must be unique among extensions from the same publisher.

All of: id_pattern
version string required

Should be in the format major.minor.patch, for example 0.1.2 or 1.0.0. You can also add a fourth number for the following format: 0.1.2.3

Examples: "1.0.0", "1.0.0.0"
pattern=^\d+\.\d+\.\d+(\.\d+)?$
name string required
Examples: "Azure DevOps Extension Tasks", "Fabrikam Agile Board Extension"
maxLength=200
publisher string required

This identifier must match the identifier the extension is published under.

pattern=^[a-zA-Z0-9][a-zA-Z0-9-]+$
categories string[] required

At least one category must be provided and there is no limit to how many categories you may include.

uniqueItems=true
targets object[] required
scopes string[]

An array of authorization scopes (strings) listing permissions required by your extension.

demands string[]

An array of demands (strings) listing the capabilities required by your extension.

baseUri string

(Optional) base URL for all relative URLs specified by the extension's contributions.

format=uri
description string
maxLength=200
icons object

Dictionary of icons representing the extension.

1 nested properties
default string required

The value must be the path to the icon file in the extension

format=uri-reference
tags string[]

Array of string tags to help users find your extension.

minItems=1
galleryFlags string[]

Array of string tags to classify your extension within the Visual Studio Marketplace

minItems=1
screenshots object[]

Array of images that could not be included in your *content.

content object
3 nested properties
details required

GitHub Flavored Markdown file which describes the details of the Extension

All of: content_definition object
license

GitHub Flavored Markdown file which describes the license information of the Extension

All of: content_definition object
pricing

GitHub Flavored Markdown file which describes the pricing information of the Extension

All of: content_definition object
repository object
2 nested properties
type string required
Values: "git" "mercurial" "svn" "cvs"
uri string required
format=uri
badges object[]

Array of links to external metadata badges like TravisCI, Appveyor etc from the approved badges sites.

branding object

Dictionary of brand-related properties.

2 nested properties
color string required

Primary color of the extension or publisher; can be a hex (#ff00ff), RGB (rgb(100,200,50)), or supported HTML color names (blue).

theme string

Complements the color; use dark for dark branding colors, or light for lighter branding colors.

Values: "light" "dark"
public boolean

Set to true to make this extension public in the Visual Studio Market Place

Default: false
files object[]
contributions array
contributionTypes array

Definitions

id_pattern
demand_pattern
content_definition object
path string required
format=uri-reference
contribution_definition object

A contribution that is part of this extension

id string required

A reference ID (string) for the contribution. Each contribution's ID must be unique within an extension.

type string required

The ID of the contributionType of this contribution.

targets string[] required

An array of contribution IDs that the contribution is targeting (contributing to).

description string

(Optional) A string describing what the contribution is providing.

restrictedTo string[]

Valid Values: https://docs.microsoft.com/en-us/azure/devops/extend/develop/public-project?view=azure-devops#contribution-visibility

properties object

(Optional) An object that includes properties for the contribution as defined in the contribution type.

contributionType_definition object

A contribution Type that is part of this extension

id string required

A reference ID (string) for the contribution type. Each contribution type's ID must be unique within an extension.

name string required

The friendly name of the contribution type.

description string

(Optional) A string describing in more detail what the contribution type is for.

properties object[]

(Optional) A dictionary that maps property names to property descriptions. These properties describe the required and optional properties that can be used by contributions of this type.