schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
github-issue-forms.json | id | A dropdown id
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys | {} |
github-issue-forms.json | attributes | Dropdown attributes
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-3 | {"type": "object", "required": ["label", "options"], "properties": {"label": {}, "multiple": {"type": "boolean", "default": false}, "options": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "string", "minLength": 1, "examples": ["Sample choice"]}}}, "additionalProperties": false} |
github-issue-forms.json | label | A short dropdown description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-3 | {} |
github-issue-forms.json | description | A long dropdown description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-3 | {} |
github-issue-forms.json | multiple | Specify whether allow a multiple choices
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-3 | {"type": "boolean", "default": false} |
github-issue-forms.json | options | Dropdown choices
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-3 | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "string", "minLength": 1, "examples": ["Sample choice"]}} |
github-issue-forms.json | validations | Dropdown validations
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#validations-2 | {} |
github-issue-forms.json | then | Checkboxes
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#checkboxes | {"type": "object", "required": ["type", "attributes"], "properties": {"type": {}, "id": {}, "attributes": {"type": "object", "required": ["label", "options"], "properties": {"label": {}, "options": {"type": "array", "minItems": 1, "items": {"type": "object", "required": ["label"], "properties": {"label": {"type": "string", "minLength": 1, "examples": ["Sample label"]}, "required": {"type": "boolean", "default": false}}, "additionalProperties": false}}}, "additionalProperties": false}}, "additionalProperties": false} |
github-issue-forms.json | id | Checkbox list id
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys | {} |
github-issue-forms.json | attributes | Checkbox list attributes
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4 | {"type": "object", "required": ["label", "options"], "properties": {"label": {}, "options": {"type": "array", "minItems": 1, "items": {"type": "object", "required": ["label"], "properties": {"label": {"type": "string", "minLength": 1, "examples": ["Sample label"]}, "required": {"type": "boolean", "default": false}}, "additionalProperties": false}}}, "additionalProperties": false} |
github-issue-forms.json | label | A short checkbox list description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4 | {} |
github-issue-forms.json | description | A long checkbox list description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4 | {} |
github-issue-forms.json | options | Checkbox list choices
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4 | {"type": "array", "minItems": 1, "items": {"type": "object", "required": ["label"], "properties": {"label": {"type": "string", "minLength": 1, "examples": ["Sample label"]}, "required": {"type": "boolean", "default": false}}, "additionalProperties": false}} |
github-issue-forms.json | items | Checkbox list choice
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4 | {"type": "object", "required": ["label"], "properties": {"label": {"type": "string", "minLength": 1, "examples": ["Sample label"]}, "required": {"type": "boolean", "default": false}}, "additionalProperties": false} |
github-issue-forms.json | label | A short checkbox list choice description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4 | {"type": "string", "minLength": 1, "examples": ["Sample label"]} |
github-issue-forms.json | required | Specify whether a choise is required
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4 | {"type": "boolean", "default": false} |
github-issue-forms.json | name | An issue template name
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax | {"type": "string", "minLength": 1, "examples": ["Sample name"]} |
github-issue-forms.json | description | An issue template description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax | {"type": "string", "minLength": 1, "examples": ["Sample description"]} |
github-issue-forms.json | body | An issue template body
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax | {"type": "array", "minItems": 1, "items": {}} |
github-issue-forms.json | assignees | An issue template assignees
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax | {"oneOf": [{}, {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}]} |
github-issue-forms.json | labels | An issue template labels
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "string", "minLength": 1, "examples": ["Sample label", "bug", "documentation", "duplicate", "enhancement", "good first issue", "help wanted", "invalid", "question", "wontfix"]}} |
github-issue-forms.json | title | An issue template title
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax | {"type": "string", "minLength": 1, "examples": ["Sample title", "Bug: ", "Feature: "]} |
docker-seq.schema.json | The schema for `docker-seq` | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": {"image": {"type": "string"}, "workdir": {"type": "string"}, "user": {"type": "string"}, "local_user": {"type": "boolean"}, "tty": {"type": "boolean"}, "interactive": {"type": "boolean"}, "pull": {"type": "string", "enum": ["always", "missing", "never"]}, "rm": {"type": "boolean"}, "init": {"type": "boolean"}, "volumes": {"type": "array"}, "publish": {"type": "array"}, "env": {"type": "array"}, "env_file": {"type": "array"}, "cpus": {"type": "string"}, "memory": {"type": "integer"}, "entrypoint": {"type": "string"}, "name": {"type": "string"}, "privileged": {"type": "boolean"}, "network": {"type": "string"}, "mount": {"type": "array"}, "read_only": {"type": "boolean"}, "platform": {"type": "string"}, "runtime": {"type": "string"}, "security_opt": {"type": "array"}, "ulimit": {"type": "string"}, "volumes_from": {"type": "array"}, "background_task": {"type": "array"}, "docker_exec_shell": {"type": "array"}, "sequence": {"type": "array", "items": {}}}, "definitions": {"Step": {"type": "object", "additionalProperties": false, "properties": {"workdir": {"type": "string"}, "user": {"type": "string"}, "local_user": {"type": "boolean"}, "tty": {"type": "boolean"}, "privileged": {"type": "boolean"}, "interactive": {"type": "boolean"}, "commands": {"type": "array"}}}}} |
|
docker-seq.schema.json | image | The docker image name | {"type": "string"} |
docker-seq.schema.json | workdir | Working directory inside the container | {"type": "string"} |
docker-seq.schema.json | user | Username or UID (format: <name|uid>[:<group|gid>]) | {"type": "string"} |
docker-seq.schema.json | local_user | Disables the `user` option and runs the container with the hosts uid and gid. | {"type": "boolean"} |
docker-seq.schema.json | tty | Allocate a pseudo-TTY | {"type": "boolean"} |
docker-seq.schema.json | interactive | Keep STDIN open even if not attached | {"type": "boolean"} |
docker-seq.schema.json | pull | Pull image before running ("always"|"missing"|"never") (default "missing") | {"type": "string", "enum": ["always", "missing", "never"]} |
docker-seq.schema.json | rm | Automatically remove the container when it exits | {"type": "boolean"} |
docker-seq.schema.json | init | Run an init inside the container that forwards signals and reaps processes | {"type": "boolean"} |
docker-seq.schema.json | volumes | Bind mount volumes | {"type": "array"} |
docker-seq.schema.json | publish | Publish a container's port(s) to the host | {"type": "array"} |
docker-seq.schema.json | env | Set environment variables | {"type": "array"} |
docker-seq.schema.json | env_file | Read in files of environment variables | {"type": "array"} |
docker-seq.schema.json | cpus | Number of CPUs | {"type": "string"} |
docker-seq.schema.json | memory | Memory limit in bytes | {"type": "integer"} |
docker-seq.schema.json | entrypoint | Overwrite the default ENTRYPOINT of the image | {"type": "string"} |
docker-seq.schema.json | name | Assign a name to the container | {"type": "string"} |
docker-seq.schema.json | privileged | Give extended privileges to this container | {"type": "boolean"} |
docker-seq.schema.json | mount | Attach a filesystem mount to the container | {"type": "array"} |
docker-seq.schema.json | read_only | Mount the container's root filesystem as read only | {"type": "boolean"} |
docker-seq.schema.json | platform | Set platform if server is multi-platform capable | {"type": "string"} |
docker-seq.schema.json | runtime | Runtime to use for this container | {"type": "string"} |
docker-seq.schema.json | security_opt | Security Options | {"type": "array"} |
docker-seq.schema.json | ulimit | Ulimit options | {"type": "string"} |
docker-seq.schema.json | volumes_from | Mount volumes from the specified container(s) | {"type": "array"} |
docker-seq.schema.json | background_task | Task with which to keep the container alive while executing commands | {"type": "array"} |
docker-seq.schema.json | docker_exec_shell | Shell in which to execute each sequence step command | {"type": "array"} |
docker-seq.schema.json | Step | One step in the command sequence | {"type": "object", "additionalProperties": false, "properties": {"workdir": {"type": "string"}, "user": {"type": "string"}, "local_user": {"type": "boolean"}, "tty": {"type": "boolean"}, "privileged": {"type": "boolean"}, "interactive": {"type": "boolean"}, "commands": {"type": "array"}}} |
docker-seq.schema.json | workdir | Working directory inside the container | {"type": "string"} |
docker-seq.schema.json | user | Username or UID (format: <name|uid>[:<group|gid>]) | {"type": "string"} |
docker-seq.schema.json | local_user | Disables the `user` option and executes these commands with the hosts uid and gid. | {"type": "boolean"} |
docker-seq.schema.json | tty | Allocate a pseudo-TTY | {"type": "boolean"} |
docker-seq.schema.json | privileged | Give extended privileges to the commands | {"type": "boolean"} |
docker-seq.schema.json | interactive | Keep STDIN open even if not attached | {"type": "boolean"} |
docker-seq.schema.json | commands | A list of commands to execute within the container | {"type": "array"} |
cloud-sdk-pipeline-config-schema.json | The configuration file of the SAP Cloud SDK Continuous Delivery Toolkit. For more information please visit https://github.com/SAP/cloud-s4-sdk-pipeline | {"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"dockerImage": {"type": "string"}, "org": {"type": "string"}, "space": {"type": "string"}, "appName": {"type": "string"}, "manifest": {"type": "string"}, "credentialsId": {"type": "string"}, "apiEndpoint": {"type": "string", "default": "https://api.cf.eu10.hana.ondemand.com"}, "mtaExtensionDescriptor": {"type": "string"}, "mtaExtensionCredentials": {"type": "string"}, "host": {"type": "string"}, "account": {"type": "string"}, "application": {"type": "string"}, "environment": {"type": "object"}, "vmArguments": {"type": "string"}, "size": {"type": "string", "default": "lite"}, "runtime": {"type": "string"}, "runtimeVersion": {"type": "string"}, "neoTargets": {"type": "array", "items": {"type": "object", "properties": {"host": {}, "account": {}, "application": {}, "credentialsId": {}, "environment": {}, "vmArguments": {}, "size": {}, "runtime": {}, "runtimeVersion": {}}, "required": ["host", "account", "application", "runtime", "runtimeVersion"], "additionalProperties": false}}, "appUrls": {"type": "array", "items": {"type": "object", "properties": {"url": {"type": "string"}, "credentialId": {"type": "string"}, "parameters": {"type": "array"}}, "required": ["url"], "additionalProperties": false}}, "cfTargets": {"type": "array", "items": {"type": "object", "properties": {"org": {}, "space": {}, "appName": {}, "manifest": {}, "credentialsId": {}, "apiEndpoint": {}, "mtaExtensionDescriptor": {}, "mtaExtensionCredentials": {}}, "additionalProperties": false}}, "cloudFoundry": {"type": "object", "properties": {"org": {}, "space": {}, "appName": {}, "manifest": {}, "credentialsId": {}, "apiEndpoint": {}, "mtaExtensionDescriptor": {}, "mtaExtensionCredentials": {}}, "additionalProperties": false}}, "postActions": {"type": "object", "properties": {"sendNotification": {"type": ["object", "null"], "properties": {"enabled": {"type": "boolean", "default": false}, "skipFeatureBranches": {"type": "boolean", "default": false}, "recipients": {"type": "array", "items": {"type": "string"}}}}}}, "properties": {"customDefaults": {"type": "array", "items": {"type": "string"}}, "general": {"type": ["object", "null"], "properties": {"productiveBranch": {"type": "string", "default": "master"}, "projectName": {"type": "string"}, "globalExtensionsRepository": {"type": "string"}, "globalExtensionsVersion": {"type": "string"}, "globalExtensionsRepositoryCredentialsId": {"type": "string"}, "collectTelemetryData": {"type": "boolean", "default": true}, "unsafeMode": {"type": "boolean", "default": false}, "features": {"type": "object", "properties": {"parallelTestExecution": {"type": "string", "enum": ["on", "off"], "default": "off"}}, "additionalProperties": true}, "jenkinsKubernetes": {"type": "object", "properties": {"jnlpAgent": {"type": "string", "default": "jenkins/jnlp-slave:latest"}}, "additionalProperties": true}}, "additionalProperties": false}, "stages": {"type": ["object", "null"], "properties": {"backendIntegrationTests": {"type": "object", "properties": {"retry": {"type": "integer", "default": 1}, "forkCount": {"type": "string", "default": "1C"}, "credentials": {"type": "array", "items": {"type": "object", "properties": {"alias": {"type": "string"}, "credentialId": {"type": "string"}}, "required": ["alias", "credentialId"], "additionalProperties": false}}, "sidecarImage": {"type": "string"}, "sidecarName": {"type": "string"}, "sidecarReadyCommand": {"type": "string"}, "sidecarEnvVars": {"type": "object"}}, "additionalProperties": false}, "frontEndIntegrationTests": {"type": "object", "properties": {"dockerImage": {}}, "additionalProperties": false}, "frontEndUnitTests": {"type": "object", "properties": {"dockerImage": {}}, "additionalProperties": false}, "endToEndTests": {"type": "object", "properties": {"enableZeroDowntimeDeployment": {"type": "boolean"}, "onlyRunInProductiveBranch": {"type": "boolean"}, "appUrls": {}}}, "npmAudit": {"type": "object", "properties": {"auditedAdvisories": {"type": "array", "items": {"type": ["integer", "string"]}}}, "additionalProperties": false}, "performanceTests": {"type": "object", "properties": {"neoTargets": {}, "cfTargets": {}}}, "s4SdkQualityChecks": {"type": "object", "properties": {"jacocoExcludes": {"type": "array", "items": {"type": "string"}}, "customOdataServices": {"type": "array", "items": {"type": "string"}}, "nonErpDestinations": {"type": "array", "items": {"type": "string"}}, "nonErpUrls": {"type": "array", "items": {"type": "string"}}, "codeCoverageFrontend": {"type": "object"}, "threshold": {"type": "object", "properties": {"successCoverage": {"type": "integer", "minimum": 70}, "unstableCoverage": {"type": "integer", "minimum": 65}}, "additionalProperties": false, "required": ["successCoverage", "unstableCoverage"]}, "disabledChecks": {"type": "array", "items": {"type": "string", "enum": ["checkDeploymentDescriptors", "checkResilience", "checkServices", "checkFrontendCodeCoverage", "checkBackendCodeCoverage"]}, "default": []}}, "additionalProperties": false}, "checkmarxScan": {"type": "object", "properties": {"groupId": {"type": "string"}, "checkMarxProjectName": {"type": "string"}, "filterPattern": {"type": "string", "default": "!**/*.log, !**/*.lock, !**/*.json, !**/*.html, !**/Cx*, !**/test/**, !s4hana_pipeline/**, !**/unit-tests/**, !**/integration-tests/**, !**/frontend-unit-tests/**, !**/e2e-tests/**, !**/performance-tests/**, **/*.js, **/*.java, **/*.ts"}, "fullScansScheduled": {"type": "boolean", "default": false}, "incremental": {"type": "boolean", "default": true}, "vulnerabilityThresholdMedium": {"type": "integer", "default": 0}, "vulnerabilityThresholdLow": {"type": "integer", "default": 99999}, "preset": {"type": ["integer", "string"], "default": 36}, "checkmarxCredentialsId": {"type": "string"}, "checkmarxServerUrl": {"type": "string"}, "generatePdfReport": {"type": "boolean"}}, "required": ["groupId"], "additionalProperties": false}, "productionDeployment": {"type": "object", "properties": {"appUrls": {}, "neoTargets": {}, "cfTargets": {}}}, "artifactDeployment": {"type": "object", "properties": {"nexus": {"type": "object", "properties": {"version": {"type": "string", "enum": ["nexus2", "nexus3"], "default": "nexus3"}, "url": {"type": "string"}, "mavenRepository": {"type": "string"}, "npmRepository": {"type": "string"}, "credentialsId": {}}, "required": ["url", "repository"]}}, "additionalProperties": true}, "whitesourceScan": {"type": "object", "properties": {"product": {"type": "string"}, "staticVersion": {"type": "string"}, "credentialsId": {}, "whitesourceUserTokenCredentialsId": {"type": "string"}}, "required": ["product", "credentialsId"], "additionalProperties": true}, "sourceClearScan": {"type": "object", "properties": {"credentialsId": {}, "config": {"type": "object", "properties": {"vuln_methods_extra_ignored_directories": {"type": "string"}, "scope": {"type": "string"}}}}, "required": ["credentialsId"], "additionalProperties": false}, "compliance": {"type": "object", "properties": {"runInAllBranches": {"type": "boolean", "default": false}}, "additionalProperties": false}}}, "steps": {"type": ["object", "null"], "properties": {"mavenExecute": {"type": "object", "properties": {"dockerImage": {"default": "maven:3.6.3-jdk-8-slim"}, "projectSettingsFile": {"type": "string"}}}, "artifactPrepareVersion": {"type": "object", "properties": {"dockerImage": {}, "commitUserName": {"type": "string"}, "includeCommitId": {"type": "boolean", "default": "true"}, "tagPrefix": {"type": "string"}, "unixTimestamp": {"type": "boolean", "default": "false"}, "versioningType": {"type": "string"}}}, "executeNpm": {"type": "object", "properties": {"dockerImage": {"default": "ppiper/node-browsers:v2"}, "defaultNpmRegistry": {"type": "string", "default": "npmjs.com"}}}, "executeSourceClearScan": {"type": "object", "properties": {"dockerImage": {"default": "ppiper/mta-archive-builder:v1"}}}, "cloudFoundryDeploy": {"type": "object", "properties": {"dockerImage": {"default": "ppiper/cf-cli:v2"}, "smokeTestStatusCode": {"type": "integer", "default": 200}, "keepOldInstance": {"type": "boolean", "default": true}, "cloudFoundry": {}}}, "neoDeploy": {"type": "object", "properties": {"dockerImage": {"default": "ppiper/neo-cli:v2"}, "neo": {"type": "object", "properties": {"host": {}, "account": {}, "application": {}, "credentialsId": {}, "environment": {}, "vmArguments": {}, "size": {}, "runtime": {}, "runtimeVersion": {}}, "required": ["host", "account", "application", "runtime", "runtimeVersion"], "additionalProperties": false}}}, "checkGatling": {"type": "object", "properties": {"enabled": {"type": "boolean", "default": false}}}, "checkJMeter": {"type": "object", "properties": {"options": {"type": "string"}, "testPlan": {"type": "string", "default": "./performance-tests/*"}, "dockerImage": {"default": "famiko/jmeter-base"}, "failThreshold": {"type": "integer", "default": 100}, "unstableThreshold": {"type": "integer", "default": 90}}}, "fortifyExecuteScan": {"type": "object", "properties": {"dockerImage": {}, "verbose": {"type": "boolean", "default": false}, "fortifyCredentialsId": {"type": "string"}, "githubTokenCredentialsId": {"type": "string"}, "serverUrl": {"type": "string"}, "projectName": {"type": "string"}, "defaultVersioningModel": {"type": "string", "default": "major"}, "buildTool": {"type": "string", "default": "maven"}, "autoCreate": {"type": "boolean", "default": false}, "uploadResults": {"type": "boolean", "default": true}, "memory": {"type": "string", "default": "-Xmx4G -Xms512M"}, "src": {"type": "array", "items": {"type": "string"}}, "exclude": {"type": "array", "items": {"type": "string"}}}, "required": ["fortifyCredentialsId"]}, "whitesourceExecuteScan": {"type": "object", "properties": {"productName": {"type": "string"}, "productVersion": {"type": "string"}, "orgAdminUserTokenCredentialsId": {}, "userTokenCredentialsId": {"type": "string"}}, "required": ["productName", "orgAdminUserTokenCredentialsId"], "additionalProperties": true}, "mtaBuild": {"type": "object", "properties": {"dockerImage": {"default": "ppiper/mta-archive-builder"}, "buildTarget": {"type": "string", "default": "NEO"}, "mtaBuildTool": {"type": "string", "default": "cloudMbt"}, "applicationName": {"type": "string"}, "defaultNpmRegistry": {"type": "string"}, "dockerOptions": {"type": ["array", "string"]}, "extension": {"type": "string"}, "globalSettingsFile": {"type": "string"}, "projectSettingsFile": {"type": "string"}, "mtaJarLocation": {"type": "string", "default": "/opt/sap/mta/lib/mta.jar"}}}, "debugReportArchive": {"type": "object", "properties": {"shareConfidentialInformation": {"type": "boolean", "default": false}}}, "sonarExecuteScan": {"type": "object", "properties": {"projectKey": {"type": "string"}, "instance": {"type": "string"}, "options": {"type": ["array", "string"]}, "dockerImage": {"default": "ppiper/node-browsers:v3"}}, "required": ["projectKey", "instance"], "additionalProperties": true}, "tmsUpload": {"type": "object", "properties": {"nodeName": {"type": "string"}, "credentialsId": {"type": "string"}, "customDescription": {"type": "string", "default": "<Corresponding Git Commit-ID>"}}}}}}, "type": "object"} |
|
cloud-sdk-pipeline-config-schema.json | dockerImage | The image used in the step or stage. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | org | Cloud Foundry organization. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | space | Cloud Foundry space. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | appName | Name of the application. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | manifest | Manifest file that needs to be used. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | credentialsId | ID to the credentials that will be used. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | apiEndpoint | URL to the Cloud Foundry endpoint. | {"type": "string", "default": "https://api.cf.eu10.hana.ondemand.com"} |
cloud-sdk-pipeline-config-schema.json | mtaExtensionDescriptor | (Only for MTA-projects) Path to the mta extension description file. For more information on how to use those extension files please visit the SAP HANA Developer Guide. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | mtaExtensionCredentials | (Only for MTA-projects) Map of credentials that need to be replaced in the mtaExtensionDescriptor. This map needs to be created as value-to-be-replaced:id-of-a-credential-in-jenkins | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | host | Host of the region you want to deploy to, see Regions. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | account | Identifier of the subaccount. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | application | Name of the application in your account. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | environment | Map of environment variables in the form of KEY: VALUE. | {"type": "object"} |
cloud-sdk-pipeline-config-schema.json | vmArguments | String of VM arguments passed to the JVM. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | size | Size of the JVM, e.g. lite, pro, prem, prem-plus. | {"type": "string", "default": "lite"} |
cloud-sdk-pipeline-config-schema.json | runtime | Name of the runtime: neo-java-web, neо-javaee6-wp, neо-javaee7-wp. See the runtime for more information. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | runtimeVersion | Version of the runtime. See runtime-version for more information. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | url | The URLs under which the app is available after deployment. Each appUrl can be a string with the URL or a map containing a property url and a property credentialId. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | credentialId | ID to the credentials that will be used to connect to the SAP Cloudplatform account. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | parameters | Additional parameters can be passed for each end-to-end test deployment by specifying optional parameters for an application URL. These parameters are appended to the npm command during execution. These parameters must be a list of strings, where each string corresponds to one element of the parameters. For example, if the parameter `--tag scenario1` should be passed to the test, specify parameters: ['--tag', 'scenario1']. | {"type": "array"} |
cloud-sdk-pipeline-config-schema.json | cloudFoundry | A map specifying the Cloud Foundry specific parameters. | {"type": "object", "properties": {"org": {}, "space": {}, "appName": {}, "manifest": {}, "credentialsId": {}, "apiEndpoint": {}, "mtaExtensionDescriptor": {}, "mtaExtensionCredentials": {}}, "additionalProperties": false} |
cloud-sdk-pipeline-config-schema.json | sendNotification | The sendNotification post-build action can be used to send notifications to project members in case of an unsuccessful build outcome or if the build goes back to normal. By default, an email is sent to the list of users who committed a change since the last non-broken build. Additionally, a set of recipients can be defined that should always receive notifications. | {"type": ["object", "null"], "properties": {"enabled": {"type": "boolean", "default": false}, "skipFeatureBranches": {"type": "boolean", "default": false}, "recipients": {"type": "array", "items": {"type": "string"}}}} |
cloud-sdk-pipeline-config-schema.json | enabled | If set to true, notifications will be sent. | {"type": "boolean", "default": false} |
cloud-sdk-pipeline-config-schema.json | skipFeatureBranches | If set to true, notifications will only be sent for the productive branch as defined in the general configuration section. | {"type": "boolean", "default": false} |
cloud-sdk-pipeline-config-schema.json | recipients | List of email addresses that should be notified in addition to the standard recipients. | {"type": "array", "items": {"type": "string"}} |
cloud-sdk-pipeline-config-schema.json | customDefaults | List of paths or URLs to YAML files with custom defaults to consider. These defaults override built-in defaults, and can be shared across multiple projects. Project configuration takes precedence. | {"type": "array", "items": {"type": "string"}} |
cloud-sdk-pipeline-config-schema.json | general | The general configuration of the pipeline | {"type": ["object", "null"], "properties": {"productiveBranch": {"type": "string", "default": "master"}, "projectName": {"type": "string"}, "globalExtensionsRepository": {"type": "string"}, "globalExtensionsVersion": {"type": "string"}, "globalExtensionsRepositoryCredentialsId": {"type": "string"}, "collectTelemetryData": {"type": "boolean", "default": true}, "unsafeMode": {"type": "boolean", "default": false}, "features": {"type": "object", "properties": {"parallelTestExecution": {"type": "string", "enum": ["on", "off"], "default": "off"}}, "additionalProperties": true}, "jenkinsKubernetes": {"type": "object", "properties": {"jnlpAgent": {"type": "string", "default": "jenkins/jnlp-slave:latest"}}, "additionalProperties": true}}, "additionalProperties": false} |
cloud-sdk-pipeline-config-schema.json | productiveBranch | The name of your default branch. This branch will be used for deploying your application. Other branches will skip deployment. | {"type": "string", "default": "master"} |
cloud-sdk-pipeline-config-schema.json | projectName | Name of the project. Will be used as identifier e.g. when creating a hdi container or executing code scans. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | globalExtensionsRepository | Git url of the repository containing the extensions. | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | globalExtensionsVersion | Version of the extensions which should be used, e.g. the tag name | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | globalExtensionsRepositoryCredentialsId | Credentials required to clone the repository | {"type": "string"} |
cloud-sdk-pipeline-config-schema.json | collectTelemetryData | No personal data is collected. For details, consult the analytics documentation. | {"type": "boolean", "default": true} |
cloud-sdk-pipeline-config-schema.json | unsafeMode | Enable unsafe mode to skip checking environment variables for insecure elements. Only use this for demo purposes, never for productive usage. | {"type": "boolean", "default": false} |
cloud-sdk-pipeline-config-schema.json | features | Allows enabling or disable certain optional features. | {"type": "object", "properties": {"parallelTestExecution": {"type": "string", "enum": ["on", "off"], "default": "off"}}, "additionalProperties": true} |
cloud-sdk-pipeline-config-schema.json | parallelTestExecution | Run E2E Tests in parallel. This feature is disabled by default because it is not supported in Blue Ocean. If this feature is enabled, we suggest not using the Blue Ocean interface and rely on the classic UI instead. | {"type": "string", "enum": ["on", "off"], "default": "off"} |
cloud-sdk-pipeline-config-schema.json | jenkinsKubernetes | If the Jenkins is running on a kubernetes cluster as a pod, we can use the dynamic scaling feature in the pipeline. In order to enable this, an environment variable ON_K8S has to be set to true on the jenkins. | {"type": "object", "properties": {"jnlpAgent": {"type": "string", "default": "jenkins/jnlp-slave:latest"}}, "additionalProperties": true} |
cloud-sdk-pipeline-config-schema.json | jnlpAgent | Docker image for jnlp agent to be used. | {"type": "string", "default": "jenkins/jnlp-slave:latest"} |
cloud-sdk-pipeline-config-schema.json | stages | Configuration, which will modify the behaviour of stages in the SAP Cloud SDK Pipeline. | {"type": ["object", "null"], "properties": {"backendIntegrationTests": {"type": "object", "properties": {"retry": {"type": "integer", "default": 1}, "forkCount": {"type": "string", "default": "1C"}, "credentials": {"type": "array", "items": {"type": "object", "properties": {"alias": {"type": "string"}, "credentialId": {"type": "string"}}, "required": ["alias", "credentialId"], "additionalProperties": false}}, "sidecarImage": {"type": "string"}, "sidecarName": {"type": "string"}, "sidecarReadyCommand": {"type": "string"}, "sidecarEnvVars": {"type": "object"}}, "additionalProperties": false}, "frontEndIntegrationTests": {"type": "object", "properties": {"dockerImage": {}}, "additionalProperties": false}, "frontEndUnitTests": {"type": "object", "properties": {"dockerImage": {}}, "additionalProperties": false}, "endToEndTests": {"type": "object", "properties": {"enableZeroDowntimeDeployment": {"type": "boolean"}, "onlyRunInProductiveBranch": {"type": "boolean"}, "appUrls": {}}}, "npmAudit": {"type": "object", "properties": {"auditedAdvisories": {"type": "array", "items": {"type": ["integer", "string"]}}}, "additionalProperties": false}, "performanceTests": {"type": "object", "properties": {"neoTargets": {}, "cfTargets": {}}}, "s4SdkQualityChecks": {"type": "object", "properties": {"jacocoExcludes": {"type": "array", "items": {"type": "string"}}, "customOdataServices": {"type": "array", "items": {"type": "string"}}, "nonErpDestinations": {"type": "array", "items": {"type": "string"}}, "nonErpUrls": {"type": "array", "items": {"type": "string"}}, "codeCoverageFrontend": {"type": "object"}, "threshold": {"type": "object", "properties": {"successCoverage": {"type": "integer", "minimum": 70}, "unstableCoverage": {"type": "integer", "minimum": 65}}, "additionalProperties": false, "required": ["successCoverage", "unstableCoverage"]}, "disabledChecks": {"type": "array", "items": {"type": "string", "enum": ["checkDeploymentDescriptors", "checkResilience", "checkServices", "checkFrontendCodeCoverage", "checkBackendCodeCoverage"]}, "default": []}}, "additionalProperties": false}, "checkmarxScan": {"type": "object", "properties": {"groupId": {"type": "string"}, "checkMarxProjectName": {"type": "string"}, "filterPattern": {"type": "string", "default": "!**/*.log, !**/*.lock, !**/*.json, !**/*.html, !**/Cx*, !**/test/**, !s4hana_pipeline/**, !**/unit-tests/**, !**/integration-tests/**, !**/frontend-unit-tests/**, !**/e2e-tests/**, !**/performance-tests/**, **/*.js, **/*.java, **/*.ts"}, "fullScansScheduled": {"type": "boolean", "default": false}, "incremental": {"type": "boolean", "default": true}, "vulnerabilityThresholdMedium": {"type": "integer", "default": 0}, "vulnerabilityThresholdLow": {"type": "integer", "default": 99999}, "preset": {"type": ["integer", "string"], "default": 36}, "checkmarxCredentialsId": {"type": "string"}, "checkmarxServerUrl": {"type": "string"}, "generatePdfReport": {"type": "boolean"}}, "required": ["groupId"], "additionalProperties": false}, "productionDeployment": {"type": "object", "properties": {"appUrls": {}, "neoTargets": {}, "cfTargets": {}}}, "artifactDeployment": {"type": "object", "properties": {"nexus": {"type": "object", "properties": {"version": {"type": "string", "enum": ["nexus2", "nexus3"], "default": "nexus3"}, "url": {"type": "string"}, "mavenRepository": {"type": "string"}, "npmRepository": {"type": "string"}, "credentialsId": {}}, "required": ["url", "repository"]}}, "additionalProperties": true}, "whitesourceScan": {"type": "object", "properties": {"product": {"type": "string"}, "staticVersion": {"type": "string"}, "credentialsId": {}, "whitesourceUserTokenCredentialsId": {"type": "string"}}, "required": ["product", "credentialsId"], "additionalProperties": true}, "sourceClearScan": {"type": "object", "properties": {"credentialsId": {}, "config": {"type": "object", "properties": {"vuln_methods_extra_ignored_directories": {"type": "string"}, "scope": {"type": "string"}}}}, "required": ["credentialsId"], "additionalProperties": false}, "compliance": {"type": "object", "properties": {"runInAllBranches": {"type": "boolean", "default": false}}, "additionalProperties": false}}} |
cloud-sdk-pipeline-config-schema.json | retry | The number of times that integration tests will retry before aborting the build. Note: This will consume more time for the jenkins build. | {"type": "integer", "default": 1} |
cloud-sdk-pipeline-config-schema.json | forkCount | The number of JVM processes that are spawned to run the tests in parallel in case of using a maven based project structure. For more details visit the surefire documentation. | {"type": "string", "default": "1C"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.