Formatter Validator Minifier Escape / Unescape JSON ↔ String JSON ↔ YAML JSON → CSV NDJSON / JSON Lines JSON → Types JSON ↔ XML JSON Diff JSON Patch Canonicalize (RFC 8785) Schema Validator Schema Generator JSONPath Tester JWT Decoder JSON Errors Schemas More Tools
JSONTools / Schema registry / vss-extension.json
Schema registry

vss-extension.json

Azure DevOps Extensions

vss-extension.json
Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your vss-extension.json and it validates in your browser — nothing is uploaded.

Validate a vss-extension.json → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field Type Description
manifestVersionrequiredintegerThis should be 1.
default: 1
one of: 1
idrequiredstringThis is a string that must be unique among extensions from the same publisher.
versionrequiredstringShould 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
namerequiredstring—
publisherrequiredstringThis identifier must match the identifier the extension is published under.
categoriesrequiredarray<string>At least one category must be provided and there is no limit to how many categories you may include.
targetsrequiredarray<object>—
scopesarray<string>An array of authorization scopes (strings) listing permissions required by your extension.
demandsarray<string>An array of demands (strings) listing the capabilities required by your extension.
baseUristring(Optional) base URL for all relative URLs specified by the extension's contributions.
descriptionstring—
iconsobjectDictionary of icons representing the extension.
icons.defaultrequiredstringThe value must be the path to the icon file in the extension
tagsarray<string>Array of string tags to help users find your extension.
galleryFlagsarray<string>Array of string tags to classify your extension within the Visual Studio Marketplace
licensingobjectMore information: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#mark-an-extension-as-paid
gallerypropertiesobjectMore information: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#mark-an-extension-as-paid
screenshotsarray<object>Array of images that could not be included in your **content*.
contentobject—
content.detailsrequiredallOfGitHub Flavored Markdown file which describes the details of the Extension
content.licenseallOfGitHub Flavored Markdown file which describes the license information of the Extension
content.pricingallOfGitHub Flavored Markdown file which describes the pricing information of the Extension
linksobject—
links.getstartedallOfFirst steps, how to setup or use.
links.learnallOfDeeper content to help users better understand your extension or service.
links.licenseallOfEnd user license agreement.
links.privacypolicyallOfPrivacy policy for an extension.
links.supportallOfGet help and support for an extension.
repositoryobject—
repository.typerequiredstring—
one of: "git", "mercurial", "svn", "cvs"
repository.urirequiredstring—
badgesarray<object>Array of links to external metadata badges like TravisCI, Appveyor etc from the approved badges sites.
brandingobjectDictionary of brand-related properties.
branding.colorrequiredstringPrimary color of the extension or publisher; can be a hex (#ff00ff), RGB (rgb(100,200,50)), or supported HTML color names (blue).
branding.themestringComplements the color; use dark for dark branding colors, or light for lighter branding colors.
one of: "light", "dark"
publicbooleanSet to true to make this extension public in the Visual Studio Market Place
default: false
filesarray<object>—
contributionsarray—
contributionTypesarray—
Audit

What we found in this schema

Standards

Specification sections for the keywords in this schema

Keyword Document Section
$commentJSON Schema Core, draft 2020-12§8.3 — Comments With "$comment"
$idJSON Schema Core, draft 2020-12§8.2.1 — The "$id" Keyword
$refJSON Schema Core, draft 2020-12§8.2.3.1 — Direct References with "$ref"
$schemaJSON Schema Core, draft 2020-12§8.1.1 — "$schema"
allOfJSON Schema Core, draft 2020-12§10.2.1.1 — "allOf"
defaultJSON Schema Validation, draft 2020-12§9.2 — "default"
descriptionJSON Schema Validation, draft 2020-12§9.1 — "title" and "description"
enumJSON Schema Validation, draft 2020-12§6.1.2 — "enum"
examplesJSON Schema Validation, draft 2020-12§9.5 — "examples"
formatJSON Schema Validation, draft 2020-12§7 — Vocabularies for Semantic Content With "format"
itemsJSON Schema Core, draft 2020-12§10.3.1.2 — "items"
maxLengthJSON Schema Validation, draft 2020-12§6.3.1 — "maxLength"
minItemsJSON Schema Validation, draft 2020-12§6.4.2 — "minItems"
patternJSON Schema Validation, draft 2020-12§6.3.3 — "pattern"
propertiesJSON Schema Core, draft 2020-12§10.3.2.1 — "properties"
requiredJSON Schema Validation, draft 2020-12§6.5.3 — "required"
typeJSON Schema Validation, draft 2020-12§6.1.1 — "type"
format: "uri"RFC 3986 (STD 66)§3 — Syntax Components
format: "uri-reference"RFC 3986 (STD 66)§4.1 — URI Reference

Documents

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas