schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
sarif-2.1.0-rtm.5.json
method
The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.
{"type": "string"}
sarif-2.1.0-rtm.5.json
headers
The request headers.
{"type": "object", "additionalProperties": {"type": "string"}}
sarif-2.1.0-rtm.5.json
parameters
The request parameters.
{"type": "object", "additionalProperties": {"type": "string"}}
sarif-2.1.0-rtm.5.json
body
The body of the request.
{}
sarif-2.1.0-rtm.5.json
properties
Key/value pairs that provide additional information about the request.
{}
sarif-2.1.0-rtm.5.json
webResponse
Describes the response to an HTTP request.
{"type": "object", "additionalProperties": false, "properties": {"index": {"type": "integer", "default": -1, "minimum": -1}, "protocol": {"type": "string"}, "version": {"type": "string"}, "statusCode": {"type": "integer"}, "reasonPhrase": {"type": "string"}, "headers": {"type": "object", "additionalProperties": {"type"...
sarif-2.1.0-rtm.5.json
index
The index within the run.webResponses array of the response object associated with this result.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.5.json
protocol
The response protocol. Example: 'http'.
{"type": "string"}
sarif-2.1.0-rtm.5.json
version
The response version. Example: '1.1'.
{"type": "string"}
sarif-2.1.0-rtm.5.json
statusCode
The response status code. Example: 451.
{"type": "integer"}
sarif-2.1.0-rtm.5.json
reasonPhrase
The response reason. Example: 'Not found'.
{"type": "string"}
sarif-2.1.0-rtm.5.json
headers
The response headers.
{"type": "object", "additionalProperties": {"type": "string"}}
sarif-2.1.0-rtm.5.json
body
The body of the response.
{}
sarif-2.1.0-rtm.5.json
noResponseReceived
Specifies whether a response was received from the server.
{"type": "boolean", "default": false}
sarif-2.1.0-rtm.5.json
properties
Key/value pairs that provide additional information about the response.
{}
sarif-2.1.0-rtm.5.json
$schema
The URI of the JSON schema corresponding to the version.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.5.json
version
The SARIF format version of this log file.
{"enum": ["2.1.0"]}
sarif-2.1.0-rtm.5.json
runs
The set of runs contained in this log file.
{"type": "array", "minItems": 0, "uniqueItems": false, "items": {}}
sarif-2.1.0-rtm.5.json
inlineExternalProperties
References to external property files that share data between runs.
{"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}
sarif-2.1.0-rtm.5.json
properties
Key/value pairs that provide additional information about the log file.
{}
label-commenter-config.json
Configuration for Actions Label Commenter, for posting messages triggered by labels.
{"$schema": "http://json-schema.org/draft-04/schema#", "definitions": {"labelItem": {"type": "object", "properties": {"body": {"type": "string"}, "action": {"type": "string"}, "locking": {"enum": ["lock", "unlock"]}, "lock_reason": {"type": "string"}}}, "labelFor": {"type": "object", "properties": {"issue": {}, "pr": {...
swagger-2.0.json
info
General information about the API.
{"type": "object", "required": ["version", "title"], "additionalProperties": false, "patternProperties": {"^x-": {}}, "properties": {"version": {"type": "string"}, "termsOfService": {"type": "string"}, "contact": {}, "license": {}}}
swagger-2.0.json
title
A unique and precise title of the API.
{"type": "string"}
swagger-2.0.json
version
A semantic version number of the API.
{"type": "string"}
swagger-2.0.json
description
A longer description of the API. Should be different from the title. GitHub Flavored Markdown is allowed.
{"type": "string"}
swagger-2.0.json
termsOfService
The terms of service for the API.
{"type": "string"}
swagger-2.0.json
contact
Contact information for the owners of the API.
{"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "url": {"type": "string", "format": "uri"}, "email": {"type": "string", "format": "email"}}, "patternProperties": {"^x-": {}}}
swagger-2.0.json
name
The identifying name of the contact person/organization.
{"type": "string"}
swagger-2.0.json
url
The URL pointing to the contact information.
{"type": "string", "format": "uri"}
swagger-2.0.json
email
The email address of the contact person/organization.
{"type": "string", "format": "email"}
swagger-2.0.json
name
The name of the license type. It's encouraged to use an OSI compatible license.
{"type": "string"}
swagger-2.0.json
url
The URL pointing to the license.
{"type": "string", "format": "uri"}
swagger-2.0.json
paths
Relative paths to the individual endpoints. They must be relative to the 'basePath'.
{"type": "object", "patternProperties": {"^x-": {}, "^/": {}}, "additionalProperties": false}
swagger-2.0.json
definitions
One or more JSON objects describing the schemas being consumed and produced by the API.
{"type": "object", "additionalProperties": {}}
swagger-2.0.json
parameterDefinitions
One or more JSON representations for parameters
{"type": "object", "additionalProperties": {}}
swagger-2.0.json
responseDefinitions
One or more JSON representations for responses
{"type": "object", "additionalProperties": {}}
swagger-2.0.json
externalDocs
information about external documentation
{"type": "object", "additionalProperties": false, "required": ["url"], "properties": {"url": {"type": "string", "format": "uri"}}, "patternProperties": {"^x-": {}}}
swagger-2.0.json
mimeType
The MIME type of the HTTP message.
{"type": "string"}
swagger-2.0.json
summary
A brief summary of the operation.
{"type": "string"}
swagger-2.0.json
description
A longer description of the operation, GitHub Flavored Markdown is allowed.
{"type": "string"}
swagger-2.0.json
operationId
A unique identifier of the operation.
{"type": "string"}
swagger-2.0.json
produces
A list of MIME types the API can produce.
{"allOf": [{}]}
swagger-2.0.json
consumes
A list of MIME types the API can consume.
{"allOf": [{}]}
swagger-2.0.json
responses
Response objects names can either be any valid HTTP status code or 'default'.
{"type": "object", "minProperties": 1, "additionalProperties": false, "patternProperties": {"^([0-9]{3})$|^(default)$": {}, "^x-": {}}, "not": {"type": "object", "additionalProperties": false, "patternProperties": {"^x-": {}}}}
swagger-2.0.json
vendorExtension
Any property starting with x- is valid.
{}
swagger-2.0.json
description
A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
{"type": "string"}
swagger-2.0.json
name
The name of the parameter.
{"type": "string"}
swagger-2.0.json
in
Determines the location of the parameter.
{"type": "string", "enum": ["body"]}
swagger-2.0.json
required
Determines whether or not this parameter is required or optional.
{"type": "boolean", "default": false}
swagger-2.0.json
required
Determines whether or not this parameter is required or optional.
{"type": "boolean", "default": false}
swagger-2.0.json
in
Determines the location of the parameter.
{"type": "string", "enum": ["header"]}
swagger-2.0.json
description
A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
{"type": "string"}
swagger-2.0.json
name
The name of the parameter.
{"type": "string"}
swagger-2.0.json
required
Determines whether or not this parameter is required or optional.
{"type": "boolean", "default": false}
swagger-2.0.json
in
Determines the location of the parameter.
{"type": "string", "enum": ["query"]}
swagger-2.0.json
description
A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
{"type": "string"}
swagger-2.0.json
name
The name of the parameter.
{"type": "string"}
swagger-2.0.json
allowEmptyValue
allows sending a parameter by name only or with an empty value.
{"type": "boolean", "default": false}
swagger-2.0.json
required
Determines whether or not this parameter is required or optional.
{"type": "boolean", "default": false}
swagger-2.0.json
in
Determines the location of the parameter.
{"type": "string", "enum": ["formData"]}
swagger-2.0.json
description
A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
{"type": "string"}
swagger-2.0.json
name
The name of the parameter.
{"type": "string"}
swagger-2.0.json
allowEmptyValue
allows sending a parameter by name only or with an empty value.
{"type": "boolean", "default": false}
swagger-2.0.json
required
Determines whether or not this parameter is required or optional.
{"type": "boolean", "enum": [true]}
swagger-2.0.json
in
Determines the location of the parameter.
{"type": "string", "enum": ["path"]}
swagger-2.0.json
description
A brief description of the parameter. This could contain examples of use. GitHub Flavored Markdown is allowed.
{"type": "string"}
swagger-2.0.json
name
The name of the parameter.
{"type": "string"}
swagger-2.0.json
schema
A deterministic version of a JSON Schema object.
{"type": "object", "patternProperties": {"^x-": {}}, "properties": {"format": {"type": "string"}, "default": {}, "multipleOf": {}, "maximum": {}, "exclusiveMaximum": {}, "minimum": {}, "exclusiveMinimum": {}, "maxLength": {}, "minLength": {}, "pattern": {}, "maxItems": {}, "minItems": {}, "uniqueItems": {}, "maxPropert...
swagger-2.0.json
fileSchema
A deterministic version of a JSON Schema object.
{"type": "object", "patternProperties": {"^x-": {}}, "required": ["type"], "properties": {"format": {"type": "string"}, "default": {}, "required": {}, "type": {"type": "string", "enum": ["file"]}, "readOnly": {"type": "boolean", "default": false}, "externalDocs": {}, "example": {}}, "additionalProperties": false}
swagger-2.0.json
parametersList
The parameters needed to send a valid API call.
{"type": "array", "items": {"oneOf": [{}, {}]}, "uniqueItems": true}
swagger-2.0.json
schemesList
The transfer protocol of the API.
{"type": "array", "items": {"type": "string", "enum": ["http", "https", "ws", "wss"]}, "uniqueItems": true}
swagger-2.0.json
swagger
The Swagger version of this document.
{"type": "string", "enum": ["2.0"]}
swagger-2.0.json
host
The host (name or ip) of the API. Example: 'swagger.io'
{"type": "string", "pattern": "^[^{}/ :\\\\]+(?::\\d+)?$"}
swagger-2.0.json
basePath
The base path to the API. Example: '/api'.
{"type": "string", "pattern": "^/"}
swagger-2.0.json
consumes
A list of MIME types accepted by the API.
{"allOf": [{}]}
swagger-2.0.json
produces
A list of MIME types the API can produce.
{"allOf": [{}]}
github-issue-forms.json
type
A form item type https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys
{"type": "string", "enum": ["checkboxes", "dropdown", "input", "markdown", "textarea"]}
github-issue-forms.json
required
Specify whether require a form item
{"type": "boolean", "default": false}
github-issue-forms.json
form_item
A form item https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#about-githubs-form-schema
{"type": "object", "required": ["type"], "properties": {"type": {}}, "allOf": [{"if": {"properties": {"type": {"const": "markdown"}}}, "then": {"type": "object", "required": ["type", "attributes"], "properties": {"type": {}, "attributes": {"type": "object", "required": ["value"], "properties": {"value": {"type": "strin...
github-issue-forms.json
then
Markdown https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#markdown
{"type": "object", "required": ["type", "attributes"], "properties": {"type": {}, "attributes": {"type": "object", "required": ["value"], "properties": {"value": {"type": "string", "minLength": 1, "examples": ["Sample code"]}}, "additionalProperties": false}}, "additionalProperties": false}
github-issue-forms.json
attributes
Markdown attributes https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes
{"type": "object", "required": ["value"], "properties": {"value": {"type": "string", "minLength": 1, "examples": ["Sample code"]}}, "additionalProperties": false}
github-issue-forms.json
value
A markdown code https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes
{"type": "string", "minLength": 1, "examples": ["Sample code"]}
github-issue-forms.json
then
Textarea https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#textarea
{"type": "object", "required": ["type", "attributes"], "properties": {"type": {}, "id": {}, "attributes": {"type": "object", "required": ["label"], "properties": {"label": {}, "placeholder": {}, "value": {}, "render": {"type": "string", "enum": ["1C Enterprise", "4D", "ABAP CDS", "ABAP", "ABNF", "AFDKO", "AGS Script", ...
github-issue-forms.json
id
A textarea id https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys
{}
github-issue-forms.json
attributes
Textarea attributes https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1
{"type": "object", "required": ["label"], "properties": {"label": {}, "placeholder": {}, "value": {}, "render": {"type": "string", "enum": ["1C Enterprise", "4D", "ABAP CDS", "ABAP", "ABNF", "AFDKO", "AGS Script", "AIDL", "AL", "AMPL", "ANTLR", "API Blueprint", "APL", "ASL", "ASN.1", "ASP.NET", "ATS", "ActionScript", "...
github-issue-forms.json
label
A short textarea description https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1
{}
github-issue-forms.json
description
A long textarea description https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1
{}
github-issue-forms.json
placeholder
A textarea placeholder https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1
{}
github-issue-forms.json
value
A textarea value https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1
{}
github-issue-forms.json
render
A textarea syntax highlighting mode https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1
{"type": "string", "enum": ["1C Enterprise", "4D", "ABAP CDS", "ABAP", "ABNF", "AFDKO", "AGS Script", "AIDL", "AL", "AMPL", "ANTLR", "API Blueprint", "APL", "ASL", "ASN.1", "ASP.NET", "ATS", "ActionScript", "Ada", "Alloy", "Alpine Abuild", "Altium Designer", "AngelScript", "Ant Build System", "ApacheConf", "Apex", "Apo...
github-issue-forms.json
validations
Textarea validations https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#validations
{}
github-issue-forms.json
then
Input https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#input
{"type": "object", "required": ["type", "attributes"], "properties": {"type": {}, "id": {}, "attributes": {"type": "object", "required": ["label"], "properties": {"label": {}, "placeholder": {}, "value": {}}, "additionalProperties": false}, "validations": {}}, "additionalProperties": false}
github-issue-forms.json
id
An input id https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys
{}
github-issue-forms.json
attributes
Input attributes https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-2
{"type": "object", "required": ["label"], "properties": {"label": {}, "placeholder": {}, "value": {}}, "additionalProperties": false}
github-issue-forms.json
label
A short input description https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-2
{}
github-issue-forms.json
description
A long input description https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-2
{}
github-issue-forms.json
placeholder
An input placeholder https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-2
{}
github-issue-forms.json
value
An input value https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-2
{}
github-issue-forms.json
validations
Input validations https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#validations-1
{}
github-issue-forms.json
then
dropdown https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#dropdown
{"type": "object", "required": ["type", "attributes"], "properties": {"type": {}, "id": {}, "attributes": {"type": "object", "required": ["label", "options"], "properties": {"label": {}, "multiple": {"type": "boolean", "default": false}, "options": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type":...