schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
azure-devops-extension-manifest-1.0.json
ContributionLicensingBehaviorType
Represents different ways of including contributions based on licensing
{"enum": [0, 1, 2], "type": "number"}
azure-devops-extension-manifest-1.0.json
ContributionPropertyDescription
Description about a property of a contribution type
{"properties": {"name": {"type": "string"}, "required": {"type": "boolean"}, "type": {}}, "type": "object"}
azure-devops-extension-manifest-1.0.json
description
Description of the property
{"type": "string"}
azure-devops-extension-manifest-1.0.json
name
Name of the property
{"type": "string"}
azure-devops-extension-manifest-1.0.json
required
True if this property is required
{"type": "boolean"}
azure-devops-extension-manifest-1.0.json
type
The type of value used for this property
{}
azure-devops-extension-manifest-1.0.json
ContributionPropertyType
The type of value used for a property
{"enum": [0, 1, 128, 16, 2, 256, 32, 4, 512, 64, 8], "type": "number"}
azure-devops-extension-manifest-1.0.json
ContributionType
A contribution type, given by a json schema
{"properties": {"id": {"type": "string"}, "indexed": {"type": "boolean"}, "name": {"type": "string"}, "properties": {"additionalProperties": {}, "type": "object"}, "visibleTo": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}
azure-devops-extension-manifest-1.0.json
description
Description of the contribution/type
{"type": "string"}
azure-devops-extension-manifest-1.0.json
id
Fully qualified identifier of the contribution/type
{"type": "string"}
azure-devops-extension-manifest-1.0.json
indexed
Controls whether or not contributions of this type have the type indexed for queries. This allows clients to find all extensions that have a contribution of this type. NOTE: Only TrustedPartners are allowed to specify indexed contribution types.
{"type": "boolean"}
azure-devops-extension-manifest-1.0.json
name
Friendly name of the contribution/type
{"type": "string"}
azure-devops-extension-manifest-1.0.json
properties
Describes the allowed properties for this contribution type
{"additionalProperties": {}, "type": "object"}
azure-devops-extension-manifest-1.0.json
visibleTo
VisibleTo can be used to restrict whom can reference a given contribution/type. This value should be a list of publishers or extensions access is restricted too. Examples: "ms" - Means only the "ms" publisher can reference this. "ms.vss-web" - Means only the "vss-web" extension from the "ms" publisher can reference this.
{"items": {"type": "string"}, "type": "array"}
azure-devops-extension-manifest-1.0.json
ExtensionEventCallback
Base class for an event callback for an extension
{"properties": {"uri": {"type": "string"}}, "type": "object"}
azure-devops-extension-manifest-1.0.json
uri
The uri of the endpoint that is hit when an event occurs
{"type": "string"}
azure-devops-extension-manifest-1.0.json
ExtensionEventCallbackCollection
Collection of event callbacks - endpoints called when particular extension events occur.
{"properties": {"postDisable": {}, "postEnable": {}, "postInstall": {}, "postUninstall": {}, "postUpdate": {}, "preInstall": {}, "versionCheck": {}}, "type": "object"}
azure-devops-extension-manifest-1.0.json
postDisable
Optional. Defines an endpoint that gets called via a POST request to notify that an extension disable has occurred.
{}
azure-devops-extension-manifest-1.0.json
postEnable
Optional. Defines an endpoint that gets called via a POST request to notify that an extension enable has occurred.
{}
azure-devops-extension-manifest-1.0.json
postInstall
Optional. Defines an endpoint that gets called via a POST request to notify that an extension install has completed.
{}
azure-devops-extension-manifest-1.0.json
postUninstall
Optional. Defines an endpoint that gets called via a POST request to notify that an extension uninstall has occurred.
{}
azure-devops-extension-manifest-1.0.json
postUpdate
Optional. Defines an endpoint that gets called via a POST request to notify that an extension update has occurred.
{}
azure-devops-extension-manifest-1.0.json
preInstall
Optional. Defines an endpoint that gets called via a POST request to notify that an extension install is about to occur. Response indicates whether to proceed or abort.
{}
azure-devops-extension-manifest-1.0.json
versionCheck
For multi-version extensions, defines an endpoint that gets called via an OPTIONS request to determine the particular version of the extension to be used
{}
azure-devops-extension-manifest-1.0.json
ExtensionLicensing
How an extension should handle including contributions based on licensing
{"properties": {"overrides": {"items": {}, "type": "array"}}, "type": "object"}
azure-devops-extension-manifest-1.0.json
overrides
A list of contributions which deviate from the default licensing behavior
{"items": {}, "type": "array"}
azure-devops-extension-manifest-1.0.json
path
Path to resource on disk, which can be relative to your root directory.
{"type": "string"}
azure-devops-extension-manifest-1.0.json
addressable
(optional) Set to true if you want your file to be URL-addressable. Defaults to false.
{"type": "boolean"}
azure-devops-extension-manifest-1.0.json
packagePath
(optional) Path to the resource within the package. Defaults to the relative path on disk from your root directory.
{"type": "string"}
azure-devops-extension-manifest-1.0.json
contentType
(optional) MIME type of the file. Defaults to a best guess based on the file extension and OS settings.
{"type": "string"}
azure-devops-extension-manifest-1.0.json
assetType
(optional) Specify the value of the Type attribute of the asset entry in the VSIX manifest. Can also be an array of strings, in which case multiple asset entries get added for this file. Defaults to the packagePath.
{"type": "string"}
azure-devops-extension-manifest-1.0.json
lang
(optional) Language of this asset. Localized files are served based on the Accept-Language header. Leave blank to signify this file is in the default (or fallback) language. Localized versions of the same file should have the same assetType.
{"type": "string"}
azure-devops-extension-manifest-1.0.json
LicensingOverride
Maps a contribution to a licensing behavior
{"properties": {"behavior": {}, "id": {"type": "string"}}, "type": "object"}
azure-devops-extension-manifest-1.0.json
behavior
How the inclusion of this contribution should change based on licensing
{}
azure-devops-extension-manifest-1.0.json
id
Fully qualified contribution id which we want to define licensing behavior for
{"type": "string"}
azure-devops-extension-manifest-1.0.json
uri
The absolute URL of the link.
{"type": "string"}
azure-devops-extension-manifest-1.0.json
badges
Array of links to external metadata badges like TravisCI, Appveyor, and so on, from the approved badges sites.
{"type": "array", "items": {}}
azure-devops-extension-manifest-1.0.json
baseUri
Uri used as base for other relative uri's defined in extension
{"type": "string"}
azure-devops-extension-manifest-1.0.json
branding
Dictionary of brand-related properties.
{"properties": {"color": {"type": "string"}, "theme": {"type": "string", "enum": ["dark", "light"]}}, "type": "object"}
azure-devops-extension-manifest-1.0.json
color
Primary color of the extension or publisher; can be a hex (#ff00ff), RGB (rgb(100,200,50)), or supported HTML color names (blue).
{"type": "string"}
azure-devops-extension-manifest-1.0.json
theme
Complements the color; use dark for dark branding colors, or light for lighter branding colors.
{"type": "string", "enum": ["dark", "light"]}
azure-devops-extension-manifest-1.0.json
categories
Array of strings representing the categories your extension belongs to. At least one category must be provided and there's no limit to how many categories you may include. Valid values: Azure Repos, Azure Boards, Azure Pipelines, Azure Test Plans, and Azure Artifacts.
{"type": "array", "items": {"type": "string", "enum": ["Azure Repos", "Azure Boards", "Azure Pipelines", "Azure Test Plans", "Azure Artifacts"]}, "minItems": 1}
azure-devops-extension-manifest-1.0.json
constraints
List of shared constraints defined by this extension
{"items": {}, "type": "array"}
azure-devops-extension-manifest-1.0.json
content
Dictionary of content files that describe your extension to users.
{"properties": {"details": {}}, "additionalProperties": {}, "type": "object"}
azure-devops-extension-manifest-1.0.json
contributionTypes
List of contribution types defined by this extension
{"items": {}, "type": "array"}
azure-devops-extension-manifest-1.0.json
contributions
List of contributions made by this extension
{"items": {}, "type": "array"}
azure-devops-extension-manifest-1.0.json
demands
List of explicit demands required by this extension
{"items": {"type": "string"}, "type": "array"}
azure-devops-extension-manifest-1.0.json
description
A few sentences describing the extensions. Limited to 200 characters.
{"type": "string", "maxLength": 200}
azure-devops-extension-manifest-1.0.json
eventCallbacks
Collection of endpoints that get called when particular extension events occur
{}
azure-devops-extension-manifest-1.0.json
fallbackBaseUri
Secondary location that can be used as base for other relative uri's defined in extension
{"type": "string"}
azure-devops-extension-manifest-1.0.json
files
The files section is where you reference any files you wish to include in your extension.
{"type": "array", "items": {}}
azure-devops-extension-manifest-1.0.json
icons
Dictionary of icons representing the extension.
{"type": "object", "properties": {"default": {"type": "string"}}, "additionalProperties": {"type": "string"}}
azure-devops-extension-manifest-1.0.json
default
128x128 pixels
{"type": "string"}
azure-devops-extension-manifest-1.0.json
id
The extension's identifier.
{"type": "string"}
azure-devops-extension-manifest-1.0.json
language
Language Culture Name set by the Gallery
{"type": "string"}
azure-devops-extension-manifest-1.0.json
licensing
How this extension behaves with respect to licensing
{}
azure-devops-extension-manifest-1.0.json
manifestVersion
Version of the extension manifest format/content. Should be 1.
{"type": "number"}
azure-devops-extension-manifest-1.0.json
name
A short, human-readable name of the extension. Limited to 200 characters.
{"type": "string", "maxLength": 200}
azure-devops-extension-manifest-1.0.json
links
Dictionary of links that help users learn more about your extension, get support, and move.
{"type": "object", "properties": {"getstarted": {}, "learn": {}, "license": {}, "privacypolicy": {}, "support": {}}, "additionalProperties": {}}
azure-devops-extension-manifest-1.0.json
publisher
The identifier of the publisher. This identifier must match the identifier the extension is published under.
{"type": "string"}
azure-devops-extension-manifest-1.0.json
repository
Dictionary of properties describing the source code repository for the extension.
{"type": "object", "properties": {"type": {"type": "string"}, "uri": {"type": "string"}}}
azure-devops-extension-manifest-1.0.json
type
Type of repository. Example: git.
{"type": "string"}
azure-devops-extension-manifest-1.0.json
uri
Absolute URL of the repository.
{"type": "string"}
azure-devops-extension-manifest-1.0.json
restrictedTo
Default user claims applied to all contributions (except the ones which have been specified restrictedTo explicitly) to control the visibility of a contribution.
{"items": {"type": "string"}, "type": "array"}
azure-devops-extension-manifest-1.0.json
scopes
List of all oauth scopes required by this extension
{"items": {"type": "string"}, "type": "array"}
azure-devops-extension-manifest-1.0.json
screenshots
Array of images that couldn't be included in your content.
{"type": "array", "items": {}}
azure-devops-extension-manifest-1.0.json
serviceInstanceType
The ServiceInstanceType(Guid) of the VSTS service that must be available to an account in order for the extension to be installed
{"type": "string"}
azure-devops-extension-manifest-1.0.json
tags
Array of string tags to help users find your extension.
{"type": "array", "items": {"type": "string"}}
azure-devops-extension-manifest-1.0.json
targets
The products and services supported by your integration or extension.
{"type": "array", "items": {}, "minItems": 1}
azure-devops-extension-manifest-1.0.json
version
A string specifying the version of an extension. Should be in the format major.minor.patch.
{"type": "string"}
bower.json
^_
Any property starting with _ is valid.
{"additionalProperties": true}
bower.json
name
The name of your package.
{"type": "string", "maxLength": 50, "minLength": 1}
bower.json
description
Help users identify and search for your package with a brief description.
{"type": "string", "maxLength": 140}
bower.json
version
A semantic version number.
{"type": "string"}
bower.json
main
The primary acting files necessary to use your package.
{"type": ["string", "array"]}
bower.json
license
SPDX license identifier or path/url to a license.
{"type": ["string", "array"], "maxLength": 140}
bower.json
ignore
A list of files for Bower to ignore when installing your package.
{"type": ["string", "array"]}
bower.json
keywords
Used for search by keyword. Helps make your package easier to discover without people needing to know its name.
{"type": "array", "items": {"type": "string", "maxLength": 50}}
bower.json
authors
A list of people that authored the contents of the package.
{"type": "array", "items": {"type": ["string", "object"]}}
bower.json
homepage
URL to learn more about the package. Falls back to GitHub project if not specified and it's a GitHub endpoint.
{"type": "string", "format": "uri"}
bower.json
repository
The repository in which the source code can be found.
{"type": "object", "properties": {"type": {"type": "string", "enum": ["git"]}, "url": {"type": "string", "format": "uri"}}}
bower.json
dependencies
Dependencies are specified with a simple hash of package name to a semver compatible identifier or URL.
{"type": "object", "additionalProperties": {"type": "string"}}
bower.json
devDependencies
Dependencies that are only needed for development of the package, e.g., test framework or building documentation.
{"type": "object", "additionalProperties": {"type": "string"}}
bower.json
resolutions
Dependency versions to automatically resolve with if conflicts occur between packages.
{"type": "object"}
bower.json
private
If you set it to true it will refuse to publish it. This is a way to prevent accidental publication of private repositories.
{"type": "boolean"}
bower.json
exportsOverride
Used by grunt-bower-task to specify custom install locations.
{"type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": ["string", "array"]}}}
bower.json
moduleType
The types of modules this package exposes
{"type": ["array", "string"], "items": {"enum": ["amd", "es6", "globals", "node", "yui"]}}
importmap.json
imports
The Imports field
{"type": "object", "additionalProperties": {"type": "string"}}
importmap.json
scopes
The Scopes field
{"type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}}
function.json
dataType
The data type hint for the binding parameter (string, binary, or stream).
{"enum": ["string", "binary", "stream"]}
function.json
queueName
The service bus queue to monitor (if using a queue)
{"type": "string"}
function.json
topicName
The service bus topic to monitor (if using a queue)
{"type": "string"}
function.json
subscriptionName
The topic subscription name
{"type": "string"}
function.json
connection
An app setting (or environment variable) with the service bus connection string to be used by this binding.
{"type": "string"}
function.json
accessRights
The permission level of the service bus connection string used by this binding.
{"type": "string", "enum": ["manage", "listen", "send"]}
function.json
path
The path to the blob container
{"type": "string"}
function.json
connection
An app setting (or environment variable) with the storage connection string to be used by this binding.
{"type": "string"}
function.json
path
The event hub path.
{"type": "string"}
function.json
connection
The event hub connection string setting.
{"type": "string"}
function.json
consumerGroup
The event hub consumer group.
{"type": "string"}