collection.json

$ref: #/definitions/info

description: Items are the basic unit for a Postman collection. You can think of them as corresponding to a single API endpoint. Each Item has one request and may have multiple API responses associated with it.

title: Items

$ref: #/definitions/item

$ref: #/definitions/item-group

$ref: #/definitions/event-list

$ref: #/definitions/variable-list

$ref: #/definitions/auth

$ref: #/definitions/protocol-profile-behavior

required: info item

title: Auth

$id: #/definitions/auth-attribute

description: Represents an attribute for any authorization method provided by Postman. For example `username` and `password` are set as auth attributes for Basic Authentication method.

title: Auth

$id: #/definitions/auth

description: Represents authentication helpers provided by Postman

enum: apikey awsv4 basic bearer digest edgegrid hawk noauth oauth1 oauth2 ntlm

title: API Key Authentication

description: The attributes for API Key Authentication.

$ref: #/definitions/auth-attribute

title: AWS Signature v4

description: The attributes for [AWS Auth](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).

title: Basic Authentication

description: The attributes for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication).

title: Bearer Token Authentication

description: The helper attributes for [Bearer Token Authentication](https://tools.ietf.org/html/rfc6750)

title: Digest Authentication

description: The attributes for [Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication).

title: EdgeGrid Authentication

description: The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html).

title: Hawk Authentication

