schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
cloud-sdk-pipeline-config-schema.json
credentials
The list of system credentials to be injected during integration tests. The following example will provide the username and password for the systems with the aliases ERP and SFSF. For this, it will use the Jenkins credentials entries erp-credentials and successfactors-credentials. You have to ensure that corresponding credential entries exist in your Jenkins configuration.
{"type": "array", "items": {"type": "object", "properties": {"alias": {"type": "string"}, "credentialId": {"type": "string"}}, "required": ["alias", "credentialId"], "additionalProperties": false}}
cloud-sdk-pipeline-config-schema.json
sidecarImage
Name of the Docker image that should be used.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
sidecarName
On Docker: Name of the container in the local network. On Kubernetes: Name of the container.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
sidecarReadyCommand
Command executed inside the container, which returns exit code 0 when the container is ready to be used.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
sidecarEnvVars
Environment variables to set in the container.
{"type": "object"}
cloud-sdk-pipeline-config-schema.json
enableZeroDowntimeDeployment
It is possible to activate zero downtime deployment in end-to-end tests with the option enableZeroDowntimeDeployment. This will lead to a blue-green-deployment on SCP Cloud Foundry respectively to a rolling update on SCP Neo. By default, this feature is turned off.
{"type": "boolean"}
cloud-sdk-pipeline-config-schema.json
onlyRunInProductiveBranch
Running end-to-end tests can be restricted to the productiveBranch with the option onlyRunInProductiveBranch. This might be useful when the end-to-end tests slow down development, and build failure on the productiveBranch is acceptable. By default, this feature is turned off.
{"type": "boolean"}
cloud-sdk-pipeline-config-schema.json
npmAudit
This stage uses the npm audit command to check for known vulnerabilities in dependencies.
{"type": "object", "properties": {"auditedAdvisories": {"type": "array", "items": {"type": ["integer", "string"]}}}, "additionalProperties": false}
cloud-sdk-pipeline-config-schema.json
auditedAdvisories
In case you audited an advisory, and it turns out to be a false positive, you can mark it as audited by adding its id to the auditedAdvisories in the stage configuration. A false positive in this case is when you are confident your application is not affected in any way by the underlying bug or vulnerability.
{"type": "array", "items": {"type": ["integer", "string"]}}
cloud-sdk-pipeline-config-schema.json
jacocoExcludes
A list of exclusions expressed as an Ant-style pattern relative to the application folder. An example can be found below.
{"type": "array", "items": {"type": "string"}}
cloud-sdk-pipeline-config-schema.json
customOdataServices
We recommend only using OData services listed in the in SAP API Business Hub. Despite that for using custom business objects you can add those APIs here.
{"type": "array", "items": {"type": "string"}}
cloud-sdk-pipeline-config-schema.json
nonErpDestinations
List of destination names that do not refer to ERP systems. Use this parameter to exclude specific destinations from being checked in context of ERP API whitelists.
{"type": "array", "items": {"type": "string"}}
cloud-sdk-pipeline-config-schema.json
nonErpUrls
List of URLs that are not defined as destinations. Use this parameter to exclude specific URLs from being checked in context of ERP API whitelists.
{"type": "array", "items": {"type": "string"}}
cloud-sdk-pipeline-config-schema.json
codeCoverageFrontend
A map containing the thresholds unstable and failing. If the code coverage is lower than what is configured in unstable, the pipeline result is unstable. If it is lower than what is configured in failing, the pipeline will fail.
{"type": "object"}
cloud-sdk-pipeline-config-schema.json
threshold
This setting allows the code coverage to be stricter compared to the default values. By default, the pipeline will fail if the coverage is below 65% line coverage (unstableCoverage), and will be unstable if it is less than 70% (successCoverage). If lower numbers are configured, or this configuration is left out, the default values are applied.
{"type": "object", "properties": {"successCoverage": {"type": "integer", "minimum": 70}, "unstableCoverage": {"type": "integer", "minimum": 65}}, "additionalProperties": false, "required": ["successCoverage", "unstableCoverage"]}
cloud-sdk-pipeline-config-schema.json
disabledChecks
A list of checks which should not be executed. Possible values are: checkDeploymentDescriptors (Check for insecure options, such as ALLOW_MOCKED_AUTH_HEADER in deployment descriptors), checkResilience(Check that application is resilient to faults in the network), checkServices (Check that only official APIs are used), checkFrontendCodeCoverage (Ensures high frontend code coverage), checkBackendCodeCoverage (Ensures high backend code coverage)
{"type": "array", "items": {"type": "string", "enum": ["checkDeploymentDescriptors", "checkResilience", "checkServices", "checkFrontendCodeCoverage", "checkBackendCodeCoverage"]}, "default": []}
cloud-sdk-pipeline-config-schema.json
checkmarxScan
Checkmarx is one of the security analysis tools which is supported by the pipeline.
{"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}
cloud-sdk-pipeline-config-schema.json
groupId
Checkmarx Group ID
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
checkMarxProjectName
Name of the project on Checkmarx server.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
filterPattern
Files which needs to be skipped during scanning.
{"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"}
cloud-sdk-pipeline-config-schema.json
fullScansScheduled
Toggle to enable or disable full scan on a certain schedule.
{"type": "boolean", "default": false}
cloud-sdk-pipeline-config-schema.json
incremental
Perform incremental scan with every run. If turned false, complete project is scanned on every submission.
{"type": "boolean", "default": true}
cloud-sdk-pipeline-config-schema.json
vulnerabilityThresholdMedium
The threshold for medium level threats. If the findings are greater than this value, pipeline execution will result in failure.
{"type": "integer", "default": 0}
cloud-sdk-pipeline-config-schema.json
vulnerabilityThresholdLow
The threshold for low level threats. If the findings are greater than this value, pipeline execution will result in failure.
{"type": "integer", "default": 99999}
cloud-sdk-pipeline-config-schema.json
preset
Name or numerical ID of Checkmarx preset to be used when scanning this project. When a name (string) is specified, the pipeline will try to discover the corresponding numerical ID via the Checkmarx API. Please also make sure to specify checkmarxCredentialsId and checkmarxServerUrl in such a case. For determining available presets in your Checkmarx webclient, go to Checkmarx -> Management -> Scan Settings -> Preset Manager. Alternatively, you can determine the numerical ID of your targeted preset by following those guides: Token-based Authentication and Get All Preset Details.
{"type": ["integer", "string"], "default": 36}
cloud-sdk-pipeline-config-schema.json
checkmarxCredentialsId
The Credential ID to connect to Checkmarx server. The credentials must be type username with password. This property becomes mandatory if the credentials are not configured in the Jenkins plugin itself.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
checkmarxServerUrl
An URL to Checkmarx server. This property becomes mandatory if the URL to the Checkmarx server is not configured in the Jenkins plugin itself or if the checkmarxCredentialsId is configured.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
generatePdfReport
Possibility to generate PDF reports of the scan.
{"type": "boolean"}
cloud-sdk-pipeline-config-schema.json
artifactDeployment
The deployment of artifacts to nexus can be configured with a map containing the following properties.
{"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}
cloud-sdk-pipeline-config-schema.json
version
Version of nexus. Can be nexus2 or nexus3.
{"type": "string", "enum": ["nexus2", "nexus3"], "default": "nexus3"}
cloud-sdk-pipeline-config-schema.json
url
URL of the nexus. The scheme part of the URL will not be considered, because only http is supported.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
mavenRepository
Name of the nexus repository for Maven and MTA artifacts. Ignored if the project does not contain pom.xml or mta.yml in the project root.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
npmRepository
Name of the nexus repository for NPM artifacts. Ignored if the project does not contain a package.json in the project root directory.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
whitesourceScan
Configure credentials for WhiteSource scans. The minimum required Maven WhiteSource plugin version is 18.6.2, ensure this in the plugins section of the project pom.xml file. Pipeline will execute npx whitesource run for npm projects. Please ensure that all package.json files have a name and version configured so that it is possible to distinguish between the different packages.
{"type": "object", "properties": {"product": {"type": "string"}, "staticVersion": {"type": "string"}, "credentialsId": {}, "whitesourceUserTokenCredentialsId": {"type": "string"}}, "required": ["product", "credentialsId"], "additionalProperties": true}
cloud-sdk-pipeline-config-schema.json
product
Name of your product in WhiteSource.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
staticVersion
Overwrites the respective version in the whitesource UI per scan with the staticVersion. Per default for every new version of a pom/package.json a new project will be created in the whitesource UI. To deactivate the creation of new projects and always have a fixed version for each project in the whitesource UI, configure the staticVersion.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
whitesourceUserTokenCredentialsId
Unique identifier of the Secret Text on Jenkins server that stores WhiteSource userKey of a user. This is required only if the administrator of the WhiteSource service has enabled additional access level control. More details can be found here.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
sourceClearScan
Configure SourceClear scans.Note: Please note that the SourceClear stage of this pipeline is not actively maintained anymore. In case of issues, feel free to contribute to this project by opening a pull request.
{"type": "object", "properties": {"credentialsId": {}, "config": {"type": "object", "properties": {"vuln_methods_extra_ignored_directories": {"type": "string"}, "scope": {"type": "string"}}}}, "required": ["credentialsId"], "additionalProperties": false}
cloud-sdk-pipeline-config-schema.json
config
Additional configuration for the SourceClear agent. The key-value pairs will be added to srcclr.yml.
{"type": "object", "properties": {"vuln_methods_extra_ignored_directories": {"type": "string"}, "scope": {"type": "string"}}}
cloud-sdk-pipeline-config-schema.json
compliance
Configure the stage Compliance, which currently executes a SonarQube (https://www.sonarqube.org/) scan.
{"type": "object", "properties": {"runInAllBranches": {"type": "boolean", "default": false}}, "additionalProperties": false}
cloud-sdk-pipeline-config-schema.json
runInAllBranches
Define whether the scan should also happen in non productive branches, i.e. if your SonarQube instance supports that.
{"type": "boolean", "default": false}
cloud-sdk-pipeline-config-schema.json
mavenExecute
The mavenExecute step is used for all invocations of the mvn build tool. It is either used directly for executing specific maven phases such as test, or indirectly for steps that execute maven plugins such as checkPmd.
{"type": "object", "properties": {"dockerImage": {"default": "maven:3.6.3-jdk-8-slim"}, "projectSettingsFile": {"type": "string"}}}
cloud-sdk-pipeline-config-schema.json
projectSettingsFile
The project settings.xml to be used for maven builds. You can specify a relative path to your project root or a URL starting with http or https.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
artifactPrepareVersion
If automatic versioning is enabled, this step is used to set a common version for artifacts and optionally push a corresponding tag.
{"type": "object", "properties": {"dockerImage": {}, "commitUserName": {"type": "string"}, "includeCommitId": {"type": "boolean", "default": "true"}, "tagPrefix": {"type": "string"}, "unixTimestamp": {"type": "boolean", "default": "false"}, "versioningType": {"type": "string"}}}
cloud-sdk-pipeline-config-schema.json
commitUserName
Defines the user name which appears in version control for the versioning update (in case versioningType: cloud).
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
includeCommitId
Defines if the automatically generated version (versioningType: cloud) should include the commit id hash.
{"type": "boolean", "default": "true"}
cloud-sdk-pipeline-config-schema.json
tagPrefix
Defines the prefix which is used for the git tag which is written during the versioning run (only versioningType: cloud).
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
unixTimestamp
Defines if the Unix timestamp number should be used as build number instead of the standard date format.
{"type": "boolean", "default": "false"}
cloud-sdk-pipeline-config-schema.json
versioningType
Defines the type of versioning (cloud: fully automatic, cloud_noTag: automatic but no tag created, library: manual)
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
executeNpm
The executeNpm step is used for all invocations of the npm build tool. It is, for example, used for building the frontend and for executing end to end tests.
{"type": "object", "properties": {"dockerImage": {"default": "ppiper/node-browsers:v2"}, "defaultNpmRegistry": {"type": "string", "default": "npmjs.com"}}}
cloud-sdk-pipeline-config-schema.json
defaultNpmRegistry
The default npm registry url to be used as the remote mirror. Bypasses the local download cache if specified.
{"type": "string", "default": "npmjs.com"}
cloud-sdk-pipeline-config-schema.json
cloudFoundryDeploy
A step configuration regarding Cloud Foundry deployment. This is required by stages like end-to-end tests, performance tests, and production deployment.
{"type": "object", "properties": {"dockerImage": {"default": "ppiper/cf-cli:v2"}, "smokeTestStatusCode": {"type": "integer", "default": 200}, "keepOldInstance": {"type": "boolean", "default": true}, "cloudFoundry": {}}}
cloud-sdk-pipeline-config-schema.json
smokeTestStatusCode
Expected return code for smoke test success.
{"type": "integer", "default": 200}
cloud-sdk-pipeline-config-schema.json
keepOldInstance
In case of a blue-green deployment the old instance will be stopped and will remain in the Cloud Foundry space by default. If this option is set to false, the old instance will be deleted.
{"type": "boolean", "default": true}
cloud-sdk-pipeline-config-schema.json
neo
The map for neo.
{"type": "object", "properties": {"host": {}, "account": {}, "application": {}, "credentialsId": {}, "environment": {}, "vmArguments": {}, "size": {}, "runtime": {}, "runtimeVersion": {}}, "required": ["host", "account", "application", "runtime", "runtimeVersion"], "additionalProperties": false}
cloud-sdk-pipeline-config-schema.json
checkGatling
Gatling is used as one of the performance tests tool.
{"type": "object", "properties": {"enabled": {"type": "boolean", "default": false}}}
cloud-sdk-pipeline-config-schema.json
enabled
You can enable Gatling tests by turning the flag to true.
{"type": "boolean", "default": false}
cloud-sdk-pipeline-config-schema.json
checkJMeter
Apache JMeter is executed as part of performance tests of the application. The user is free to choose between JMeter and Gatling or both.
{"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}}}
cloud-sdk-pipeline-config-schema.json
options
Options such as proxy.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
testPlan
The directory where the test plans reside. Should reside in a subdirectory under performance-tests directory if both JMeter and Gatling are enabled.
{"type": "string", "default": "./performance-tests/*"}
cloud-sdk-pipeline-config-schema.json
failThreshold
Marks build as FAILURE if the value exceeds the threshold.
{"type": "integer", "default": 100}
cloud-sdk-pipeline-config-schema.json
unstableThreshold
Marks build as UNSTABLE if the value exceeds the threshold.
{"type": "integer", "default": 90}
cloud-sdk-pipeline-config-schema.json
verbose
Sends the verbose output to the Jenkins log.
{"type": "boolean", "default": false}
cloud-sdk-pipeline-config-schema.json
fortifyCredentialsId
Jenkins 'Secret text' credentials ID containing token to authenticate to Fortify SSC.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
githubTokenCredentialsId
Jenkins 'Secret text' credentials ID containing token to authenticate to GitHub.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
serverUrl
Fortify SSC Url to be used for accessing the APIs
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
projectName
The project used for reporting results in SSC
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
defaultVersioningModel
The default project versioning model used in case 'projectVersion' parameter is empty for creating the version based on the build descriptor version to report results in SSC, can be one of 'major', 'major-minor', 'semantic', 'full'
{"type": "string", "default": "major"}
cloud-sdk-pipeline-config-schema.json
buildTool
Scan type used for the step which can be 'maven', 'pip'
{"type": "string", "default": "maven"}
cloud-sdk-pipeline-config-schema.json
autoCreate
Whether Fortify project and project version shall be implicitly auto created in case they cannot be found in the backend
{"type": "boolean", "default": false}
cloud-sdk-pipeline-config-schema.json
uploadResults
Whether results shall be uploaded or not
{"type": "boolean", "default": true}
cloud-sdk-pipeline-config-schema.json
memory
The amount of memory granted to the translate/scan executions
{"type": "string", "default": "-Xmx4G -Xms512M"}
cloud-sdk-pipeline-config-schema.json
src
A list of source directories to scan. Wildcards can be used, e.g., 'src/main/java/**/*'. The default value for buildTool: 'maven' is ['**/*.xml', '**/*.html', '**/*.jsp', '**/*.js', '**/src/main/resources/**/*', '**/src/main/java/**/*'], for buildTool: 'pip' it is ['./**/*'].
{"type": "array", "items": {"type": "string"}}
cloud-sdk-pipeline-config-schema.json
exclude
A list of directories/files to be excluded from the scan. Wildcards can be used, e.g., '**/Test.java'.
{"type": "array", "items": {"type": "string"}}
cloud-sdk-pipeline-config-schema.json
whitesourceExecuteScan
Configure credentials for WhiteSource scans. The minimum required Maven WhiteSource plugin version is 18.6.2, ensure this in the plugins section of the project pom.xml file. Pipeline will execute npx whitesource run for npm projects. Please ensure that all package.json files have a name configured so that it is possible to distinguish between the different packages.
{"type": "object", "properties": {"productName": {"type": "string"}, "productVersion": {"type": "string"}, "orgAdminUserTokenCredentialsId": {}, "userTokenCredentialsId": {"type": "string"}}, "required": ["productName", "orgAdminUserTokenCredentialsId"], "additionalProperties": true}
cloud-sdk-pipeline-config-schema.json
productName
Name of your product in WhiteSource.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
productVersion
Overwrites the project version in the WhiteSource UI per scan with the given version. Per default, the version from the main build descriptor file is used and transformed according to the versioningModel parameter, i.e. "1" for the default model of "major".
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
userTokenCredentialsId
Unique identifier of the Secret Text on Jenkins server that stores WhiteSource userKey of a user. This is required only if the administrator of the WhiteSource service has enabled additional access level control. More details can be found here.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
buildTarget
The target platform to which the mtar can be deployed.
{"type": "string", "default": "NEO"}
cloud-sdk-pipeline-config-schema.json
mtaBuildTool
Choose which tool is used to build your mta project. The default option is `cloudMbt` which is not backwards compatible with the `classic` tool. For more information on migrating from `classic` to `cloudMbt`, please refer to https://sap.github.io/cloud-mta-build-tool/migration/.
{"type": "string", "default": "cloudMbt"}
cloud-sdk-pipeline-config-schema.json
applicationName
The name of the application which is being built. If the parameter has been provided and no mta.yaml exists, the mta.yaml will be automatically generated using this parameter and the information (name and version) from package.json before the actual build starts.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
defaultNpmRegistry
Url to the npm registry that should be used for installing npm dependencies.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
dockerOptions
Docker options to be set when starting the container (List or String).
{"type": ["array", "string"]}
cloud-sdk-pipeline-config-schema.json
extension
The path to the extension descriptor file.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
globalSettingsFile
Path or url to the mvn settings file that should be used as global settings file.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
projectSettingsFile
Path or url to the mvn settings file that should be used as project settings file.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
mtaJarLocation
The location of the SAP Multitarget Application Archive Builder jar file, including file name and extension. If it is not provided, the SAP Multitarget Application Archive Builder is expected on PATH.
{"type": "string", "default": "/opt/sap/mta/lib/mta.jar"}
cloud-sdk-pipeline-config-schema.json
debugReportArchive
The debugReportArchive configuration can be used to create confidential (instead of redacted) debug reports. The difference between the redacted and the confidential debug report is that potentially confidential information, such as the GitHub repository and branch, global extension repository and shared libraries, are included in the confidential debug report. It is the user's responsibility to make sure that the debug report does not contain any confidential information.
{"type": "object", "properties": {"shareConfidentialInformation": {"type": "boolean", "default": false}}}
cloud-sdk-pipeline-config-schema.json
shareConfidentialInformation
If set to true, a confidential debug report is being generated with each build.
{"type": "boolean", "default": false}
cloud-sdk-pipeline-config-schema.json
sonarExecuteScan
Configure SonarQube (https://www.sonarqube.org/) scans.
{"type": "object", "properties": {"projectKey": {"type": "string"}, "instance": {"type": "string"}, "options": {"type": ["array", "string"]}, "dockerImage": {"default": "ppiper/node-browsers:v3"}}, "required": ["projectKey", "instance"], "additionalProperties": true}
cloud-sdk-pipeline-config-schema.json
projectKey
The project key is used to refer your project.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
instance
This property refers to a SonarQube instance, which needs to be defined in the Jenkins.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
options
A list of additional options (in the form of '-Dxy=z') to be passed to the sonar scanner tool.
{"type": ["array", "string"]}
cloud-sdk-pipeline-config-schema.json
tmsUpload
This step allows you to upload an MTA file (multi-target application archive) and multiple MTA extension descriptors into a TMS (SAP Cloud Platform Transport Management Service) landscape for further TMS-controlled distribution through a TMS-configured landscape.
{"type": "object", "properties": {"nodeName": {"type": "string"}, "credentialsId": {"type": "string"}, "customDescription": {"type": "string", "default": "<Corresponding Git Commit-ID>"}}}
cloud-sdk-pipeline-config-schema.json
nodeName
Defines the name of the node to which the *.mtar file should be uploaded.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
credentialsId
Credentials to be used for the file and node uploads to the Transport Management Service.
{"type": "string"}
cloud-sdk-pipeline-config-schema.json
customDescription
Can be used as the description of a transport request. Will overwrite the default.
{"type": "string", "default": "<Corresponding Git Commit-ID>"}
vega.json
scale
Discretizing scales
{"properties": {"type": {"enum": ["quantile", "quantize", "threshold", "bin-ordinal"]}, "range": {"oneOf": [{"enum": ["width", "height", "symbol", "category", "ordinal", "ramp", "diverging", "heatmap"]}, {"type": "array", "items": {"oneOf": [{"type": "null"}, {"type": "boolean"}, {"type": "string"}, {"type": "number"}, {}]}}, {}, {"type": "object", "properties": {"scheme": {}, "count": {}, "extent": {"oneOf": [{"type": "array", "items": {}, "numItems": 2}, {}]}}, "required": ["scheme"], "additionalProperties": false}]}, "nice": {"oneOf": [{"type": "boolean"}, {"type": "number"}, {}]}, "zero": {}}, "required": ["type"]}
vega.json
scale
Default numeric scale
{"not": {"properties": {"type": {"enum": ["ordinal", "band", "point", "quantile", "quantize", "threshold", "sequential", "pow", "log", "time", "utc", "identity", "bin-ordinal", "bin-linear"]}}, "required": ["type"]}, "properties": {"range": {"oneOf": [{"enum": ["width", "height", "symbol", "category", "ordinal", "ramp", "diverging", "heatmap"]}, {"type": "array", "items": {"oneOf": [{"type": "null"}, {"type": "boolean"}, {"type": "string"}, {"type": "number"}, {}]}}, {}, {"type": "object", "properties": {"scheme": {}, "count": {}, "extent": {"oneOf": [{"type": "array", "items": {}, "numItems": 2}, {}]}}, "required": ["scheme"], "additionalProperties": false}]}, "interpolate": {}, "clamp": {}, "padding": {"type": "number"}, "nice": {"oneOf": [{"type": "boolean"}, {"type": "number"}, {}]}, "zero": {}}}
localazy.json
Schema definition for Localazy CLI configuration file.
{"$schema": "http://json-schema.org/draft-07/schema", "type": "object", "default": {}, "required": [], "additionalProperties": false, "properties": {"$schema": {"type": "string", "default": "https://raw.githubusercontent.com/localazy/cli-schema/master/localazy.json"}, "writeKey": {"type": "string"}, "readKey": {"type": "string"}, "branch": {"type": "string"}, "community": {"type": "object", "properties": {"author": {"type": "string"}, "email": {"type": "string"}, "company": {"type": "string"}, "website": {"type": "string"}, "tags": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false, "patternProperties": {"^\\$.*$": {"type": ["string", "array", "object", "number", "boolean"]}}}, "transformations": {"type": ["array", "object"], "anyOf": [{"type": "array", "items": {}}, {}]}, "upload": {"type": "object", "properties": {"deprecateMissing": {"type": "boolean", "default": false}, "deprecate": {"type": "string", "default": "none", "enum": ["file", "project", "none"]}, "importAsNew": {"type": "boolean", "default": false}, "allowDuplicateKeys": {"type": "boolean", "default": false}, "skipFailedAutodetection": {"type": "boolean", "default": true}, "filterSource": {"type": "boolean"}, "forceCurrent": {"type": "boolean", "default": false}, "appVersion": {"type": "number", "default": 0}, "type": {"type": "string", "enum": ["android", "json", "arb", "ios-strings", "ios-plist", "ios-stringsdict", "xliff", "resx", "yaml", "po", "pot", "json5", "hjson", "js", "properties", "ini", "php", "qt-ts", "text", "csv", "neon", "toml", "excel", "ods", "srt"]}, "folder": {"type": "string"}, "features": {"type": ["string", "array"], "anyOf": [{}, {"type": "array", "items": {}}]}, "keySeparator": {"type": "string", "default": "."}, "includeKeys": {"type": "array", "items": {"type": "string"}}, "excludeKeys": {"type": "array", "items": {"type": "string"}}, "files": {"type": ["string", "array", "object"], "anyOf": [{"type": "string"}, {"type": "array", "items": {}}, {}]}}, "additionalProperties": false, "patternProperties": {"^\\$.*$": {"type": ["string", "array", "object", "number", "boolean"]}}}, "conversion": {"type": "object", "properties": {"folder": {"type": "string"}, "excludedLangs": {"type": "array", "items": {"type": "string"}}, "actions": {"type": ["array", "object"], "anyOf": [{"type": "array", "items": {}}, {}]}}, "additionalProperties": false, "patternProperties": {"^\\$.*$": {"type": ["string", "array", "object", "number", "boolean"]}}}, "download": {"type": "object", "properties": {"includeSourceLang": {"type": "boolean", "default": false}, "folder": {"type": "string"}, "metadataFileJson": {"type": "string"}, "metadataFileJs": {"type": "string"}, "metadataFileTs": {"type": "string"}, "langAliases": {"type": "object", "additionalProperties": true}, "langExpansions": {"type": "object", "additionalProperties": true}, "excludedLangs": {"type": ["array", "string"], "anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "files": {"type": ["string", "array", "object"], "anyOf": [{"type": "string"}, {"type": "array", "items": {}}, {}]}}, "additionalProperties": false, "patternProperties": {"^\\$.*$": {"type": ["string", "array", "object", "number", "boolean"]}}}}, "definitions": {"transformations": {"type": "object", "properties": {"name": {"type": "string"}, "source": {"type": "string"}, "operations": {"type": ["string", "array"], "anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}}, "additionalProperties": false, "patternProperties": {"^\\$.*$": {"type": ["string", "array", "object", "number", "boolean"]}}}, "features": {"type": "string", "enum": ["escape_new_lines", "content_as_array", "content_as_object", "requirejs", "multilingual", "filter_untranslated", "array", "array_br", "plural_array", "plural_postfix_dd", "plural_postfix_sd", "plural_postfix_us", "plural_postfix_cc", "plural_postfix_br", "plural_pipeline", "plural_i18next", "plural_object", "plural_icu", "arb_metadata", "arb_locale_lang", "arb_locale_full", "source_is_key", "skip_empty", "add_bom", "parse_array", "parse_plurals", "parse_others", "skip_plurals", "output_entities", "dont_parse_source", "dont_parse_target", "use_project_lang", "use_defined_lang_for_source", "use_defined_lang_for_target", "use_unicode", "parse_plurals_ios", "parse_plurals_icu", "omit_id_for_source_is_key", "decode_html_entities", "store_attrs", "lang_root", "output_mo", "empty_untranslated", "use_key_for_content", "force_key_for_content", "ignore_blank_content", "output_json", "force_quotes", "latin1", "force_escaping", "source_is_content", "prefer_source_as_key", "include_source", "prefer_message_id", "no_header", "delimiter_tab", "delimiter_semicolon", "quote_single", "quote_backslash", "line_rn", "line_nr", "line_n", "line_r", "columns=", "included_langs=", "lang_format=ll-rr#scrp", "lang_format=ll-rr-scrp", "lang_format=ll-scrp-rr", "lang_format=ll-scrp_rr", "lang_format=ll_rr_scrp", "lang_format=ll_scrp_rr", "lang_format=ll+rr+scrp", "lang_format=ll+scrp+rr", "lang_format=locale_name", "lang_format=bcp", "lang_format=android_noscript", "lang_format=android", "encoding=win-1252", "encoding=iso-8859-1", "encoding=auto", "encoding=utf8", "encoding=utf16", "encoding=utf16le", "encoding=utf16be", "encoding=ansi"]}, "conditions": {"type": ["string", "array"], "anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "subtype": {"type": "object", "properties": {"type": {"type": "string", "enum": ["android", "json", "arb", "ios-strings", "ios-plist", "ios-stringsdict", "xliff", "resx", "yaml", "po", "pot", "json5", "hjson", "js", "properties", "ini", "php", "qt-ts", "text", "csv", "neon", "toml", "excel", "ods", "srt"]}, "features": {"type": ["string", "array"], "anyOf": [{}, {"type": "array", "items": {}}]}, "lang": {"type": "string", "default": "inherited"}, "group": {"type": "string"}, "buildType": {"type": "string"}, "productFlavors": {"type": "string"}, "module": {"type": "string"}, "library": {"type": "string"}, "path": {"type": "string"}, "file": {"type": "string"}, "pattern": {"type": "string"}, "excludes": {"type": "array", "items": {"type": "string"}}, "conditions": {"type": ["string", "array"], "anyOf": [{"type": "string"}, {"type": "array", "items": {}}]}}, "additionalProperties": false, "patternProperties": {"^\\$.*$": {"type": ["string", "array", "object", "number", "boolean"]}}}, "files": {"type": ["string", "object"], "anyOf": [{"type": "string"}, {}]}, "actions": {"type": "object", "properties": {"group": {"type": "string"}, "conditions": {"type": ["string", "array"], "anyOf": [{"type": "string"}, {"type": "array", "items": {}}]}, "keySeparator": {"type": "string", "default": "."}, "includeKeys": {"type": "array", "items": {"type": "string"}}, "excludeKeys": {"type": "array", "items": {"type": "string"}}, "replacements": {"type": "object", "additionalProperties": true}, "langAliases": {"type": "object", "additionalProperties": true}, "langExpansions": {"type": "object", "additionalProperties": true}, "stop": {"type": "boolean", "default": false}, "changeExtension": {"type": "string"}, "output": {"type": "string"}, "type": {"type": "string", "enum": ["android", "arb", "csv", "csv-multilingual", "excel", "excel-multilingual", "ini", "ini-multilingual", "ios-strings", "ios-stringsdict", "json", "json-mozilla", "json-multilingual", "mo", "neon", "neon-multilingual", "ods", "ods-multilingual", "php", "php-multilingual", "po", "toml", "toml-multilingual", "yaml", "yaml-multilingual", "yaml-rails"]}, "arrayType": {"type": "string", "enum": ["array", "array_br"]}, "pluralType": {"type": "string", "enum": ["plural_postfix_br", "plural_postfix_sd", "plural_postfix_dd", "plural_postfix_us", "plural_postfix_cc", "plural_i18next", "plural_object", "plural_icu", "plural_array"]}, "forceArrayType": {"type": "boolean", "default": false}, "forcePluralType": {"type": "boolean", "default": false}, "filterStrings": {"type": "boolean"}, "filterArrays": {"type": "boolean"}, "filterPlurals": {"type": "boolean"}, "params": {"type": "object", "additionalProperties": true}}, "additionalProperties": false, "patternProperties": {"^\\$.*$": {"type": ["string", "array", "object", "number", "boolean"]}}}, "subtype_1": {"type": "object", "properties": {"group": {"type": "string"}, "conditions": {"type": ["string", "array"], "anyOf": [{"type": "string"}, {"type": "array", "items": {}}]}, "stop": {"type": "boolean", "default": false}, "output": {"type": "string"}}, "additionalProperties": false, "patternProperties": {"^\\$.*$": {"type": ["string", "array", "object", "number", "boolean"]}}}, "files_2": {"type": ["string", "object"], "anyOf": [{"type": "string"}, {}]}}, "patternProperties": {"^\\$.*$": {"type": ["string", "array", "object", "number", "boolean"]}}}