schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
apibuilder.json
example
Optional - an example value for this parameter used only in the produced documentation
{"type": "string"}
apibuilder.json
minimum
Optional - For a string, refers to the minimum length. For an array, the minimum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at least 1 element.
{"type": "integer"}
apibuilder.json
maximum
Optional - For a string, refers to the maximum length. For an array, the maximum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at most 1 element.
{"type": "integer"}
apibuilder.json
attributes
JSON array defining additional meta data about this parameter for use by generators.
{"type": "array", "items": {}}
apibuilder.json
^[0-9]*$
A valid HTTP status code for this response (e.g. 200). Only status codes that have interesting return types should be documented. You can also specify an HTTP status code of 'default' to map to all other non documented types. This is useful to capture a generic error type that would be returned for non documented response codes. There are a few conventions enforced: - HTTP Response codes of 5xx cannot be explicitly specified and are handled automatically to ensure consistent behavior in generated client libraries. - HTTP Response codes of 204 and 304 indicate that no content is returned, so they must use a type of unit.
{"type": "object", "properties": {"type": {"type": "string"}, "headers": {"type": "array", "items": {}}, "attributes": {"type": "array", "items": {}}, "deprecation": {}}, "required": ["type"], "additionalProperties": false}
apibuilder.json
type
Specifies the type of this response. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with "[]". For example, to specify that the type is a collection of strings, use "[string]". To specify a Map, the type name can be prefixed with "map[type]". For example, to specify that the type is a Map of string to long, use "map[long]". Note that for map, the keys must be strings (per the JSON specification).
{"type": "string"}
apibuilder.json
description
Optional description for what this response provides. Supports GFM.
{"type": "string"}
apibuilder.json
attributes
JSON Array defining additional meta data about this service. Attributes are used to add custom extensions to API Builder and are typically used by generators to enable advanced code generation.
{"type": "array", "items": {}}
apibuilder.json
type
Specifies the type of this body. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with "[]". For example, to specify that the type is a collection of strings, use "[string]". To specify a Map, the type name can be prefixed with "map[type]". For example, to specify that the type is a Map of string to long, use "map[long]". Note that for map, the keys must be strings (per the JSON specification).
{"type": "string"}
apibuilder.json
description
Optional description for what this body provides. Supports GFM.
{"type": "string"}
apibuilder.json
attributes
JSON Array defining additional meta data about this body for use by generators.
{"type": "array", "items": {}}
apibuilder.json
$schema
A JSON schema URL
{"type": "string"}
apibuilder.json
name
The human readable name of this service. Used for display, and as the basis for generating a unique key for URL.
{"type": "string"}
apibuilder.json
apidoc
Optionally specify the specific version of API Builder for which your service is written. If not provided, we automatically default to the current production version.
{}
apibuilder.json
info
Optionally specify additional metadata about this service (e.g. contact info, license).
{}
apibuilder.json
namespace
Specifies the namespace for this service. Namespace is primarily used when other services import definitions from your service and in the code generators when defining things like package names. If not specified, we will automatically generate a namespace based on [organization namespace].[formatted service name].[major version number]. Note that by default API Builder includes the major version number in the package name which allows service authors and clients to interact with multiple versions of the service where changes have been made in a non backwards compatible way.
{"type": "string"}
apibuilder.json
base_url
The base URL where this service is hosted. Must start with http.
{"type": "string"}
apibuilder.json
description
optional description for what this service provides. Supports GFM.
{"type": "string"}
apibuilder.json
imports
JSON Array defining any other services whose schema definitions we would like to import into our service.
{"type": "array", "items": {}}
apibuilder.json
headers
JSON Array defining any HTTP Headers that the service understands or expects.
{"type": "array", "items": {}}
apibuilder.json
enums
JSON object defining all of the enums in this API. The key of each object is the enum name.
{}
apibuilder.json
models
JSON object defining all of the models in this API. The key of each object is the model name.
{}
apibuilder.json
resources
JSON object defining all of the resources in this API. The key of each object is the name of a type that this resource represents. The type must be the name of a model or an enum.
{}
apibuilder.json
attributes
JSON Array defining additional meta data about this service. Attributes are used to add custom extensions to API Builder and are typically used by generators to enable advanced code generation.
{"type": "array", "items": {}}
apibuilder.json
annotations
JSON object defining all of the annotations in this API. The key of each object is the annotation name.
{}
loobin-1.0.json
LOOBin base class
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": {"ExampleUseCase": {"type": "object", "properties": {"name": {"type": "string"}, "code": {"type": "string"}, "tactics": {"type": "array", "items": {"enum": ["Reconnaissance", "Resource Development", "Initial Access", "Execution", "Persistence", "Privilege Escalation", "Defense Evasion", "Credential Access", "Discovery", "Lateral Movement", "Collection", "Exfiltration", "Command and Control", "Impact"], "type": "string"}}, "tags": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "description"]}, "Detection": {"type": "object", "properties": {"name": {"type": "string"}, "url": {"type": "string"}}, "required": ["name", "url"]}, "Resource": {"type": "object", "properties": {"name": {"type": "string"}, "url": {"type": "string"}}, "required": ["name", "url"]}}, "properties": {"name": {"type": "string"}, "author": {"type": "string"}, "short_description": {"type": "string"}, "full_description": {"type": "string"}, "created": {"type": "string", "format": "date"}, "example_use_cases": {"type": "array", "items": {}}, "paths": {"type": "array", "items": {"type": "string"}}, "detections": {"type": "array", "items": {}}, "resources": {"type": "array", "items": {}}, "acknowledgements": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "author", "short_description", "full_description", "created", "example_use_cases", "paths", "detections"], "type": "object"}
loobin-1.0.json
ExampleUseCase
Use case base class
{"type": "object", "properties": {"name": {"type": "string"}, "code": {"type": "string"}, "tactics": {"type": "array", "items": {"enum": ["Reconnaissance", "Resource Development", "Initial Access", "Execution", "Persistence", "Privilege Escalation", "Defense Evasion", "Credential Access", "Discovery", "Lateral Movement", "Collection", "Exfiltration", "Command and Control", "Impact"], "type": "string"}}, "tags": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "description"]}
loobin-1.0.json
Detection
Detection base class
{"type": "object", "properties": {"name": {"type": "string"}, "url": {"type": "string"}}, "required": ["name", "url"]}
loobin-1.0.json
Resource
External reference base class
{"type": "object", "properties": {"name": {"type": "string"}, "url": {"type": "string"}}, "required": ["name", "url"]}
loobin-1.0.json
name
Name of the LOOBin
{"type": "string"}
loobin-1.0.json
author
Author of the LOOBin
{"type": "string"}
loobin-1.0.json
short_description
A short description of the LOOBin.This will display in the LOOBin card list and the LOOBins website search results.
{"type": "string"}
loobin-1.0.json
full_description
A full description of the LOOBin.This will display on the LOOBin's single page.
{"type": "string"}
loobin-1.0.json
created
Date the LOOBin was created
{"type": "string", "format": "date"}
loobin-1.0.json
example_use_cases
A list of example use cases for the LOOBin
{"type": "array", "items": {}}
loobin-1.0.json
paths
A list of paths to the LOOBin
{"type": "array", "items": {"type": "string"}}
loobin-1.0.json
detections
A list of detections for the LOOBin
{"type": "array", "items": {}}
loobin-1.0.json
resources
A list of useful resources for the LOOBin
{"type": "array", "items": {}}
loobin-1.0.json
acknowledgements
Acknowledgements for the LOOBin
{"type": "array", "items": {"type": "string"}}
commands.json
Schema for bundleconfig.json files
{"$schema": "http://json-schema.org/draft-04/schema#", "definitions": {"commands": {"type": "object", "required": ["fileName"], "properties": {"fileName": {"type": "string"}, "workingDirectory": {"type": "string"}, "arguments": {"type": "string"}}}, "vsbindings": {"type": "array", "items": {"type": "string"}}}, "id": "https://json.schemastore.org/commands.json", "properties": {"commands": {"additionalProperties": {}}, "-vs-binding": {"type": "object", "properties": {"AfterBuild": {}, "BeforeBuild": {}, "Clean": {}, "ProjectOpen": {}}}}, "type": "object"}
commands.json
commands
The friendly name of the command.
{"type": "object", "required": ["fileName"], "properties": {"fileName": {"type": "string"}, "workingDirectory": {"type": "string"}, "arguments": {"type": "string"}}}
commands.json
fileName
The name of the executable file name. Example: "cmd.exe".
{"type": "string"}
commands.json
workingDirectory
Specify a relative or absolute directory path.
{"type": "string"}
commands.json
arguments
The arguments to pass to the executable file.
{"type": "string"}
commands.json
vsbindings
A Visual Studio event that a command can be bound to.
{"type": "array", "items": {"type": "string"}}
commands.json
commands
A list of commands.
{"additionalProperties": {}}
commands.json
-vs-binding
Specify any Visual Studio event bindings.
{"type": "object", "properties": {"AfterBuild": {}, "BeforeBuild": {}, "Clean": {}, "ProjectOpen": {}}}
babelrc.json
env
This is an object of keys that represent different environments. For example, you may have: `{ env: { production: { /* specific options */ } } }` which will use those options when the environment variable BABEL_ENV is set to "production". If BABEL_ENV isn't set then NODE_ENV will be used, if it's not set then it defaults to "development"
{"type": "object", "additionalProperties": {}, "default": {}}
babelrc.json
ast
Include the AST in the returned object
{"type": "boolean", "default": true}
babelrc.json
auxiliaryCommentAfter
Attach a comment after all non-user injected code.
{"type": "string"}
babelrc.json
auxiliaryCommentBefore
Attach a comment before all non-user injected code.
{"type": "string"}
babelrc.json
code
Enable code generation
{"type": "boolean", "default": true}
babelrc.json
comments
Output comments in generated output.
{"type": "boolean", "default": true}
babelrc.json
compact
Do not include superfluous whitespace characters and line terminators. When set to "auto" compact is set to true on input sizes of >500KB.
{"type": ["string", "boolean"], "enum": ["auto", true, false], "default": "auto"}
babelrc.json
extends
A path to a .babelrc file to extend
{"type": "string"}
babelrc.json
filename
Filename for use in errors etc.
{"type": "string", "default": "unknown"}
babelrc.json
filenameRelative
Filename relative to sourceRoot (defaults to "filename")
{"type": "string"}
babelrc.json
highlightCode
ANSI highlight syntax error code frames
{"type": "boolean"}
babelrc.json
ignore
Opposite of the "only" option
{"type": ["string", "array"], "items": {"type": "string"}}
babelrc.json
inputSourceMap
If true, attempt to load an input sourcemap from the file itself. If an object is provided, it will be treated as the source map object itself.
{"type": ["boolean", "object"], "default": true}
babelrc.json
keepModuleIdExtensions
Keep extensions in module ids
{"type": "boolean", "default": false}
babelrc.json
moduleId
Specify a custom name for module ids.
{"type": "string"}
babelrc.json
moduleIds
If truthy, insert an explicit id for modules. By default, all modules are anonymous. (Not available for common modules)
{"type": "string", "default": false}
babelrc.json
moduleRoot
Optional prefix for the AMD module formatter that will be prepend to the filename on module definitions. (defaults to "sourceRoot")
{"type": "string"}
babelrc.json
only
A glob, regex, or mixed array of both, matching paths to only compile. Can also be an array of arrays containing paths to explicitly match. When attempting to compile a non-matching file it's returned verbatim.
{"type": ["string", "array"], "items": {"type": "string"}}
babelrc.json
plugins
List of plugins to load and use
{"type": "array", "items": {"type": ["string", "array"], "items": [{"type": "string"}, {"type": "object"}]}}
babelrc.json
items
The name of the plugin.
{"type": "string"}
babelrc.json
items
The options of the plugin.
{"type": "object"}
babelrc.json
presets
List of presets (a set of plugins) to load and use
{"type": "array", "items": {"type": ["string", "array"], "items": [{"type": "string"}, {"type": "object"}]}}
babelrc.json
items
The name of the preset.
{"type": "string"}
babelrc.json
items
The options of the preset.
{"type": "object"}
babelrc.json
retainLines
Retain line numbers. This will lead to wacky code but is handy for scenarios where you can't use source maps. NOTE: This will obviously not retain the columns.
{"default": false, "type": "boolean"}
babelrc.json
sourceFileName
Set sources[0] on returned source map. (defaults to "filenameRelative")
{"type": "string"}
babelrc.json
sourceMaps
If truthy, adds a map property to returned output. If set to "inline", a comment with a sourceMappingURL directive is added to the bottom of the returned code. If set to "both" then a map property is returned as well as a source map comment appended.
{"default": false, "type": ["string", "boolean"], "enum": ["both", "inline", true, false]}
babelrc.json
sourceMapTarget
Set file on returned source map. (defaults to "filenameRelative")
{"type": "string"}
babelrc.json
sourceRoot
The root from which all sources are relative. (defaults to "moduleRoot")
{"type": "string"}
azure-devops-extension-manifest-1.0.json
Base class for extension properties which are shared by the extension manifest and the extension model
{"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"Badge": {"properties": {"href": {"type": "string"}, "uri": {"type": "string"}}, "required": ["uri"], "type": "object"}, "Content": {"properties": {"path": {"type": "string"}}, "required": ["path"], "type": "object"}, "Contribution": {"properties": {"constraints": {"items": {}, "type": "array"}, "id": {"type": "string"}, "includes": {"items": {"type": "string"}, "type": "array"}, "properties": {}, "restrictedTo": {"items": {"type": "string"}, "type": "array"}, "targets": {"items": {"type": "string"}, "type": "array"}, "type": {"type": "string"}, "visibleTo": {"items": {"type": "string"}, "type": "array"}}, "required": ["id", "targets", "type"], "type": "object"}, "ContributionConstraint": {"properties": {"group": {"type": "number"}, "id": {"type": "string"}, "inverse": {"type": "boolean"}, "name": {"type": "string"}, "properties": {}, "relationships": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "ContributionLicensingBehaviorType": {"enum": [0, 1, 2], "type": "number"}, "ContributionPropertyDescription": {"properties": {"name": {"type": "string"}, "required": {"type": "boolean"}, "type": {}}, "type": "object"}, "ContributionPropertyType": {"enum": [0, 1, 128, 16, 2, 256, 32, 4, 512, 64, 8], "type": "number"}, "ContributionType": {"properties": {"id": {"type": "string"}, "indexed": {"type": "boolean"}, "name": {"type": "string"}, "properties": {"additionalProperties": {}, "type": "object"}, "visibleTo": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}, "ExtensionEventCallback": {"properties": {"uri": {"type": "string"}}, "type": "object"}, "ExtensionEventCallbackCollection": {"properties": {"postDisable": {}, "postEnable": {}, "postInstall": {}, "postUninstall": {}, "postUpdate": {}, "preInstall": {}, "versionCheck": {}}, "type": "object"}, "ExtensionLicensing": {"properties": {"overrides": {"items": {}, "type": "array"}}, "type": "object"}, "File": {"properties": {"path": {"type": "string"}, "addressable": {"type": "boolean"}, "packagePath": {"type": "string"}, "contentType": {"type": "string"}, "assetType": {"type": "string"}, "lang": {"type": "string"}}, "required": ["path"], "type": "object"}, "LicensingOverride": {"properties": {"behavior": {}, "id": {"type": "string"}}, "type": "object"}, "Link": {"properties": {"uri": {"type": "string"}}, "type": "object"}, "Target": {"properties": {"id": {"type": "string", "enum": ["Microsoft.VisualStudio.Services", "Microsoft.TeamFoundation.Server", "Microsoft.VisualStudio.Services.Integration", "Microsoft.TeamFoundation.Server.Integration"]}}, "required": ["id"], "type": "object"}}, "properties": {"badges": {"type": "array", "items": {}}, "baseUri": {"type": "string"}, "branding": {"properties": {"color": {"type": "string"}, "theme": {"type": "string", "enum": ["dark", "light"]}}, "type": "object"}, "categories": {"type": "array", "items": {"type": "string", "enum": ["Azure Repos", "Azure Boards", "Azure Pipelines", "Azure Test Plans", "Azure Artifacts"]}, "minItems": 1}, "constraints": {"items": {}, "type": "array"}, "content": {"properties": {"details": {}}, "additionalProperties": {}, "type": "object"}, "contributionTypes": {"items": {}, "type": "array"}, "contributions": {"items": {}, "type": "array"}, "demands": {"items": {"type": "string"}, "type": "array"}, "eventCallbacks": {}, "fallbackBaseUri": {"type": "string"}, "files": {"type": "array", "items": {}}, "icons": {"type": "object", "properties": {"default": {"type": "string"}}, "additionalProperties": {"type": "string"}}, "id": {"type": "string"}, "language": {"type": "string"}, "licensing": {}, "manifestVersion": {"type": "number"}, "name": {"type": "string", "maxLength": 200}, "links": {"type": "object", "properties": {"getstarted": {}, "learn": {}, "license": {}, "privacypolicy": {}, "support": {}}, "additionalProperties": {}}, "publisher": {"type": "string"}, "repository": {"type": "object", "properties": {"type": {"type": "string"}, "uri": {"type": "string"}}}, "restrictedTo": {"items": {"type": "string"}, "type": "array"}, "scopes": {"items": {"type": "string"}, "type": "array"}, "screenshots": {"type": "array", "items": {}}, "serviceInstanceType": {"type": "string"}, "tags": {"type": "array", "items": {"type": "string"}}, "targets": {"type": "array", "items": {}, "minItems": 1}, "version": {"type": "string"}}, "type": "object"}
azure-devops-extension-manifest-1.0.json
Badge
A link to external metadata badge.
{"properties": {"href": {"type": "string"}, "uri": {"type": "string"}}, "required": ["uri"], "type": "object"}
azure-devops-extension-manifest-1.0.json
href
Link the user navigates to when selecting the badge.
{"type": "string"}
azure-devops-extension-manifest-1.0.json
uri
The absolute URL of the badge image to be displayed.
{"type": "string"}
azure-devops-extension-manifest-1.0.json
description
Description of the badge, to be displayed on hover.
{"type": "string"}
azure-devops-extension-manifest-1.0.json
Content
A content file that describes the extension to users.
{"properties": {"path": {"type": "string"}}, "required": ["path"], "type": "object"}
azure-devops-extension-manifest-1.0.json
path
The path to the file in the extension.
{"type": "string"}
azure-devops-extension-manifest-1.0.json
Contribution
An individual contribution made by an extension
{"properties": {"constraints": {"items": {}, "type": "array"}, "id": {"type": "string"}, "includes": {"items": {"type": "string"}, "type": "array"}, "properties": {}, "restrictedTo": {"items": {"type": "string"}, "type": "array"}, "targets": {"items": {"type": "string"}, "type": "array"}, "type": {"type": "string"}, "visibleTo": {"items": {"type": "string"}, "type": "array"}}, "required": ["id", "targets", "type"], "type": "object"}
azure-devops-extension-manifest-1.0.json
constraints
List of constraints (filters) that should be applied to the availability of this contribution
{"items": {}, "type": "array"}
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
includes
Includes is a set of contributions that should have this contribution included in their targets list.
{"items": {"type": "string"}, "type": "array"}
azure-devops-extension-manifest-1.0.json
properties
Properties/attributes of this contribution
{}
azure-devops-extension-manifest-1.0.json
restrictedTo
List of demanded claims in order for the user to see this contribution (like anonymous, public, member...).
{"items": {"type": "string"}, "type": "array"}
azure-devops-extension-manifest-1.0.json
targets
The ids of the contribution(s) that this contribution targets. (parent contributions)
{"items": {"type": "string"}, "type": "array"}
azure-devops-extension-manifest-1.0.json
type
Id of the Contribution Type
{"type": "string"}
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
ContributionConstraint
Specifies a constraint that can be used to dynamically include/exclude a given contribution
{"properties": {"group": {"type": "number"}, "id": {"type": "string"}, "inverse": {"type": "boolean"}, "name": {"type": "string"}, "properties": {}, "relationships": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}
azure-devops-extension-manifest-1.0.json
group
An optional property that can be specified to group constraints together. All constraints within a group are AND'd together (all must be evaluate to True in order for the contribution to be included). Different groups of constraints are OR'd (only one group needs to evaluate to True for the contribution to be included).
{"type": "number"}
azure-devops-extension-manifest-1.0.json
id
Fully qualified identifier of a shared constraint
{"type": "string"}
azure-devops-extension-manifest-1.0.json
inverse
If true, negate the result of the filter (include the contribution if the applied filter returns false instead of true)
{"type": "boolean"}
azure-devops-extension-manifest-1.0.json
name
Name of the IContributionFilter plugin
{"type": "string"}
azure-devops-extension-manifest-1.0.json
properties
Properties that are fed to the contribution filter class
{}
azure-devops-extension-manifest-1.0.json
relationships
Constraints can be optionally be applied to one or more of the relationships defined in the contribution. If no relationships are defined then all relationships are associated with the constraint. This means the default behaviour will eliminate the contribution from the tree completely if the constraint is applied.
{"items": {"type": "string"}, "type": "array"}