description: The attributes for [Hawk Authentication](https://github.com/hueniverse/hawk)

title: NTLM Authentication

description: The attributes for [NTLM Authentication](https://msdn.microsoft.com/en-us/library/cc237488.aspx)

title: OAuth1

description: The attributes for [OAuth2](https://oauth.net/1/)

title: OAuth2

description: Helper attributes for [OAuth2](https://oauth.net/2/)

$id: #/definitions/certificate-list

title: Certificate List

description: A representation of a list of ssl certificates

$ref: #/definitions/certificate

$id: #/definitions/certificate

title: Certificate

description: A representation of an ssl certificate

description: A name for the certificate for user reference

description: A list of Url match pattern strings, to identify Urls this certificate can be used for.

description: An Url match pattern string

description: An object containing path to file containing private key, on the file system

description: The path to file containing key for certificate, on the file system

description: An object containing path to file certificate, on the file system

description: The passphrase for the certificate

$id: #/definitions/cookie-list

title: Certificate List

description: A representation of a list of cookies

$ref: #/definitions/cookie

title: Cookie

$id: #/definitions/cookie

description: A Cookie, that follows the [Google Chrome format](https://developer.chrome.com/extensions/cookies)

description: The domain for which this cookie is valid.

description: When the cookie expires.

description: True if the cookie is a host-only cookie. (i.e. a request's URL domain must exactly match the domain of the cookie).

description: Indicates if this cookie is HTTP Only. (if True, the cookie is inaccessible to client-side scripts)

description: This is the name of the Cookie.

description: The path associated with the Cookie.

description: Indicates if the 'secure' flag is set on the Cookie, meaning that it is transmitted over secure connections only. (typically HTTPS)

description: True if the cookie is a session cookie.

description: The value of the Cookie.

description: Custom attributes for a cookie go here, such as the [Priority Field](https://code.google.com/p/chromium/issues/detail?id=232693)

required: domain path

$id: #/definitions/description

description: A Description can be a raw text, or be an object, which holds the description along with its format.

title: Description

description: The content of the description goes here, as a raw string.

description:
Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'.
The type is used to correctly render the description when generating documentation, or in the Postman app.

description: Description can have versions associated with it, which should be put in this property.

$id: #/definitions/event-list

title: Event List

description: Postman allows you to configure scripts to run when specific events occur. These scripts are stored here, and can be referenced in the collection by their ID.

$ref: #/definitions/event

$id: #/definitions/event

title: Event

description: Defines a script associated with an associated event name

description: A unique identifier for the enclosing event.

description: Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively.

$ref: #/definitions/script

description: Indicates whether the event is disabled. If absent, the event is assumed to be enabled.

$id: #/definitions/header-list

title: Header List

description: A representation for a list of headers

$ref: #/definitions/header

title: Header

$id: #/definitions/header

description: Represents a single HTTP Header

description: This holds the LHS of the HTTP Header, e.g ``Content-Type`` or ``X-Custom-Header``

description: The value (or the RHS) of the Header is stored in this field.

description: If set to true, the current header will not be sent with requests.

$ref: #/definitions/description

required: key value

$id: #/definitions/info

title: Information

description: Detailed description of the info block

title: Name of the collection

description: A collection's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this collection among a bunch of other collections, as such outlining its usage or content.

description:
Every collection is identified by the unique value of this field. The value of this field is usually easiest to generate using a UID generator function. If you already have a collection, it is recommended that you maintain the same id since changing the id usually implies that is a different collection than it was originally.
 *Note: This field exists for compatibility reasons with Collection Format V1.*

$ref: #/definitions/version

description: This should ideally hold a link to the Postman schema that is used to validate this collection. E.g: https://schema.getpostman.com/collection/v1

required: name schema

title: Folder

$id: #/definitions/item-group

description: One of the primary goals of Postman is to organize the development of APIs. To this end, it is necessary to be able to group requests together. This can be achived using 'Folders'. A folder just is an ordered set of requests.

description: A folder's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this folder.

description: Items are entities which contain an actual HTTP request, and sample responses attached to it. Folders may contain many items.

title: Items

title: Item

description: A unique ID that is used to identify collections internally

description: A human readable identifier for the current item.

title: Responses

title: Protocol Profile Behavior

description: Set of configurations used to alter the usual behavior of sending the request

title: Proxy Config

description: Using the Proxy, you can configure your custom proxy into the postman for particular url match

description: The Url match for which the proxy config is defined

description: The proxy server host

description: The proxy server port

description: The tunneling details for the proxy config

description: When set to true, ignores this proxy configuration entity

title: Request

description: A request represents an HTTP request. If a string, the string is assumed to be the request URL and the method is assumed to be 'GET'.

title: Request

description: The Standard HTTP method associated with this request.

enum: GET PUT POST PATCH DELETE COPY HEAD OPTIONS LINK UNLINK PURGE LOCK UNLOCK PROPFIND VIEW

description: The Custom HTTP method associated with this request.

description: This field contains the data usually contained in the request body.

description: Postman stores the type of data associated with this request in this field.

title: UrlEncodedParameter

title: FormParameter

description: When set to true, prevents this form data entity from being sent.

description: Override Content-Type header of this form data entity.

description: When set to true, prevents this form data entity from being sent.

description: Override Content-Type header of this form data entity.

description: Contains the name of the file to upload. _Not the path_.

description: A null src indicates that no file has been selected as a part of the request body

description: Additional configurations and options set for various body modes.

description: When set to true, prevents request body from being sent.

title: Response

description: A response represents an HTTP response.

description: A unique, user defined identifier that can  be used to refer to this response from requests.

title: ResponseTime

description: The time taken by the request to complete. If a number, the unit is milliseconds. If the response is manually created, this can be set to `null`.

title: Response Timings

description: Set of timing information related to request and response in milliseconds

title: Headers

title: Header

description: No HTTP request is complete without its headers, and the same is true for a Postman request. This field is an array containing all the headers.

title: Header

description: The raw text of the response.

description: The response status, e.g: '200 OK'

description: The numerical response code, example: 200, 201, 404, etc.

title: Script

description: A script is a snippet of Javascript code that can be used to to perform setup or teardown operations on a particular response.

description: A unique, user defined identifier that can  be used to refer to this script from requests.

description: Type of the script. E.g: 'text/javascript'

description: This is an array of strings, where each line represents a single line of code. Having lines separate makes it possible to easily track changes made to scripts.

description: Script name

description: If object, contains the complete broken-down URL for this request. If string, contains the literal request URL.

title: Url

description: The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s).

description: The protocol associated with the request, E.g: 'http'

title: Host

description: The host for the URL, E.g: api.yourdomain.com. Can be stored as a string or as an array of strings.

description: The host, split into subdomain strings.

description: The complete path of the current url, broken down into segments. A segment could be a string, or a path variable.

description: The port number present in this URL. An empty value implies 80/443 depending on whether the protocol field contains http/https.

description: An array of QueryParams, which is basically the query string part of the URL, parsed into separate variables

title: QueryParam

description: If set to true, the current query parameter will not be sent with the request.

description: Contains the URL fragment (if any). Usually this is not transmitted over the network, but it could be useful to store this in some cases.

description: Postman supports path variables with the syntax `/path/:variableName/to/somewhere`. These variables are stored in this field.

title: Variable List

description:
Collection variables allow you to define a set of variables, that are a *part of the collection*, as opposed to environments, which are separate entities.
*Note: Collection variables must not contain any sensitive information.*

title: Variable

description: Using variables in your Postman requests eliminates the need to duplicate requests, which can save a lot of time. Variables can be defined, and referenced to from any part of a request.

description: A variable ID is a unique user-defined value that identifies the variable within a collection. In traditional terms, this would be a variable name.

description: A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name.

description: The value that a variable holds in this collection. Ultimately, the variables will be replaced by this value, when say running a set of requests from a collection

description: A variable may have multiple types. This field specifies the type of the variable.

description: Variable name

description: When set to true, indicates that this variable has been set by Postman

title: Collection Version

description: Postman allows you to version your collections as they grow, and this field holds the version number. While optional, it is recommended that you use this field to its fullest extent!

description: Increment this number if you make changes to the collection that changes its behaviour. E.g: Removing or adding new test scripts. (partly or completely).

description: You should increment this number if you make changes that will not break anything that uses the collection. E.g: removing a folder.

description: Ideally, minor changes to a collection should result in the increment of this number.

description: A human friendly identifier to make sense of the version numbers. E.g: 'beta-3'


block-metadata.json

type: string

required: type url

type: object

$ref: #/definitions/JsonValue

type: array

$ref: #/definitions/JsonObject

type: string number boolean

description: The name of the author of the block

description: The type of block this is (e.g. custom element, React)

enum: custom-element html react

description: The commit hash of the source this block was built from. If specified, 'repository' must also be specified.

description: A short description of the block, to help users understand its capabilities

description: URL of a web socket that reports updates in locally developed blocks. To be used by EAs to auto reload.

description: The display name used for a block

description: A list of examples property objects which comply with the block's schema, for demonstration purposes

description: The dependencies a block relies on but expects the embedding application to provide, e.g. { "react": "^18.0.0" }

description: An icon for the block, to be displayed when the user is selecting from available blocks (as well as elsewhere as appropriate, e.g. in a website listing the block).

description: A preview image of the block for users to see it in action before using it. This would ideally have a 3:2 width:height ratio and be a minimum of 900x1170px.

description: The license the block is made available under (e.g. MIT).

description: A unique, slugified name for the block.

description: The applicable block protocol version, e.g. 0.3

$ref: #/definitions/BlockMetadataRepository

description: Specify the place where your block's code lives. This is helpful for people who want to explore the source, or contribute to your block's development.

description: The versioned URL to the block's schema, e.g. https://blockprotocol.org/@blockprotocol/types/entity-type/thing/v/2

description: The path or URL to the entrypoint source file (e.g. index.html, index.js).

description: A list which represents different variants of the block that the user can create.

required: name properties

description: The version of the block, which should use semantic versioning (@see https://semver.org/).

required: blockType name protocol schema source version


title: transcend.yml

description: Define personal data schema in code using Transcend.

required: title output-identifiers

type: number

required: name value

type: boolean

required: name type

enum: MULTI_SELECT SINGLE_SELECT TEXT EMAIL TELEPHONE URL ASSESSMENT

enum: actionItem dataSilo subDataPoint airgapCookie airgapDataFlow request vendor businessEntity dataSubCategory processingPurposeSubCategory

enum: EU AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BA BW BV BR IO VG BN BG BF BI KH CM CA CV BQ KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CW CY CZ DK DJ DM DO EC EG SV GQ ER EE SZ ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JE JO KZ KE KI KW KG LA LV LB LS LR LY LI LT LU MO MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL NC NZ NI NE NG NU NF KP MK MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW WS SM ST SA SN RS SC SL SG SX SK SI SB SO ZA GS KR SS ES LK BL SH KN LC MF PM VC SD SR SJ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UM VI UG UA AE GB US UY UZ VU VA VE VN WF EH YE ZM ZW

required: key values

enum: DISABLED AUTO FORM

enum: ESSENTIAL ADDITIONAL_FUNCTIONALITY ADVERTISING MARKETING ANALYTICS PERSONALIZATION OPERATION_SECURITY LEGAL TRANSFER SALE HR OTHER UNSPECIFIED

enum: FINANCIAL HEALTH CONTACT LOCATION DEMOGRAPHIC ID ONLINE_ACTIVITY USER_PROFILE SOCIAL_MEDIA CONNECTION TRACKING DEVICE SURVEY OTHER UNSPECIFIED NOT_PERSONAL_DATA

enum: QuickOptions QuickOptions3 AcceptAll AcceptAllRejectAllToggle AcceptAllOrMoreChoices AcceptOrRejectAll AcceptOrRejectAllOrMoreChoices AcceptOrRejectAnalytics AcceptOrRejectAdvertising NoticeAndDoNotSell DoNotSellExplainer PrivacyPolicyNotice CompleteOptions CompleteOptionsInverted Hidden

enum: om ab aa af sq am ar-DZ ar-BH ar-EG ar-IQ ar-JO ar-KW ar-LB ar-LY ar-MA ar-OM ar-QA ar-SA ar-SY ar-TN ar-AE ar-YE ar hy as ay az ba eu be bn dz bh bi br bg-BG bg my km ca zh-CN zh-HK zh-MO zh-SG zh-TW zh co hr-HR hr cs-CZ cs da-DK da div nl-BE nl-NL nl en-AU en-BZ en-CA en-IE en-JM en-NZ en-PH en-ZA en-CH en-TT en-GB en-US en-ZW us eo et et-EE fo fa fj fi-FI fi fr-BE fr-CA fr-FR fr-LU fr-MC fr-CH fr fy mk gd gl ka de-AT de-DE de-LI de-LU de-CH de el-GR el kl gn gu ha iw hi hu-HU hu is is-IS in ia ie ik ga ga-IE it-IT it-CH it ja jw kn ks kk rw ky rn kok ko ku kz lo la lv lv-LV ln lt-LT lt mg ms ml mt mt-MT mi mr mo mn na ne no nb nn no-NO nb-NO nn-NO oc or ps pl-PL pl pt-BR pt-PT pt-CH pt pa qu rm ro-MD ro-RO ro ru-MD ru sm sg sa sr sh st sn sd si ss sk sk-SK sl sl-SI so sb es-AR es-BO es-CL es-CO es-CR es-DO es-EC es-SV es-ES es-GT es-HN es-MX es-NI es-PA es-PY es-PE es-PR es-US es-UY es-VE es su sx sw sv-FI sv-SE sv gsw gsw-LI gsw-CH syr tl tg ta tt te th bo ti to ts tn tr tk tw uk ur uz vi vo cy wo xh yi yo zu

enum: Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmera Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville Africa/Bujumbura Africa/Cairo Africa/Casablanca Africa/Ceuta Africa/Conakry Africa/Dakar Africa/Dar_es_Salaam Africa/Djibouti Africa/Douala Africa/El_Aaiun Africa/Freetown Africa/Gaborone Africa/Harare Africa/Johannesburg Africa/Juba Africa/Kampala Africa/Khartoum Africa/Kigali Africa/Kinshasa Africa/Lagos Africa/Libreville Africa/Lome Africa/Luanda Africa/Lubumbashi Africa/Lusaka Africa/Malabo Africa/Maputo Africa/Maseru Africa/Mbabane Africa/Mogadishu Africa/Monrovia Africa/Nairobi Africa/Ndjamena Africa/Niamey Africa/Nouakchott Africa/Ouagadougou Africa/Porto-Novo Africa/Sao_Tome Africa/Tripoli Africa/Tunis Africa/Windhoek America/Adak America/Anchorage America/Anguilla America/Antigua America/Araguaina America/Argentina/La_Rioja America/Argentina/Rio_Gallegos America/Argentina/Salta America/Argentina/San_Juan America/Argentina/San_Luis America/Argentina/Tucuman America/Argentina/Ushuaia America/Aruba America/Asuncion America/Bahia America/Bahia_Banderas America/Barbados America/Belem America/Belize America/Blanc-Sablon America/Boa_Vista America/Bogota America/Boise America/Buenos_Aires America/Cambridge_Bay America/Campo_Grande America/Cancun America/Caracas America/Catamarca America/Cayenne America/Cayman America/Chicago America/Chihuahua America/Coral_Harbour America/Cordoba America/Costa_Rica America/Creston America/Cuiaba America/Curacao America/Danmarkshavn America/Dawson America/Dawson_Creek America/Denver America/Detroit America/Dominica America/Edmonton America/Eirunepe America/El_Salvador America/Fort_Nelson America/Fortaleza America/Glace_Bay America/Godthab America/Goose_Bay America/Grand_Turk America/Grenada America/Guadeloupe America/Guatemala America/Guayaquil America/Guyana America/Halifax America/Havana America/Hermosillo America/Indiana/Knox America/Indiana/Marengo America/Indiana/Petersburg America/Indiana/Tell_City America/Indiana/Vevay America/Indiana/Vincennes America/Indiana/Winamac America/Indianapolis America/Inuvik America/Iqaluit America/Jamaica America/Jujuy America/Juneau America/Kentucky/Monticello America/Kralendijk America/La_Paz America/Lima America/Los_Angeles America/Louisville America/Lower_Princes America/Maceio America/Managua America/Manaus America/Marigot America/Martinique America/Matamoros America/Mazatlan America/Mendoza America/Menominee America/Merida America/Metlakatla America/Mexico_City America/Miquelon America/Moncton America/Monterrey America/Montevideo America/Montreal America/Montserrat America/Nassau America/New_York America/Nipigon America/Nome America/Noronha America/North_Dakota/Beulah America/North_Dakota/Center America/North_Dakota/New_Salem America/Ojinaga America/Panama America/Pangnirtung America/Paramaribo America/Phoenix America/Port-au-Prince America/Port_of_Spain America/Porto_Velho America/Puerto_Rico America/Punta_Arenas America/Rainy_River America/Rankin_Inlet America/Recife America/Regina America/Resolute America/Rio_Branco America/Santa_Isabel America/Santarem America/Santiago America/Santo_Domingo America/Sao_Paulo America/Scoresbysund America/Sitka America/St_Barthelemy America/St_Johns America/St_Kitts America/St_Lucia America/St_Thomas America/St_Vincent America/Swift_Current America/Tegucigalpa America/Thule America/Thunder_Bay America/Tijuana America/Toronto America/Tortola America/Vancouver America/Whitehorse America/Winnipeg America/Yakutat America/Yellowknife Antarctica/Casey Antarctica/Davis Antarctica/DumontDUrville Antarctica/Macquarie Antarctica/Mawson Antarctica/McMurdo Antarctica/Palmer Antarctica/Rothera Antarctica/Syowa Antarctica/Troll Antarctica/Vostok Arctic/Longyearbyen Asia/Aden Asia/Almaty Asia/Amman Asia/Anadyr Asia/Aqtau Asia/Aqtobe Asia/Ashgabat Asia/Atyrau Asia/Baghdad Asia/Bahrain Asia/Baku Asia/Bangkok Asia/Barnaul Asia/Beirut Asia/Bishkek Asia/Brunei Asia/Calcutta Asia/Chita Asia/Choibalsan Asia/Colombo Asia/Damascus Asia/Dhaka Asia/Dili Asia/Dubai Asia/Dushanbe Asia/Famagusta Asia/Gaza Asia/Hebron Asia/Hong_Kong Asia/Hovd Asia/Irkutsk Asia/Jakarta Asia/Jayapura Asia/Jerusalem Asia/Kabul Asia/Kamchatka Asia/Karachi Asia/Katmandu Asia/Khandyga Asia/Krasnoyarsk Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait Asia/Macau Asia/Magadan Asia/Makassar Asia/Manila Asia/Muscat Asia/Nicosia Asia/Novokuznetsk Asia/Novosibirsk Asia/Omsk Asia/Oral Asia/Phnom_Penh Asia/Pontianak Asia/Pyongyang Asia/Qatar Asia/Qostanay Asia/Qyzylorda Asia/Rangoon Asia/Riyadh Asia/Saigon Asia/Sakhalin Asia/Samarkand Asia/Seoul Asia/Shanghai Asia/Singapore Asia/Srednekolymsk Asia/Taipei Asia/Tashkent Asia/Tbilisi Asia/Tehran Asia/Thimphu Asia/Tokyo Asia/Tomsk Asia/Ulaanbaatar Asia/Urumqi Asia/Ust-Nera Asia/Vientiane Asia/Vladivostok Asia/Yakutsk Asia/Yekaterinburg Asia/Yerevan Atlantic/Azores Atlantic/Bermuda Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faeroe Atlantic/Madeira Atlantic/Reykjavik Atlantic/South_Georgia Atlantic/St_Helena Atlantic/Stanley Australia/Adelaide Australia/Brisbane Australia/Broken_Hill Australia/Currie Australia/Darwin Australia/Eucla Australia/Hobart Australia/Lindeman Australia/Lord_Howe Australia/Melbourne Australia/Perth Australia/Sydney Europe/Amsterdam Europe/Andorra Europe/Astrakhan Europe/Athens Europe/Belgrade Europe/Berlin Europe/Bratislava Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Busingen Europe/Chisinau Europe/Copenhagen Europe/Dublin Europe/Gibraltar Europe/Guernsey Europe/Helsinki Europe/Isle_of_Man Europe/Istanbul Europe/Jersey Europe/Kaliningrad Europe/Kiev Europe/Kirov Europe/Lisbon Europe/Ljubljana Europe/London Europe/Luxembourg Europe/Madrid Europe/Malta Europe/Mariehamn Europe/Minsk Europe/Monaco Europe/Moscow Europe/Oslo Europe/Paris Europe/Podgorica Europe/Prague Europe/Riga Europe/Rome Europe/Samara Europe/San_Marino Europe/Sarajevo Europe/Saratov Europe/Simferopol Europe/Skopje Europe/Sofia Europe/Stockholm Europe/Tallinn Europe/Tirane Europe/Ulyanovsk Europe/Uzhgorod Europe/Vaduz Europe/Vatican Europe/Vienna Europe/Vilnius Europe/Volgograd Europe/Warsaw Europe/Zagreb Europe/Zaporozhye Europe/Zurich Indian/Antananarivo Indian/Chagos Indian/Christmas Indian/Cocos Indian/Comoro Indian/Kerguelen Indian/Mahe Indian/Maldives Indian/Mauritius Indian/Mayotte Indian/Reunion Pacific/Apia Pacific/Auckland Pacific/Bougainville Pacific/Chatham Pacific/Easter Pacific/Efate Pacific/Enderbury Pacific/Fakaofo Pacific/Fiji Pacific/Funafuti Pacific/Galapagos Pacific/Gambier Pacific/Guadalcanal Pacific/Guam Pacific/Honolulu Pacific/Johnston Pacific/Kiritimati Pacific/Kosrae Pacific/Kwajalein Pacific/Majuro Pacific/Marquesas Pacific/Midway Pacific/Nauru Pacific/Niue Pacific/Norfolk Pacific/Noumea Pacific/Pago_Pago Pacific/Palau Pacific/Pitcairn Pacific/Ponape Pacific/Port_Moresby Pacific/Rarotonga Pacific/Saipan Pacific/Tahiti Pacific/Tarawa Pacific/Tongatapu Pacific/Truk Pacific/Wake Pacific/Wallis


taurus.json

type: integer

enum: ab apiritif gatling grinder jmeter junit locust mocha molotov newman nunit pbench pytest rspec selenium siege tsung wdio

enum: final-stats console blazemeter junit-xml


vim-addon-info.json

format: uri

enum: hg git svn bzr

description: Info for the plugin itself. Describes where the canonical copy of the plugin can be fetched from.

$ref: #/definitions/repoType

$ref: #/definitions/url

description: For a deprecated plugin, a deprecation message to be shown to any user who installs the plugin.

description: Info about a plugin/repository outside this one.

$comment: Empty repository info. Used to declare plugin with the given name is required without specifying any explicit details about how to fetch it (e.g., if name can be looked up in a predefined package index).

$comment: Repository with empty type and url pointing to local path.

description: Script ID number of the target plugin on www.vim.org, if any.

enum:
color scheme
ftplugin
game
indent
syntax
utility
patch

$comment: Explicit remote repository.

description: Primary homepage of the plugin.

$comment: Addon information for the other plugin in case it does not supply its own addon-info file.

description: The name of the plugin. Used by plugin managers and some introspection tools. Generally corresponds to the name of the repository but without "vim" prefix/suffix.

examples: surround.vim nerdtree maktaba

description: Dotted version number of the plugin, generally in semantic versioning scheme.

description: Short description of the plugin and what it does (a sentence or two)

description: Primary homepage of the plugin.

description: Name of the person or organization that created the plugin

examples:
Priya Exampleton
Example Industries

description: Name of the person who maintains the plugin

$ref: #/definitions/selfRepository

description: Plugins that are strictly required for the plugin to work, where keys are plugin names and values may describe where plugins can be fetched from.

$ref: #/definitions/otherRepository

title: JSON schema for vim plugin addon-info.json metadata files


description: [Deprecated] Options that are passed to the compiler. Use 'buildOptions' instead.

enum: portable full none

description: Options that are passed to the compiler.

description: Set this option to preserve reference assemblies and other context data to allow for runtime compilation.

default: csc

description: Defines glob patterns and file path to include for compilation.

type: string array object

type: string array

description: List of file globbing patterns to be included.

description: List of file globbing patterns to be excluded.

description: List of file paths to be included.

description: List of file paths to be excluded.

description: Pairs of destination folders and glob patterns specifying additional files to include/exclude.

description: Defines glob patterns and file paths of resource files to include for compilation.

description: Defines glob patterns and file paths to include for copying to build output.

description: Enables/disables server garbage collection.

description: Enables/disables concurrent garbage collection.

description: Limits the number of heaps created by the garbage collector.

description: Specifies the exact processors that garbage collector threads should use.

description: Specifies the list of processors to use for garbage collector threads.

description: Specifies whether to affinitize garbage collection threads with processors. To affinitize a GC thread means that it can only run on its specific CPU. A heap is created for each GC thread.

description: Specifies the maximum commit size, in bytes, for the GC heap and GC bookkeeping.

description: Specifies the GC heap usage as a percentage of the total memory.

description: Configures whether segments that should be deleted are put on a standby list for future use or are released back to the operating system (OS).

description: Specifies the threshold size, in bytes, that causes objects to go on the large object heap (LOH).

description: Sets the minimum number of threads for the thread pool.

description: Sets the maximum number of threads for the thread pool.

description: Defines options pertaining to the packaging of the project output into a NuGet package.

description: A short description of the package.

description: List of owners of the package.

description: A link to the license for the package.

default: git

description: Defines glob patterns and file paths to include in the generated NuGet package.

description: Defines glob patterns and file paths to include in publish output.

$ref: #/definitions/dependencies

$ref: #/definitions/compilationOptions

$ref: #/definitions/buildOptions

description: Allow packages supporting these frameworks to be installed in this target, regardless of the compatibility rules.

enum: all runtime compile build contentFiles native analyzers none

$ref: #/definitions/libraryIncludeFlag

description: Restrict this dependency to matching only a Project or a Package.

description: Each dependency is defined by a name and a version. Dependencies are resolved from NuGet feeds defined by your package sources and projects located in the directories specified by the 'global.json' file.

description:
A command line script or scripts.

Available variables:
%project:Directory% - The project directory
%project:Name% - The project name
%project:Version% - The project version

description: The author of the application.

description: [Deprecated] Pairs of destination folders and glob patterns specifying additional files to include in the output NuGet package. (data type: JSON map). Example: { "tools/": "tools/**/*.*" }. Use 'files' in 'packOptions' instead.

description: [Deprecated] Glob pattern to specify files to exclude from publish output. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'publishOptions' instead.

description: [Deprecated] Glob pattern to specify files to compile. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'compile' in 'buildOptions' instead.

description: [Deprecated] Glob pattern to specify files to exclude from compilation. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'compile' in 'buildOptions' instead.

description: [Deprecated] Files to include in compilation (overrides 'compileExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]. Use 'compile' in 'buildOptions' instead.

description: [Deprecated] Glob pattern to specify files to include as content. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.

description: [Deprecated] Glob pattern to specify files to exclude from the content list. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.

description: [Deprecated] Files to include as content (overrides 'contentExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.

description: Glob pattern to specify files to use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to exclude from use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Files to include to use for preprocessing (overrides 'preprocessExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]

description: [Deprecated] Glob pattern to specify files to include as resources. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'embed' in 'buildOptions' instead.

description: [Deprecated] Glob pattern to specify files to exclude from the resources list. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'embed' in 'buildOptions' instead.

description: [Deprecated] Files to include as resources (overrides 'resourceExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]. Use 'embed' in 'buildOptions' instead.

description: Glob pattern to specify files to share with dependent projects. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to exclude from sharing with dependent projects. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Files to include for sharing with dependent projects (overrides 'sharedExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]

description: [Deprecated] Glob pattern to indicate files to exclude from other glob patterns, in addition to the default patterns specified in 'excludeBuiltIn'. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'exclude' within 'compile' or 'embed' instead.

description: [Deprecated] Default glob pattern to indicate files to exclude from other glob patterns. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'exclude' within 'compile' or 'embed' instead.

description: The name of the test runner to use with this project

description: Configurations are named groups of compilation settings. There are two defaults built into the runtime: 'Debug' and 'Release'.

description: Copyright details for the package.

description: [Deprecated] A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background. Use this in 'packOptions' instead.

description: [Deprecated] A link to the license for the package. Use this in 'packOptions' instead.

description: [Deprecated] A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed. Use this in 'packOptions' instead.

description: [Deprecated] List of owners of the package. Use this in 'packOptions' instead.

description: A URL for the home page of the package.

description: [Deprecated] A short description of the package. Use this in 'packOptions' instead.

description: [Deprecated] A space-delimited list of tags and keywords that describe the package. Use this in 'packOptions' instead.

description: The human-friendly title of the package

description: [Deprecated] A description of the changes made in each release of the package. Use this in 'packOptions' instead.

description: The locale ID for the package, such as en-us.

description: The description of the project/package.

description: Target frameworks that will be built, and dependencies that are specific to the build of this project for that framework.

description: Overrides the generated resource names with custom ones.

description: [Deprecated] Contains information about the repository where the project is stored. Use this in 'packOptions' instead.

description: Scripts to execute during the various stages.

description: The version of the project/package. Examples: 1.2.3, 1.2.3-beta, 1.2.3-*

description: Project-specific command line tools accessible when in the project.json directory.

description: List of runtime identifiers supported by this project (used when building standalone applications).

title: JSON schema for .NET Core project.json files


type: string object

default: default

enum: default build

description:
A command line script or scripts.

Available variables:
%project:Directory% - The project directory
%project:Name% - The project name
%project:Version% - The project version

description: List of files to exclude from publish output (dnu publish).

description: Glob pattern to specify additional code files that needs to be compiled. (data type: string or array with glob pattern(s)). Example: [ "folder1/**/*.cs", "folder2/**/*.cs" ]

description: Glob pattern to indicate code files that needs to be excluded from compilation. (data type: string or array with glob pattern(s)). Example: [ "folder1/**/*.cs", "folder2/**/*.cs" ]

description: Individual file paths relative to application root that needs to be included for compilation. (data type: string or array). Example: [ "folder1/test1.cs", "folder2/test2.cs" ]

description: Glob pattern to indicate the default code files that are included for compilation. (data type: string or array with glob pattern(s)). Example: [ "**/*.cs", "../folder2/**/*.cs" ]

description: Glob pattern to indicate the default files to be excluded from processing. (data type: string or array with glob pattern(s)).

description: Glob pattern to indicate all the additional files to be excluded from processing. (data type: string or array with glob pattern(s)).

description: Glob pattern to indicate all the code files to be pre-processed. (data type: string or array with glob pattern(s)).

description: Glob pattern to indicate all the code files to be excluded from pre-processing. (data type: string or array with glob pattern(s)).

description: Glob pattern to indicate specific code files to be included for pre-processing. (data type: string or array).

description: Glob pattern to indicate all the files that need to be compiled as resources. (data type: string or array with glob pattern(s))

description: Glob pattern to indicate files that need to be excluded from being compiled as resources. (data type: string or array with glob pattern(s))

description: Glob pattern to indicate individual files that need to be compiled as resources. (data type: string or array).

description: Glob pattern to specify the code files to share with dependent projects. Example: [ "folder1/*.cs", "folder2/*.cs" ]

description: Glob pattern to specify the code files to be excluded from sharing with dependent projects. Example: [ "folder1/*.cs", "folder2/*.cs" ]

description: Glob pattern to specify the individual code files to be shared with dependent projects. Example: [ "folder1/shared1.cs", "folder2/shared2.cs" ]

description: Glob pattern to specify the files to be considered as content on dnu publish. Example: [ "folder1/**/*" ]

description: Glob pattern to specify the files to be excluded from being content on dnu publish. Example: [ "folder1/*.cs", "folder2/*.cs" ]

description: Glob pattern to specify the individual files to be content files on dnu publish. Example: [ "folder1/content.cs", "folder2/content2.img" ]

description: Configurations are named groups of compilation settings. There are 2 defaults built into the runtime namely 'Debug' and 'Release'.

description: Copyright details for the package

description: The description of the application

$ref: #/definitions/configType

description: A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background.

description: A link to the license that the package is under

description: A URL for the home page of the package

description: A short description of the package

description: The human-friendly title of the package

description: The version of the application. Example: 1.2.0.0

description: Specifying the webroot property in the project.json file specifies the web server root (aka public folder). In visual studio, this folder will be used to root IIS. Static files should be put in here.

description: Specify a unique id to manage the development time user secrets of the application

title: JSON schema for ASP.NET project.json files


title: Configuration for the edgeHub module

required: schemaVersion routes

pattern: \$upstream

pattern: ^in$|^out$

$ref: #/definitions/policy

title: JSON schema for Azure IoT EdgeHub Deployment version 1.2


gpc.json

description: Configuration for GPC, so a site can convey its support for the Global Privacy Control.

title: Global Privacy Control

description: Indicates that the server intends to abide by GPC requests.

title: Version

title: Last Update

description: This indicates the time at which the statement of support was made, such that later changes to the meaning of the GPC standard should not affect the interpretation of the resource for legal purposes. If the member is not in a valid ISO 8601 format, the last update date and time is unknown.

title: Global Privacy Control


requirements.json

title: Name

title: Source

enum: galaxy url file git dir subdirs

title: Type

title: Version

title: CollectionModel

title: CollectionStringModel

title: Include

title: IncludeModel

$ref: #/$defs/CollectionModel

$ref: #/$defs/CollectionStringModel

title: Collections

$ref: #/$defs/RoleModel

title: Roles

title: Requirements v2

title: Name

title: Scm

title: Src

default: master

title: Version

title: Role

$ref: #/$defs/IncludeModel

title: Ansible Requirements Schema


pattern: ^(native|web|dotnet|hybrid)$

pattern: ^(test|debug|release)$

pattern: ^(llvm|gcc)$

pattern: ^(dotnet-cli|msbuild)$


$comment: JSON Schema for CRYENGINE 5.5

title: Variable name

description: CVar name

title: Command name

description: Console command name

$ref: #/definitions/cvars

title: Value of the CVar

description: The default value of the CVar

title: Assets folder

description: This indicates where the assets are stored

default: Assets

title: Code folder

description: This indicates where the code is stored

default: Code

title: Lib's name

title: Lib's name to import for all the supported platforms

title: Lib's name to import for the win_x64 platform

title: Lib's name to import for the win_x86 platform

title: Project name

description: This indicates the project name

title: Project GUID

title: Engine version

description: This indicates which engine version will be used

title: Plugin name

description: Required plugin's name

examples: CryDefaultEntities CrySensorSystem CryPerceptionSystem CryUserAnalytics CryOSVR CryOculusVR CryOpenVR CryLobby

title: Plugin type

description: EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one

title: This plugin will be used only by these platforms

enum: pc ps4 xboxone linux

required: path type

title: Project version

$ref: #/definitions/commands

title: Value of the command

description: Arguments that has to be passed to the command. Leave empty if it has not parameters

required: content info require version

title: CryProj schema


huskyrc.json

x-intellij-language-injection: Shell Script

description: Husky can prevent bad `git commit`, `git push` and more 🐶 woof!

title: Skipping Git hooks installation.

title: Git hooks.

$ref: #/definitions/hook

description:
This hook is invoked by git-am. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes git am to abort before applying the patch.

The hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.

The default applypatch-msg hook, when enabled, runs the commit-msg hook, if the latter is enabled.

markdownDescription:
This hook is invoked by [git-am](https://git-scm.com/docs/git-am). It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes `git am` to abort before applying the patch.

The hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.

The default **applypatch-msg** hook, when enabled, runs the **commit-msg** hook, if the latter is enabled.

description:
This hook is invoked by git-am. It takes no parameter, and is invoked after the patch is applied, but before a commit is made.

If it exits with non-zero status, then the working tree will not be committed after applying the patch.

It can be used to inspect the current working tree and refuse to make a commit if it does not pass certain test.

The default pre-applypatch hook, when enabled, runs the pre-commit hook, if the latter is enabled.

markdownDescription:
This hook is invoked by [git-am](https://git-scm.com/docs/git-am). It takes no parameter, and is invoked after the patch is applied, but before a commit is made.

If it exits with non-zero status, then the working tree will not be committed after applying the patch.

It can be used to inspect the current working tree and refuse to make a commit if it does not pass certain test.

The default **pre-applypatch** hook, when enabled, runs the **pre-commit** hook, if the latter is enabled.

description:
This hook is invoked by git-am. It takes no parameter, and is invoked after the patch is applied and a commit is made.

This hook is meant primarily for notification, and cannot affect the outcome of git am.

markdownDescription:
This hook is invoked by [git-am](https://git-scm.com/docs/git-am). It takes no parameter, and is invoked after the patch is applied and a commit is made.

This hook is meant primarily for notification, and cannot affect the outcome of `git am`.

description:
This hook is invoked by git-commit, and can be bypassed with the --no-verify option. It takes no parameters, and is invoked before obtaining the proposed commit log message and making a commit. Exiting with a non-zero status from this script causes the git commit command to abort before creating a commit.

The default pre-commit hook, when enabled, catches introduction of lines with trailing whitespaces and aborts the commit when such a line is found.

All the git commit hooks are invoked with the environment variable GIT_EDITOR=: if the command will not bring up an editor to modify the commit message.

The default pre-commit hook, when enabled—and with the hooks.allownonascii config option unset or set to false—prevents the use of non-ASCII filenames.

markdownDescription:
This hook is invoked by [git-commit](https://git-scm.com/docs/git-commit), and can be bypassed with the `--no-verify` option. It takes no parameters, and is invoked before obtaining the proposed commit log message and making a commit. Exiting with a non-zero status from this script causes the `git commit` command to abort before creating a commit.

The default **pre-commit** hook, when enabled, catches introduction of lines with trailing whitespaces and aborts the commit when such a line is found.

All the `git commit` hooks are invoked with the environment variable `GIT_EDITOR=:` if the command will not bring up an editor to modify the commit message.

The default **pre-commit** hook, when enabled—and with the `hooks.allownonascii` config option unset or set to false—prevents the use of non-ASCII filenames.

description:
This hook is invoked by git-commit right after preparing the default log message, and before the editor is started.

It takes one to three parameters. The first is the name of the file that contains the commit log message. The second is the source of the commit message, and can be: message (if a -m or -F option was given); template (if a -t option was given or the configuration option commit.template is set); merge (if the commit is a merge or a .git/MERGE_MSG file exists); squash (if a .git/SQUASH_MSG file exists); or commit, followed by a commit SHA-1 (if a -c, -C or --amend option was given).

If the exit status is non-zero, git commit will abort.

The purpose of the hook is to edit the message file in place, and it is not suppressed by the --no-verify option. A non-zero exit means a failure of the hook and aborts the commit. It should not be used as replacement for pre-commit hook.

The sample prepare-commit-msg hook that comes with Git removes the help message found in the commented portion of the commit template.

markdownDescription:
This hook is invoked by [git-commit](https://git-scm.com/docs/git-commit) right after preparing the default log message, and before the editor is started.

It takes one to three parameters. The first is the name of the file that contains the commit log message. The second is the source of the commit message, and can be: `message` (if a `-m` or `-F` option was given); `template` (if a `-t` option was given or the configuration option `commit.template` is set); `merge` (if the commit is a merge or a `.git/MERGE_MSG` file exists); `squash` (if a `.git/SQUASH_MSG` file exists); or `commit`, followed by a commit SHA-1 (if a `-c`, `-C` or `--amend` option was given).

If the exit status is non-zero, `git commit` will abort.

The purpose of the hook is to edit the message file in place, and it is not suppressed by the `--no-verify` option. A non-zero exit means a failure of the hook and aborts the commit. It should not be used as replacement for pre-commit hook.

The sample `prepare-commit-msg` hook that comes with Git removes the help message found in the commented portion of the commit template.

description:
This hook is invoked by git-commit and git-merge, and can be bypassed with the --no-verify option. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes the command to abort.

The hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.

The default commit-msg hook, when enabled, detects duplicate "Signed-off-by" lines, and aborts the commit if one is found.

markdownDescription:
This hook is invoked by [git-commit](https://git-scm.com/docs/git-commit) and [git-merge](https://git-scm.com/docs/git-merge), and can be bypassed with the `--no-verify` option. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes the command to abort.

The hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.

The default **commit-msg** hook, when enabled, detects duplicate "Signed-off-by" lines, and aborts the commit if one is found.

description:
This hook is invoked by git-commit. It takes no parameters, and is invoked after a commit is made.

This hook is meant primarily for notification, and cannot affect the outcome of git commit.

markdownDescription:
This hook is invoked by [git-commit](https://git-scm.com/docs/git-commit). It takes no parameters, and is invoked after a commit is made.

This hook is meant primarily for notification, and cannot affect the outcome of `git commit`.

description: This hook is called by git-rebase and can be used to prevent a branch from getting rebased. The hook may be called with one or two parameters. The first parameter is the upstream from which the series was forked. The second parameter is the branch being rebased, and is not set when rebasing the current branch.

markdownDescription: This hook is called by [git-rebase](https://git-scm.com/docs/git-rebase) and can be used to prevent a branch from getting rebased. The hook may be called with one or two parameters. The first parameter is the upstream from which the series was forked. The second parameter is the branch being rebased, and is not set when rebasing the current branch.

description:
This hook is invoked when a git-checkout or git-switch is run after having updated the worktree. The hook is given three parameters: the ref of the previous HEAD, the ref of the new HEAD (which may or may not have changed), and a flag indicating whether the checkout was a branch checkout (changing branches, flag=1) or a file checkout (retrieving a file from the index, flag=0). This hook cannot affect the outcome of git switch or git checkout.

It is also run after git-clone, unless the --no-checkout (-n) option is used. The first parameter given to the hook is the null-ref, the second the ref of the new HEAD and the flag is always 1. Likewise for git worktree add unless --no-checkout is used.

This hook can be used to perform repository validity checks, auto-display differences from the previous HEAD if different, or set working dir metadata properties.

markdownDescription:
This hook is invoked when a [git-checkout](https://git-scm.com/docs/git-checkout) or [git-switch](https://git-scm.com/docs/git-switch) is run after having updated the worktree. The hook is given three parameters: the ref of the previous HEAD, the ref of the new HEAD (which may or may not have changed), and a flag indicating whether the checkout was a branch checkout (changing branches, flag=1) or a file checkout (retrieving a file from the index, flag=0). This hook cannot affect the outcome of `git switch` or `git checkout`.

It is also run after [git-clone](https://git-scm.com/docs/git-clone), unless the `--no-checkout` (`-n`) option is used. The first parameter given to the hook is the null-ref, the second the ref of the new HEAD and the flag is always 1. Likewise for `git worktree add` unless `--no-checkout` is used.

This hook can be used to perform repository validity checks, auto-display differences from the previous HEAD if different, or set working dir metadata properties.

description:
This hook is invoked by git-merge, which happens when a git pull is done on a local repository. The hook takes a single parameter, a status flag specifying whether or not the merge being done was a squash merge. This hook cannot affect the outcome of git merge and is not executed, if the merge failed due to conflicts.

This hook can be used in conjunction with a corresponding pre-commit hook to save and restore any form of metadata associated with the working tree (e.g.: permissions/ownership, ACLS, etc). See contrib/hooks/setgitperms.perl for an example of how to do this.

markdownDescription:
This hook is invoked by [git-merge](https://git-scm.com/docs/git-merge), which happens when a `git pull` is done on a local repository. The hook takes a single parameter, a status flag specifying whether or not the merge being done was a squash merge. This hook cannot affect the outcome of `git merge` and is not executed, if the merge failed due to conflicts.

This hook can be used in conjunction with a corresponding pre-commit hook to save and restore any form of metadata associated with the working tree (e.g.: permissions/ownership, ACLS, etc). See contrib/hooks/setgitperms.perl for an example of how to do this.

description:
This hook is called by git-push and can be used to prevent a push from taking place. The hook is called with two parameters which provide the name and location of the destination remote, if a named remote is not being used both values will be the same.

Information about what is to be pushed is provided on the hook's standard input with lines of the form:

<local ref> SP <local sha1> SP <remote ref> SP <remote sha1> LF
For instance, if the command git push origin master:foreign were run the hook would receive a line like the following:

refs/heads/master 67890 refs/heads/foreign 12345
although the full, 40-character SHA-1s would be supplied. If the foreign ref does not yet exist the <remote SHA-1> will be 40 0. If a ref is to be deleted, the <local ref> will be supplied as (delete) and the <local SHA-1> will be 40 0. If the local commit was specified by something other than a name which could be expanded (such as HEAD~, or a SHA-1) it will be supplied as it was originally given.

If this hook exits with a non-zero status, git push will abort without pushing anything. Information about why the push is rejected may be sent to the user by writing to standard error.

markdownDescription:
This hook is called by [git-push](https://git-scm.com/docs/git-push) and can be used to prevent a push from taking place. The hook is called with two parameters which provide the name and location of the destination remote, if a named remote is not being used both values will be the same.

Information about what is to be pushed is provided on the hook's standard input with lines of the form:
```
<local ref> SP <local sha1> SP <remote ref> SP <remote sha1> LF
```
For instance, if the command `git push origin master:foreign` were run the hook would receive a line like the following:
```
refs/heads/master 67890 refs/heads/foreign 12345
```
although the full, 40-character SHA-1s would be supplied. If the foreign ref does not yet exist the `<remote SHA-1>` will be 40 `0`. If a ref is to be deleted, the `<local ref>` will be supplied as `(delete)` and the `<local SHA-1>` will be 40 `0`. If the local commit was specified by something other than a name which could be expanded (such as `HEAD~`, or a SHA-1) it will be supplied as it was originally given.

If this hook exits with a non-zero status, `git push` will abort without pushing anything. Information about why the push is rejected may be sent to the user by writing to standard error.

description:
This hook is invoked by git-receive-pack when it reacts to git push and updates reference(s) in its repository. It executes on the remote repository once after all the refs have been updated.

It takes a variable number of parameters, each of which is the name of ref that was actually updated.

This hook is meant primarily for notification, and cannot affect the outcome of git receive-pack.

The post-update hook can tell what are the heads that were pushed, but it does not know what their original and updated values are, so it is a poor place to do log old..new. The post-receive hook does get both original and updated values of the refs. You might consider it instead if you need them.

When enabled, the default post-update hook runs git update-server-info to keep the information used by dumb transports (e.g., HTTP) up to date. If you are publishing a Git repository that is accessible via HTTP, you should probably enable this hook.

Both standard output and standard error output are forwarded to git send-pack on the other end, so you can simply echo messages for the user.

markdownDescription:
This hook is invoked by [git-receive-pack](https://git-scm.com/docs/git-receive-pack) when it reacts to `git push` and updates reference(s) in its repository. It executes on the remote repository once after all the refs have been updated.

It takes a variable number of parameters, each of which is the name of ref that was actually updated.

This hook is meant primarily for notification, and cannot affect the outcome of `git receive-pack`.

The **post-update** hook can tell what are the heads that were pushed, but it does not know what their original and updated values are, so it is a poor place to do log old..new. The **post-receive** hook does get both original and updated values of the refs. You might consider it instead if you need them.

When enabled, the default **post-update** hook runs `git update-server-info` to keep the information used by dumb transports (e.g., HTTP) up to date. If you are publishing a Git repository that is accessible via HTTP, you should probably enable this hook.

Both standard output and standard error output are forwarded to `git send-pack` on the other end, so you can simply `echo` messages for the user.

description:
This hook is invoked by git-receive-pack when it reacts to git push and updates reference(s) in its repository, and when the push tries to update the branch that is currently checked out and the receive.denyCurrentBranch configuration variable is set to updateInstead. Such a push by default is refused if the working tree and the index of the remote repository has any difference from the currently checked out commit; when both the working tree and the index match the current commit, they are updated to match the newly pushed tip of the branch. This hook is to be used to override the default behaviour.

The hook receives the commit with which the tip of the current branch is going to be updated. It can exit with a non-zero status to refuse the push (when it does so, it must not modify the index or the working tree). Or it can make any necessary changes to the working tree and to the index to bring them to the desired state when the tip of the current branch is updated to the new commit, and exit with a zero status.

For example, the hook can simply run git read-tree -u -m HEAD "$1" in order to emulate git fetch that is run in the reverse direction with git push, as the two-tree form of git read-tree -u -m is essentially the same as git switch or git checkout that switches branches while keeping the local changes in the working tree that do not interfere with the difference between the branches.

markdownDescription:
This hook is invoked by [git-receive-pack](https://git-scm.com/docs/git-receive-pack) when it reacts to `git push` and updates reference(s) in its repository, and when the push tries to update the branch that is currently checked out and the `receive.denyCurrentBranch` configuration variable is set to `updateInstead`. Such a push by default is refused if the working tree and the index of the remote repository has any difference from the currently checked out commit; when both the working tree and the index match the current commit, they are updated to match the newly pushed tip of the branch. This hook is to be used to override the default behaviour.

The hook receives the commit with which the tip of the current branch is going to be updated. It can exit with a non-zero status to refuse the push (when it does so, it must not modify the index or the working tree). Or it can make any necessary changes to the working tree and to the index to bring them to the desired state when the tip of the current branch is updated to the new commit, and exit with a zero status.

For example, the hook can simply run `git read-tree -u -m HEAD "$1"` in order to emulate `git fetch` that is run in the reverse direction with `git push`, as the two-tree form of `git read-tree -u -m` is essentially the same as `git switch` or `git checkout` that switches branches while keeping the local changes in the working tree that do not interfere with the difference between the branches.

description: This hook is invoked by git gc --auto (see git-gc). It takes no parameter, and exiting with non-zero status from this script causes the git gc --auto to abort.

markdownDescription: This hook is invoked by `git gc --auto` (see [git-gc](https://git-scm.com/docs/git-gc)). It takes no parameter, and exiting with non-zero status from this script causes the `git gc --auto` to abort.

description:
This hook is invoked by commands that rewrite commits (git-commit when called with --amend and git-rebase; however, full-history (re)writing tools like git-fast-import or git-filter-repo typically do not call it!). Its first argument denotes the command it was invoked by: currently one of amend or rebase. Further command-dependent arguments may be passed in the future.

The hook receives a list of the rewritten commits on stdin, in the format

<old-sha1> SP <new-sha1> [ SP <extra-info> ] LF
The extra-info is again command-dependent. If it is empty, the preceding SP is also omitted. Currently, no commands pass any extra-info.

The hook always runs after the automatic note copying (see "notes.rewrite.<command>" in git-config) has happened, and thus has access to these notes.

The following command-specific comments apply:

rebase
For the squash and fixup operation, all commits that were squashed are listed as being rewritten to the squashed commit. This means that there will be several lines sharing the same new-sha1.

The commits are guaranteed to be listed in the order that they were processed by rebase.

markdownDescription:
This hook is invoked by commands that rewrite commits ([git-commit](https://git-scm.com/docs/git-commit) when called with `--amend` and [git-rebase](https://git-scm.com/docs/git-rebase); however, full-history (re)writing tools like [git-fast-import](https://git-scm.com/docs/git-fast-import) or [git-filter-repo](https://github.com/newren/git-filter-repo) typically do not call it!). Its first argument denotes the command it was invoked by: currently one of `amend` or `rebase`. Further command-dependent arguments may be passed in the future.

The hook receives a list of the rewritten commits on stdin, in the format
```
<old-sha1> SP <new-sha1> [ SP <extra-info> ] LF
```
The **extra-info** is again command-dependent. If it is empty, the preceding SP is also omitted. Currently, no commands pass any **extra-info**.

The hook always runs after the automatic note copying (see "notes.rewrite.\<command\>" in [git-config](https://git-scm.com/docs/git-config)) has happened, and thus has access to these notes.

The following command-specific comments apply:

**rebase**
For the **squash** and **fixup** operation, all commits that were squashed are listed as being rewritten to the squashed commit. This means that there will be several lines sharing the same **new-sha1**.
The commits are guaranteed to be listed in the order that they were processed by rebase.

description: This hook is invoked by git-send-email. It takes a single parameter, the name of the file that holds the e-mail to be sent. Exiting with a non-zero status causes git send-email to abort before sending any e-mails.

markdownDescription: This hook is invoked by [git-send-email](https://git-scm.com/docs/git-send-email). It takes a single parameter, the name of the file that holds the e-mail to be sent. Exiting with a non-zero status causes `git send-email` to abort before sending any e-mails.

description:
This hook is invoked when the configuration option core.fsmonitor is set to .git/hooks/fsmonitor-watchman. It takes two arguments, a version (currently 1) and the time in elapsed nanoseconds since midnight, January 1, 1970.

The hook should output to stdout the list of all files in the working directory that may have changed since the requested time. The logic should be inclusive so that it does not miss any potential changes. The paths should be relative to the root of the working directory and be separated by a single NUL.

It is OK to include files which have not actually changed. All changes including newly-created and deleted files should be included. When files are renamed, both the old and the new name should be included.

Git will limit what files it checks for changes as well as which directories are checked for untracked files based on the path names given.

An optimized way to tell git "all files have changed" is to return the filename /.

The exit status determines whether git will use the data from the hook to limit its search. On error, it will fall back to verifying all files and folders.

x-intellij-html-description:
This hook is invoked when the configuration option core.fsmonitor is set to .git/hooks/fsmonitor-watchman or .git/hooks/fsmonitor-watchmanv2 depending on the version of the hook to use.

Version 1 takes two arguments, a version (1) and the time in elapsed nanoseconds since midnight, January 1, 1970.

Version 2 takes two arguments, a version (2) and a token that is used for identifying changes since the token. For watchman this would be a clock id. This version must output to stdout the new token followed by a NUL before the list of files.

The hook should output to stdout the list of all files in the working directory that may have changed since the requested time. The logic should be inclusive so that it does not miss any potential changes. The paths should be relative to the root of the working directory and be separated by a single NUL.

It is OK to include files which have not actually changed. All changes including newly-created and deleted files should be included. When files are renamed, both the old and the new name should be included.

Git will limit what files it checks for changes as well as which directories are checked for untracked files based on the path names given.

An optimized way to tell git "all files have changed" is to return the filename /.

The exit status determines whether git will use the data from the hook to limit its search. On error, it will fall back to verifying all files and folders.

markdownDescription:
This hook is invoked when the configuration option `core.fsmonitor` is set to `.git/hooks/fsmonitor-watchman`. It takes two arguments, a version (currently 1) and the time in elapsed nanoseconds since midnight, January 1, 1970.

The hook should output to stdout the list of all files in the working directory that may have changed since the requested time. The logic should be inclusive so that it does not miss any potential changes. The paths should be relative to the root of the working directory and be separated by a single NUL.

It is OK to include files which have not actually changed. All changes including newly-created and deleted files should be included. When files are renamed, both the old and the new name should be included.

Git will limit what files it checks for changes as well as which directories are checked for untracked files based on the path names given.

An optimized way to tell git "all files have changed" is to return the filename `/`.

The exit status determines whether git will use the data from the hook to limit its search. On error, it will fall back to verifying all files and folders.

description: This hook is invoked by git-p4 submit. It takes no parameters and nothing from standard input. Exiting with non-zero status from this script prevent git-p4 submit from launching. Run git-p4 submit --help for details.

markdownDescription: This hook is invoked by `git-p4 submit`. It takes no parameters and nothing from standard input. Exiting with non-zero status from this script prevent `git-p4 submit` from launching. Run `git-p4 submit --help` for details.

title: Husky configuration.


settings.job.json

description: The graceful shutdown period for an Azure Webjob. The time specified in seconds.

description: Specify if the Webjob should be treated as a singleton. If true, the Webjob will not scale on multiple Azure Website instances like the web application itself.

title: JSON schema for Azure Webjob settings.job files


ops.schema.json

title: ops.yaml

description: Confirguration for `ops`


apibuilder.json

title: API documentation

description: Specifies the version of the API Builder specification that this file is written for. The latest version can be found by visiting /apicollective/apibuilder-spec.

title: contact information

description: Specifies contact information for this service.

$ref: #/definitions/contact

description: Specifies the license under which this service is released.

$ref: #/definitions/license

title: contact information

description: Specifies contact information for this service

description: Identifying name of the contact person/organization

description: URL pointing to the contact information

description: Email address of the contact person/organization

title: license

description: specifies the license under which this service is released

description: Name of the license - e.g. MIT

description: URL of the license itself

title: import

description: The complete URI to the service specification that we are importing. Within API Builder, you can find the URL to the service specification by clicking on the "service.json" link for a service.

title: header

description: The name of the header.

description: The type of this header. Acceptable values are either the name of an enum or string. To specify a collection (meaning multiple values for this header can be provided), the type name can be wrapped with "[]". For example, to specify that the type is a collection of strings, use "[string]".

description: boolean: true|false. By default, all headers are considered required. To make a parameter optional, set "required" to false.

description: The default value for this header. If specified, generated clients will automatically include this header in all requests. Default values must be specified as strings.

description: Optional description for what this header provides. Supports GFM.

description: JSON Array defining additional meta data about this header for use by generators.

$ref: #/definitions/attribute

$ref: #/definitions/deprecation

title: annotation

title: annotation

description: An annotation is just a short key that can be used to tag any field in any model of this API.

description: Describes what the annotation is used for.

title: attribute

description: the name and identifier of the attribute.

title: json object

description: a JSON object that is usually utilized by a downstream Generator.

title: json object

description: JSON Object that indicates that this object is deprecated.

description: Optional, but recommended to contain notes for what the user is supposed to do now that this property is deprecated. Supports GFM.

title: enumeration

title: name

description: The name of the enum. Names must be alphanumeric and must start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, models, or unions types.

description: Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural.

description: Optional longer description for this enum.

description: JSON Array of EnumValue objects. Each element defines a valid value and an optional description.

$ref: #/definitions/enumvalues

description: JSON Array defining additional meta data about this enum for use by generators.

title: evaluates

description: The name of the value. Names must start with a letter.

description: The actual string representation of this value when serializing. If not specified, defaults to 'name'.

description: Optional description for what this enum value provides. Supports GFM.

description: JSON Array defining additional meta data about this enum value for use by generators.

title: interface

title: name

description: Name specifies the name of the interface. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, or models. Note you may define an interface and a union of the same name.

description: Optional description for what this model provides. Supports GFM.

description: JSON Array of 0 or more Fields.

$ref: #/definitions/field

description: JSON Array defining additional meta data about this model for use by generators.

title: field

description: Specifies the name of the field. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters.

description: Specifies the type of this field. 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).

description: Optional description for what this field provides. Supports GFM.

description: By default, all fields are considered required. To make a field optional, set "required" to false. When a field is marked as required, it must be present in any form of a model for that form to be valid. In client-server scenario, this means that any defaults that are present in the model must be applied by the client. If you want a default to be applied by the receiver, you should mark the field as "required": false

description: Optional default value. The value must be valid for the type specified for this field. For example, if you specify a field named 'limit' with type 'integer', an acceptable default would be 10.

description: Optional - an example value for this field used only in the produced documentation

description: 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.

description: 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.

description: JSON Array defining additional meta data about this field for use by generators.

description: JSON Array of type string where each value indicates the name of a declared annotation (optional),

title: model

description: specifies the name of the model. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, models, or unions types.

title: model

description: Description for what this model provides.

description: JSON Array of type string where each value indicates the name of a declared interface

title: union

description: Name specifies the name of the interface. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, unions, or models. Note you may define an interface and a union of the same name, but in this case it is required to list that interface in the interfaces field.

description: Specifies an optional, but recommended, name for a type discriminator field which can then be used in serialization / deserialization to identify the type of object. For example, if not specified, a code generator may serialize the union type into a JSON structure of { "type" => object }. If a discriminator is provided, the same code generator can flatten the JSON representation to, for example: { "discriminator" => "xxx", "field1" => "yyy" }. If provided, the name of the discriminator field must be unique across all of the fields across all of the types of this union.

description: Optional description for what this union provides. Supports GFM.

description: Specifies the individual types that are part of this union type.

$ref: #/definitions/uniontype

description: JSON Array defining additional meta data about this union for use by generators.

title: union type

description:
Specifies the type to include in this union type. Acceptable values include the name of either an enum, a model, or a (primitive type).
description optional description for what this type provides. Supports GFM.

description: If true, indicates that this type should be used as the default when deserializing union types. This field is only used by union types that require a discriminator and sets the default value for that discriminator during deserialization.

description: The discriminator value defines the string to use in the discriminator field to identify this type. If not specified, the discriminator value will default to the name of the type itself.

description: JSON Array defining additional meta data about this union type for use by generators.

title: resource

title: name

description: The name of the model or enum that this resource represents

description: Optional path where this resource is located. If not provided, defaults to the plural of the typeName, with some assumptions of formatting for web (e.g. lower case, dash separated). Path parameters can be specified by prefixing a path element with ':'. For example, a path of '/:guid' would imply that all operations for this path will require a parameter named 'guid' of type 'string'

description: Optional description for what this resource provides. Supports GFM.

description: One or more operations is required.

description: JSON Array defining additional meta data about this resource for use by generators.

title: operation

description: The HTTP method for this operation

description: Optional path for this particular operation. If not provided, defaults to no additional path. Path parameters can be specified by prefixing a path element with ':'. For example, a path of '/:guid' would imply that this operation is available at /resource_path/:guid. Path parameter types are inferred by looking for a field with that name on the model associated with this resource. If not found, the datatype of any path parameter will be string.

description: Optional description for what this operation provides. Supports GFM.

description: Optional specification for the type of the body of this request. For all operations that support bodies (e.g. POST, PUT, PATCH), allows you to specify the type of the body.

description: Optional JSON Array of the parameters to this method. By default, for GET methods, parameters are assumed to be in the path or in the query. For other methods, parameters are assumed to be in the path or form body, unless you have explicitly specified a body in which case parameters can be provided in the path or the query.

description: Optional JSON Object of HTTP Response Code to Response. If not provided, an HTTP NoContent response is assumed. Only responses for HTTP status codes that are interesting should be documented.

description: JSON array defining additional meta data about this operation for use by generators.

title: parameter

description: The name of the parameter. Names must be alphanumeric and must start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters.

description: Specifies the type of this parameter. 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).

description: One of: path, query, form, header. Defines the location of this parameter. Default location varies based on the context of the parameter (e.g. if the operation method is a POST, the default will be Form; if a GET, the default will be Query)

description: Optional description for what this parameter provides. Supports GFM.

description: By default all parameters are considered required. To make a parameter optional, set "required" to false.

description: Optional default value. The value must be valid for the type specified for this parameter. For example, if you specify a parameter named 'limit' with type 'integer', an acceptable default would be 10

description: Optional - an example value for this parameter used only in the produced documentation

description: JSON array defining additional meta data about this parameter for use by generators.

title: response

title: HTTP status

description:
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.

description: 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).

description: Optional description for what this response provides. Supports GFM.

description: 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.

title: body

description: 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).

description: Optional description for what this body provides. Supports GFM.

description: JSON Array defining additional meta data about this body for use by generators.

description: JSON Schema for API Builder's api.json format from https://app.apibuilder.io/doc/apiJson

description: A JSON schema URL

description: The human readable name of this service. Used for display, and as the basis for generating a unique key for URL.

description: 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.

description: Optionally specify additional metadata about this service (e.g. contact info, license).

description: 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.

description: The base URL where this service is hosted. Must start with http.

description: optional description for what this service provides. Supports GFM.

description: JSON Array defining any other services whose schema definitions we would like to import into our service.

description: JSON Array defining any HTTP Headers that the service understands or expects.

description: JSON object defining all of the enums in this API. The key of each object is the enum name.

description: JSON object defining all of the models in this API. The key of each object is the model name.

description: 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.

description: JSON object defining all of the annotations in this API. The key of each object is the annotation name.

title: API Builder Schema


title: ExampleUseCase

description: Use case base class

title: Name

title: Description

title: Code

title: Tactics

enum:
Reconnaissance
Resource Development
Initial Access
Execution
Persistence
Privilege Escalation
Defense Evasion
Credential Access
Discovery
Lateral Movement
Collection
Exfiltration
Command and Control
Impact

title: Tags

required: name description

title: Detection

description: Detection base class

title: Name

title: Url

required: name url

title: Resource

description: External reference base class

title: Name

title: Url

description: LOOBin base class

title: Name

description: Name of the LOOBin

title: Author

description: Author of the LOOBin

title: Short Description

description: A short description of the LOOBin.This will display in the LOOBin card list and the LOOBins website search results.

title: Full Description

description: A full description of the LOOBin.This will display on the LOOBin's single page.

title: Created

description: Date the LOOBin was created

format: date

title: Example Use Cases

description: A list of example use cases for the LOOBin

$ref: #/definitions/ExampleUseCase

title: Paths

description: A list of paths to the LOOBin

title: Detections

description: A list of detections for the LOOBin

$ref: #/definitions/Detection

title: Resource

description: A list of useful resources for the LOOBin

$ref: #/definitions/Resource

title: Acknowledgements

description: Acknowledgements for the LOOBin

title: LOOBin


commands.json

description: The friendly name of the command.

description: The name of the executable file name. Example: "cmd.exe".

description: Specify a relative or absolute directory path.

description: The arguments to pass to the executable file.

description: A Visual Studio event that a command can be bound to.

description: Schema for bundleconfig.json files

description: A list of commands.

description: Specify any Visual Studio event bindings.

$ref: #/definitions/vsbindings


babelrc.json

$ref: #/definitions/Options

description: 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"

description: Include the AST in the returned object

description: Attach a comment after all non-user injected code.

description: Attach a comment before all non-user injected code.

description: Enable code generation

description: Output comments in generated output.

description: 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

default: auto

description: A path to a .babelrc file to extend

description: Filename for use in errors etc.

default: unknown

description: Filename relative to sourceRoot (defaults to "filename")

description: ANSI highlight syntax error code frames

description: Opposite of the "only" option

description: 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

description: Keep extensions in module ids

description: Specify a custom name for module ids.

description: If truthy, insert an explicit id for modules. By default, all modules are anonymous. (Not available for common modules)

description: Optional prefix for the AMD module formatter that will be prepend to the filename on module definitions. (defaults to "sourceRoot")

description: 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.

description: List of plugins to load and use

description: The name of the plugin.

description: The options of the plugin.

description: List of presets (a set of plugins) to load and use

description: The name of the preset.

description: The options of the preset.

description: 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.

description: Set sources[0] on returned source map. (defaults to "filenameRelative")

description: 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.

description: Set file on returned source map. (defaults to "filenameRelative")

description: The root from which all sources are relative. (defaults to "moduleRoot")

title: JSON schema for Babel 6+ configuration files