schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
statamic.blueprint.schema.json
html
Store whatever HTML you want — it's up to you.
{"type": ["string"]}
statamic.blueprint.schema.json
import
Importing Fieldsets. They serve to create reusable sets of fields, just like v2.
{"type": "string"}
statamic.blueprint.schema.json
integer
The integer fieldtype is a text-style input that only accepts integers (numbers) and has increment and decrement controls.
{"type": "object", "properties": {"type": {"const": "integer"}, "default": {"type": ["string", "integer"]}}, "additionalProperties": true}
statamic.blueprint.schema.json
link
For when you want to create a link to a URL or entry, this fieldtype is here for you.
{"type": "object", "properties": {"type": {"const": "link"}, "collections": {"type": "array"}}, "additionalProperties": true}
statamic.blueprint.schema.json
list
For when you want to manage a simple YAML list, this fieldtype is here for you.
{"type": "object", "properties": {"type": {"const": "list"}, "default": {"type": "array"}}, "additionalProperties": true}
statamic.blueprint.schema.json
markdown
Write Markdown with the help of formatting buttons, assets integration, fullscreen mode, a Markdown cheatsheet, and HTML preview mode.
{"type": "object", "properties": {"type": {"const": "markdown"}, "container": {"type": "string"}, "restrict": {"type": "boolean", "default": false}, "automatic_line_breaks": {"type": "boolean", "default": true}, "automatic_links": {"type": "boolean", "default": false}, "escape_markup": {"type": "boolean", "default": false}, "smartypants": {"type": "boolean", "default": false}, "antlers": {}, "default": {"type": "string"}}, "additionalProperties": true}
statamic.blueprint.schema.json
container
Set the name of an asset container to enable browsing, uploading, and inserting assets.
{"type": "string"}
statamic.blueprint.schema.json
restrict
If true, navigation within the asset browser will be disabled. Your users will be restricted to specified the container and folder. Default: false.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
automatic_line_breaks
Automatically convert line breaks to <br> tags. Default: true.
{"type": "boolean", "default": true}
statamic.blueprint.schema.json
automatic_links
Automatically links any URLs in the text. Default: false.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
escape_markup
Escapes inline HTML markup. For example, <div> will be replaced with &lt;div&gt;. Default: true.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
smartypants
Automatically convert straight quotes into curly quotes, dashes into en/em-dashes, and other similar text transformations. Default: false.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
default
Set the default value.
{"type": "string"}
statamic.blueprint.schema.json
radio
The radio fieldtype is a multiple choice input where you only get one choice.
{"type": "object", "properties": {"type": {"const": "radio"}, "options": {"type": ["object", "array"]}, "inline": {"type": "boolean", "default": false}, "cast_booleans": {"type": "boolean", "default": false}}, "additionalProperties": true}
statamic.blueprint.schema.json
options
Sets of key/value pairs define the values and labels of the radio options.
{"type": ["object", "array"]}
statamic.blueprint.schema.json
inline
Show the radio buttons next to each other in a row instead of stacked vertically. Default: false
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
range
Range fields let the user choose a numeric value which must be no less than a given value, and no more than another.
{"type": "object", "properties": {"type": {"const": "range"}, "step": {"type": "integer", "minimum": 1, "default": 1}, "min": {"type": "integer", "minimum": 0, "default": 0}, "max": {"type": "integer", "default": 100}, "default": {"type": "integer"}}, "additionalProperties": true}
statamic.blueprint.schema.json
step
The minimum size between values.
{"type": "integer", "minimum": 1, "default": 1}
statamic.blueprint.schema.json
min
The minimum, left-most value.
{"type": "integer", "minimum": 0, "default": 0}
statamic.blueprint.schema.json
max
The maximum, right-most value.
{"type": "integer", "default": 100}
statamic.blueprint.schema.json
default
Set the default value.
{"type": "integer"}
statamic.blueprint.schema.json
replicator
The Replicator is a meta fieldtype giving you the ability to define sets of fields that you can dynamically piece together in whatever order and arrangement you imagine.
{"type": "object", "properties": {"type": {"const": "replicator"}}, "additionalProperties": true}
statamic.blueprint.schema.json
revealer
The revealer is a simple button that reveals conditional fields without saving any additional data.
{"type": "object", "properties": {"type": {"const": "revealer"}}, "additionalProperties": true}
statamic.blueprint.schema.json
section
{"type": "object", "properties": {"type": {"const": "section"}}, "additionalProperties": true}
statamic.blueprint.schema.json
select
Give your users a list of options to choose from.
{"type": "object", "properties": {"type": {"const": "select"}, "clearable": {"type": "boolean", "default": false}, "options": {"type": ["array", "object"]}, "placeholder": {}, "default": {"type": "string"}, "multiple": {"type": "boolean", "default": false}, "searchable": {"type": "boolean", "default": true}, "taggable": {"type": "boolean", "default": false}, "push_tags": {"type": "boolean", "default": false}}, "additionalProperties": true, "required": ["options"]}
statamic.blueprint.schema.json
clearable
Allow deselecting any chosen option and making null a possible value. Default: false.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
options
A set of key/value pairs that define the values and labels. If you don't define the keys, the value and label will be the same.
{"type": ["array", "object"]}
statamic.blueprint.schema.json
placeholder
Set the non-selectable placeholder text. Default: none.
{}
statamic.blueprint.schema.json
default
Set the default option key. Default: none.
{"type": "string"}
statamic.blueprint.schema.json
multiple
Allow multiple selections. Default: false.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
searchable
Enable search with suggestions by typing in the select box. Default: true.
{"type": "boolean", "default": true}
statamic.blueprint.schema.json
taggable
Use a "tag" style UI when selecting multiples. Default: false.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
push_tags
Add newly created options to the list. Default: false.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
sites
{"type": "object", "properties": {"type": {"const": "sites"}, "max_items": {}, "mode": {}}, "additionalProperties": true}
statamic.blueprint.schema.json
slug
{"type": "object", "properties": {"type": {"const": "slug"}, "generate": {"type": "boolean", "default": true}}, "additionalProperties": true}
statamic.blueprint.schema.json
structures
Use this fieldtype to create a one-way relationship with one or more structures in your site.
{"type": "object", "properties": {"type": {"const": "structures"}, "max_items": {}, "mode": {}}, "additionalProperties": true}
statamic.blueprint.schema.json
table
This fieldtype gives you a way to create flexible tabular data.
{"type": "object", "properties": {"type": {"const": "table"}}, "additionalProperties": true}
statamic.blueprint.schema.json
taggable
Users can enter “taggable” values, which are formatted automatically into a YAML list format.
{"type": "object", "properties": {"type": {"const": "taggable"}, "placeholder": {}}, "additionalProperties": true}
statamic.blueprint.schema.json
taxonomies
{"type": "object", "properties": {"type": {"const": "taxonomies"}, "max_items": {}, "mode": {}}, "additionalProperties": true}
statamic.blueprint.schema.json
template
This is generally used as a "system" field to control an entry's template.
{"type": "object", "properties": {"type": {"const": "template"}, "hide_partials": {"type": "boolean", "default": true}}, "additionalProperties": true}
statamic.blueprint.schema.json
terms
Taxonomies are usually relationships established on the collection-configuration level.
{"type": "object", "properties": {"type": {"const": "terms"}, "max_items": {}, "mode": {}, "create": {"type": "boolean"}, "taxonomies": {"type": "array"}}, "additionalProperties": true}
statamic.blueprint.schema.json
text
A text field that has the ability to morph into an intergalactic dragon and devour entire planets!
{"type": "object", "properties": {"type": {"const": "text"}, "placeholder": {}, "input_type": {"type": "string", "default": "text", "enum": ["color", "date", "email", "hidden", "month", "number", "password", "tel", "text", "time", "url", "week"]}, "character_limit": {"type": ["integer"]}, "antlers": {}, "default": {"type": "string"}, "append": {"type": "string"}, "prepend": {"type": "string"}}, "additionalProperties": true}
statamic.blueprint.schema.json
textarea
A long textarea field that functions like a swimming pool for letters and numbers on a hot day.
{"type": "object", "properties": {"type": {"const": "textarea"}, "placeholder": {}, "character_limit": {"type": ["integer", "string"]}, "antlers": {}, "default": {"type": "string"}}, "additionalProperties": true}
statamic.blueprint.schema.json
time
The original time field from the set of Kiefer Sutherland's hit drama "24".
{"type": "object", "properties": {"type": {"const": "time"}, "default": {"type": "string", "pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$"}}, "additionalProperties": true}
statamic.blueprint.schema.json
toggle
A nice little toggle switch generally used to manage settings-type variables.
{"type": "object", "properties": {"type": {"const": "toggle"}, "default": {"type": "boolean", "default": false}}, "additionalProperties": true}
statamic.blueprint.schema.json
user_groups
The User Group fieldtype gives your users a way to pick one or more User Groups to attach to the current entry.
{"type": "object", "properties": {"type": {"const": "user_groups"}, "max_items": {"type": ["integer", "null"], "minimum": 1, "default": null}, "mode": {}}, "additionalProperties": true}
statamic.blueprint.schema.json
user_roles
The User Role fieldtype gives your users a way to pick one or more User Groups to attach to the current entry.
{"type": "object", "properties": {"type": {"const": "user_roles"}, "max_items": {"type": ["integer", "null"], "minimum": 1, "default": null}, "mode": {}}, "additionalProperties": true}
statamic.blueprint.schema.json
users
The most common use for the Users fieldtype is to set the "author" for entries, but it's not the only use.
{"type": "object", "properties": {"type": {"const": "users"}, "max_items": {"type": ["integer", "null"], "minimum": 1, "default": null}, "mode": {}, "default": {"type": "string", "const": "current"}}, "additionalProperties": true}
statamic.blueprint.schema.json
video
{"type": "object", "properties": {"type": {"const": "video"}, "placeholder": {}, "default": {"type": "string", "format": "url"}}, "additionalProperties": true}
statamic.blueprint.schema.json
yaml
This field is a code fieldtype that gets saved as YAML instead of a string.
{"type": "object", "properties": {"type": {"const": "yaml"}, "default": {"type": ["object", "string"]}}, "additionalProperties": true}
statamic.blueprint.schema.json
display
The label shown above the field.
{"type": "string"}
statamic.blueprint.schema.json
icon
The icon
{"type": "string"}
statamic.blueprint.schema.json
instructions
Shown under the field's display label, like this very text. Markdown is supported.
{"type": "string"}
statamic.blueprint.schema.json
instructions_position
Where the instructions should be positioned relative to the field. Options: Above or Below.
{"type": "string", "enum": ["above", "below"]}
statamic.blueprint.schema.json
listable
Controls whether the field should be shown in control panel listings.
{"oneOf": [{"type": "boolean"}, {"type": "string", "pattern": "hidden"}]}
statamic.blueprint.schema.json
required
Control whether or not this field is required.
{"type": "boolean"}
statamic.blueprint.schema.json
localizable
{"type": "boolean"}
statamic.blueprint.schema.json
validate
The validation rules for that field
{"type": "array", "items": {"anyOf": [{}, {}], "minItems": 1, "uniqueItems": true}}
statamic.blueprint.schema.json
antlers
Enable Antlers parsing in this field's content.
{"type": "boolean", "default": false}
sarif-external-property-file-2.1.0-rtm.5.json
$schema
The URI of the JSON schema corresponding to the version of the external property file format.
{"type": "string", "format": "uri"}
sarif-external-property-file-2.1.0-rtm.5.json
version
The SARIF format version of this external properties object.
{"enum": ["2.1.0"]}
sarif-external-property-file-2.1.0-rtm.5.json
guid
A stable, unique identifier for this external properties object, in the form of a GUID.
{"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}
sarif-external-property-file-2.1.0-rtm.5.json
runGuid
A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.
{"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}
sarif-external-property-file-2.1.0-rtm.5.json
conversion
A conversion object that will be merged with an external run.
{}
sarif-external-property-file-2.1.0-rtm.5.json
graphs
An array of graph objects that will be merged with an external run.
{"type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": {}}
sarif-external-property-file-2.1.0-rtm.5.json
externalizedProperties
Key/value pairs that provide additional information that will be merged with an external run.
{}
sarif-external-property-file-2.1.0-rtm.5.json
artifacts
An array of artifact objects that will be merged with an external run.
{"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}
sarif-external-property-file-2.1.0-rtm.5.json
invocations
Describes the invocation of the analysis tool that will be merged with an external run.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-external-property-file-2.1.0-rtm.5.json
logicalLocations
An array of logical locations such as namespaces, types or functions that will be merged with an external run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-external-property-file-2.1.0-rtm.5.json
threadFlowLocations
An array of threadFlowLocation objects that will be merged with an external run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-external-property-file-2.1.0-rtm.5.json
results
An array of result objects that will be merged with an external run.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-external-property-file-2.1.0-rtm.5.json
taxonomies
Tool taxonomies that will be merged with an external run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-external-property-file-2.1.0-rtm.5.json
driver
The analysis tool object that will be merged with an external run.
{}
sarif-external-property-file-2.1.0-rtm.5.json
extensions
Tool extensions that will be merged with an external run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-external-property-file-2.1.0-rtm.5.json
policies
Tool policies that will be merged with an external run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-external-property-file-2.1.0-rtm.5.json
translations
Tool translations that will be merged with an external run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-external-property-file-2.1.0-rtm.5.json
addresses
Addresses that will be merged with with an external run.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-external-property-file-2.1.0-rtm.5.json
webRequests
Requests that will be merged with an external run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-external-property-file-2.1.0-rtm.5.json
webResponses
Responses that will be merged with an external run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-external-property-file-2.1.0-rtm.5.json
properties
Key/value pairs that provide additional information about the external properties.
{}
vsconfig.json
version
The version of the component configuration file format.
{"type": "string", "pattern": "^(\\d+\\.)?(\\d+\\.)?(\\d+\\.)?(\\d+)$"}
vsconfig.json
components
An array of Visual Studio component names
{"type": "array", "items": {"type": "string", "minLength": 1}}
bxci.schema-2.x.json
CI configuration for Amdocs Bill Experience projects
{"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"branchPattern": {"type": "string"}, "timeout": {"type": "integer"}, "credentials": {"type": "string"}, "binaryRepository": {"type": "object", "properties": {"address": {"type": "string", "format": "uri"}, "credentials": {}}, "additionalProperties": false, "required": ["address", "credentials"]}, "checkmarx": {"type": "object", "properties": {"enabled": {"type": "boolean", "default": false}, "branch_pattern": {"default": "^master$|^release/.*$"}, "groupId": {"type": "string", "default": "55"}, "preset": {"type": "string", "default": "36"}, "sourceEncoding": {"type": "string", "default": "5"}, "serverUrl": {"type": "string", "default": "http://cxpbgmgmtserver/"}, "credentialsId": {"type": "string", "default": "BB-Checkmarx"}, "isProxy": {"type": "boolean", "default": false}, "useOwnServerCredentials": {"type": "boolean", "default": true}, "projectName": {"type": "string"}, "exclusionsSetting": {"enum": ["job", "global"], "default": "job"}, "excludeFolders": {"type": "string", "examples": ["folder-1, folder-2, folder-3"]}, "filterPattern": {"type": "string", "examples": ["\"!**/_cvs/**/*, !**/.svn/**/*, !**/.hg/**/*, !**/.git/**/*\""]}, "hideDebugLogs": {"type": "boolean", "default": true}, "waitForResultsEnabled": {"type": "boolean", "default": true}, "vulnerabilityThresholdEnabled": {"type": "boolean", "default": true}, "highThreshold": {"type": "integer", "default": 0}, "mediumThreshold": {"type": "integer", "default": 10}, "lowThreshold": {"type": "integer", "default": null}}, "additionalProperties": false}, "sonar": {"type": "object", "properties": {"enabled": {"type": "boolean", "default": true}, "breaks_build": {"type": "boolean", "default": false}, "branch_analysis": {"type": "boolean", "default": true}, "branch_pattern": {"type": "string", "examples": ["^master$|^release/.+$", "master"]}, "image": {"type": "string", "examples": ["myrepo:port/my-awesome-image:1.2.3"]}, "timeout": {"default": 120}, "exclusions": {"type": "string", "examples": ["**/excluded-folder/**, **/example/*.html"]}}, "additionalProperties": false}, "when": {"type": "object", "properties": {"branch": {}}}, "steps": {"type": "array"}, "singleStage": {"type": "object", "properties": {"steps": {}, "when": {}}, "required": ["steps"], "additionalProperties": false}, "failFast": {"type": "boolean", "default": false}, "parallelStage": {"type": "object", "properties": {"when": {}, "fail_fast": {}, "parallel": {"type": "object", "patternProperties": {"^\\w+( \\w+)*$": {}}}}, "required": ["parallel"], "additionalProperties": false}, "stage": {"type": "object", "properties": {"when": {}, "steps": {}, "fail_fast": {}, "parallel": {"patternProperties": {"^\\w+( \\w+)*$": {}}}}, "anyOf": [{}, {}], "additionalProperties": false}, "releaseChannel": {"type": "string"}, "releaseChannelBranch": {}, "dockerfile": {"type": "string"}, "outputDocker": {"type": "object", "properties": {"dockerfile": {}, "image_name": {"type": "string"}, "publish": {}, "vulnerability_scan": {"type": "object", "properties": {"enabled": {"type": "boolean", "default": true}}, "additionalProperties": false}, "args": {"type": "array", "items": {}}}, "required": ["dockerfile", "image_name"], "additionalProperties": false}, "outputDockerPublish": {"type": "array", "items": {}}, "outputDockerBuildArgs": {"type": "object", "additionalProperties": false, "properties": {"key": {"type": "string"}, "env": {"type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$"}, "value": {"type": "string"}}, "required": ["key"], "oneOf": [{"required": ["env"], "not": {"required": ["value"]}}, {"required": ["value"], "not": {"required": ["env"]}}]}, "dockerReleaseChannel": {"type": "object", "properties": {"channel": {}, "branch": {}, "registry": {"type": "string", "format": "uri"}, "credentials": {}}, "required": ["channel", "branch", "registry", "credentials"], "additionalProperties": false}, "outputHelm": {"type": "object", "properties": {"path": {"type": "string"}, "updates": {"type": "array", "items": {}}, "publish": {}}, "required": ["path", "publish", "updates"], "additionalProperties": false}, "outputHelmUpdates": {"type": "object", "additionalProperties": false, "properties": {"file": {"type": "string"}, "properties": {"type": "array", "items": {}}}, "required": ["file", "properties"]}, "outputHelmUpdatesProperties": {"type": "object", "additionalProperties": false, "properties": {"key": {"type": "string"}, "env": {"type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$"}, "value": {"type": "string"}}, "required": ["key"], "oneOf": [{"required": ["env"], "not": {"required": ["value"]}}, {"required": ["value"], "not": {"required": ["env"]}}]}, "outputHelmPublish": {"type": "array", "items": {}}, "helmReleaseChannel": {"type": "object", "properties": {"channel": {}, "branch": {}, "repository": {"type": "string", "format": "uri"}, "credentials": {}}, "required": ["channel", "branch", "repository", "credentials"], "additionalProperties": false}, "outputPackage": {"type": "object", "properties": {"publish": {}}, "required": ["publish"], "additionalProperties": false}, "outputPackagePublish": {"type": "array", "items": {}}, "packagePublishChannel": {"type": "object", "properties": {"channel": {}, "branch": {}, "registry": {"type": "string", "examples": ["NPM_PUBLISH_REGISTRY", "NPM_SNAPSHOT_REGISTRY", "https://registry.npmjs.org"]}, "credentials": {}, "maven_releases_repo": {"type": "string"}, "maven_snapshots_repo": {"type": "string"}, "params": {"type": "string", "examples": ["--tag latest", "-Dmaven.test.skip=true"]}}, "required": ["channel", "branch"], "additionalProperties": false}, "cacheItem": {"type": "object", "properties": {"type": {"enum": ["maven", "npm", "local"], "default": "maven"}, "enabled": {"type": "boolean", "default": false}, "source": {"type": "string", "default": ".ci-cache/<type>"}, "target": {"type": "string", "default": "/container-path/directory"}}, "additionalProperties": false, "required": ["type", "enabled"]}}, "properties": {"project": {"type": "object", "properties": {"name": {"type": "string"}, "type": {"enum": ["npm", "maven", "mvn"], "default": "mvn"}, "settings": {"type": "string", "examples": ["bx-maven-settings", "bx-npm-settings"]}}, "additionalProperties": false}, "config": {"type": "object", "properties": {"jenkins_runtime": {"type": "object", "properties": {"docker": {"type": "object", "properties": {"image": {"type": "string", "examples": ["remote-host.com/image-name:tag"]}, "dockerfile": {"examples": [".ci/Dockerfile"]}}, "additionalProperties": false}}, "additionalProperties": false, "required": ["docker"]}, "branch": {"type": "object", "properties": {"branch_pattern": {}, "disable_validation": {"type": "boolean", "default": false}}, "additionalProperties": false}, "build": {"type": "object", "properties": {"clean_workspace_after_run": {"type": "boolean", "default": true}, "commit_time_threshold": {"oneOf": [{"type": "integer", "const": 0}, {"type": "string", "pattern": "^\\d+[mhd]$"}], "default": false, "examples": [0, "2m", "30m", "1d", "30m", "10d"]}, "checkmarx": {}, "static_analysis": {}}, "additionalProperties": false}, "cache": {"type": "object", "properties": {"repository": {}, "items": {"type": "array", "items": {}}}, "additionalProperties": false}}, "additionalProperties": false}, "services": {"type": "array", "items": {"enum": ["Postgres", "Postgis", "Redis", "Mssql", "Mysql", "Mongodb", "Elasticsearch"]}, "uniqueItems": true}, "environment": {"type": "object", "propertyNames": {"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"}}, "jenkinsEnvironment": {"type": "array", "uniqueItems": true, "items": {"pattern": "^[A-Za-z_][A-Za-z0-9_]*$", "type": "string"}}, "stages": {"type": "object", "patternProperties": {"^\\w+( \\w+)*$": {}}}, "output": {"type": "object", "properties": {"package": {}, "docker": {}, "helm": {}}, "additionalProperties": false}, "archive": {"type": "array", "examples": ["target/*.jar", "**/*.jar", "target/out.txt"]}, "timeout": {"default": 600}}, "required": ["project", "stages"], "type": "object"}
bxci.schema-2.x.json
branchPattern
Regular expression for validating branch names
{"type": "string"}
bxci.schema-2.x.json
timeout
Timeout in seconds
{"type": "integer"}
bxci.schema-2.x.json
credentials
Jenkins credentials ID
{"type": "string"}
bxci.schema-2.x.json
binaryRepository
Binary repository details
{"type": "object", "properties": {"address": {"type": "string", "format": "uri"}, "credentials": {}}, "additionalProperties": false, "required": ["address", "credentials"]}
bxci.schema-2.x.json
address
Repository URL
{"type": "string", "format": "uri"}
bxci.schema-2.x.json
credentials
Jenkins credentials ID for connecting to this repository
{}
bxci.schema-2.x.json
enabled
Sets whether the scan should be run
{"type": "boolean", "default": false}
bxci.schema-2.x.json
branch_pattern
Specifies in which branches this stage will be executed
{"default": "^master$|^release/.*$"}
bxci.schema-2.x.json
groupId
Fully qualified team name for the project
{"type": "string", "default": "55"}
bxci.schema-2.x.json
preset
Scan preset for the project
{"type": "string", "default": "36"}
bxci.schema-2.x.json
sourceEncoding
Language encoding ID associated to the source code character encoding (5: Multi-Language Scan)
{"type": "string", "default": "5"}
bxci.schema-2.x.json
serverUrl
Checkmarx Server URL or IP address
{"type": "string", "default": "http://cxpbgmgmtserver/"}
bxci.schema-2.x.json
credentialsId
Jenkins credentials ID
{"type": "string", "default": "BB-Checkmarx"}
bxci.schema-2.x.json
useOwnServerCredentials
Enables the use of the default server credentials or disables and provides server and credentials that override the defaults
{"type": "boolean", "default": true}
bxci.schema-2.x.json
projectName
Unique project name. Will be inferred from the repository name if not provided
{"type": "string"}
bxci.schema-2.x.json
exclusionsSetting
Specifies which exclusions settings to use: global (Jenkins global settings) or job (current pipeline)
{"enum": ["job", "global"], "default": "job"}
bxci.schema-2.x.json
excludeFolders
Comma separated list of folders to be excluded from the CxSAST scan
{"type": "string", "examples": ["folder-1, folder-2, folder-3"]}