schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
phraseapp.json
file
Translation file which will be uploaded
{"type": "string", "default": "<locale_name>.yml"}
phraseapp.json
params
Locale upload parameter
{"type": "object", "properties": {"branch": {"type": "string"}, "file_format": {}, "locale_id": {}, "tags": {"type": "string"}, "update_translations": {"type": "boolean", "default": false}, "update_descriptions": {"type": "boolean", "default": false}, "convert_emoji": {"type": "boolean", "default": false}, "skip_upload_tags": {"type": "boolean", "default": false}, "skip_unverification": {"type": "boolean", "default": false}, "file_encoding": {}, "format_options": {"type": "object", "properties": {"column_separator": {"type": "string", "default": ";"}}}}}
phraseapp.json
branch
Branch name
{"type": "string"}
phraseapp.json
tags
List of tags separated by comma to be associated with the new keys contained in the upload
{"type": "string"}
phraseapp.json
update_translations
Indicates whether existing translations should be updated with the file content
{"type": "boolean", "default": false}
phraseapp.json
update_descriptions
Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions
{"type": "boolean", "default": false}
phraseapp.json
convert_emoji
Indicates whether the file contains Emoji symbols that should be converted
{"type": "boolean", "default": false}
phraseapp.json
skip_upload_tags
Indicates whether the upload should not create upload tags
{"type": "boolean", "default": false}
phraseapp.json
skip_unverification
Indicates whether the upload should unverify updated translations
{"type": "boolean", "default": false}
phraseapp.json
format_options
Additional options available for specific formats. See our format guide for complete list
{"type": "object", "properties": {"column_separator": {"type": "string", "default": ";"}}}
phraseapp.json
column_separator
Colum separator character
{"type": "string", "default": ";"}
phraseapp.json
targets
List of files that will be downloaded on pull
{"minItems": 1, "type": "array", "items": {"type": "object", "properties": {"file": {"type": "string", "default": "<locale_name>.yml"}, "project_id": {}, "params": {"type": "object", "properties": {"branch": {"type": "string"}, "file_format": {}, "tag": {"type": "string", "default": ""}, "locale_id": {}, "include_empty_translations": {"type": "boolean", "default": false}, "keep_notranslate_tags": {"type": "boolean", "default": false}, "convert_emoji": {"type": "boolean", "default": false}, "encoding": {}, "skip_unverified_translations": {"type": "boolean", "default": false}, "fallback_locale_id": {"type": "string"}}}}}}
phraseapp.json
file
Translation file which will be downloaded
{"type": "string", "default": "<locale_name>.yml"}
phraseapp.json
params
Locale download parameter
{"type": "object", "properties": {"branch": {"type": "string"}, "file_format": {}, "tag": {"type": "string", "default": ""}, "locale_id": {}, "include_empty_translations": {"type": "boolean", "default": false}, "keep_notranslate_tags": {"type": "boolean", "default": false}, "convert_emoji": {"type": "boolean", "default": false}, "encoding": {}, "skip_unverified_translations": {"type": "boolean", "default": false}, "fallback_locale_id": {"type": "string"}}}
phraseapp.json
branch
Branch name
{"type": "string"}
phraseapp.json
tag
Limit result to keys tagged with the given tag (identified by its name)
{"type": "string", "default": ""}
phraseapp.json
include_empty_translations
Indicates whether keys without translations should be included in the output as well
{"type": "boolean", "default": false}
phraseapp.json
keep_notranslate_tags
Indicates whether [NOTRANSLATE] tags should be kept
{"type": "boolean", "default": false}
phraseapp.json
convert_emoji
Indicates whether Emoji symbols should be converted to actual Emojis
{"type": "boolean", "default": false}
phraseapp.json
skip_unverified_translations
Indicates whether the locale file should skip all unverified translations
{"type": "boolean", "default": false}
phraseapp.json
fallback_locale_id
If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to true
{"type": "string"}
artifacts.json
The artifacts configuration
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": {}, "definitions": {"artifactsByTypeDefinition": {"type": "object", "properties": {"commands": {"type": "object", "additionalProperties": {}}, "events": {"type": "object", "additionalProperties": {}}, "eventSources": {"type": "object", "additionalProperties": {}}, "readModels": {"type": "object", "additionalProperties": {}}, "queries": {"type": "object", "additionalProperties": {}}}, "required": ["commands", "events", "eventSources", "readModels", "queries"]}, "artifactDefinition": {"type": "object", "properties": {"generation": {"type": "number"}, "type": {"type": "string"}}, "required": ["generation", "type"]}}}
artifacts.json
artifactsByTypeDefinition
The artifacts by type definition
{"type": "object", "properties": {"commands": {"type": "object", "additionalProperties": {}}, "events": {"type": "object", "additionalProperties": {}}, "eventSources": {"type": "object", "additionalProperties": {}}, "readModels": {"type": "object", "additionalProperties": {}}, "queries": {"type": "object", "additionalProperties": {}}}, "required": ["commands", "events", "eventSources", "readModels", "queries"]}
artifacts.json
commands
The command artifacts of a Feature
{"type": "object", "additionalProperties": {}}
artifacts.json
events
The event artifacts of a Feature
{"type": "object", "additionalProperties": {}}
artifacts.json
eventSources
The event source artifacts of a Feature
{"type": "object", "additionalProperties": {}}
artifacts.json
readModels
The read model artifacts of a Feature
{"type": "object", "additionalProperties": {}}
artifacts.json
queries
The query artifacts of a Feature
{"type": "object", "additionalProperties": {}}
artifacts.json
artifactDefinition
The definition of an artifact
{"type": "object", "properties": {"generation": {"type": "number"}, "type": {"type": "string"}}, "required": ["generation", "type"]}
artifacts.json
generation
The artifact generation
{"type": "number"}
artifacts.json
type
The CLR Type represented by the artifact
{"type": "string"}
bamboo-spec.json
Full spec reference: https://docs.atlassian.com/bamboo-specs-docs/7.2.4/specs.html
{"$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": {}, "definitions": {"deployment": {"type": "object", "properties": {"name": {"type": "string"}, "source-plan": {"type": "string"}}}, "docker": {"anyOf": [{"type": "string"}, {"type": "object", "properties": {"image": {"type": "string"}, "volumes": {"type": "object", "default": {}}, "use-default-volumes": {"type": "boolean", "default": false}, "docker-run-arguments": {"type": "array", "items": {"type": "string"}}}, "required": ["image"]}]}, "events": {"type": "string", "enum": ["plan-failed", "plan-completed", "plan-status-changed", "plan-comment-added", "plan-responsibility-changed", "job-completed", "job-status-changed", "job-failed", "job-error", "job-first-failed", "job-hung", "job-queue-timeout", "job-queued-without-capable-agents"]}, "job": {"definitions": {"artifact": {"type": "object", "properties": {"location": {"type": "string"}, "name": {"type": "string"}, "pattern": {"type": "string"}, "required": {"type": "boolean"}, "shared": {"type": "boolean", "default": false}}}, "task": {"type": "object", "properties": {"interpreter": {"type": "string"}, "clean": {"type": "object"}, "checkout": {"type": "object", "properties": {"repository": {"type": "string"}, "path": {"type": "string"}, "force-clean-build": {"type": "string", "default": false}}}, "inject-variables": {"anyOf": [{"type": "string"}, {"type": "object", "additionalProperties": false, "properties": {"file": {"type": "string"}, "scope": {"type": "string"}, "namespace": {"type": "string"}}}]}, "test-parser": {"anyOf": [{}, {"type": "object", "properties": {"type": {}, "ignore-time": {"type": "boolean"}, "test-results": {"type": "array", "items": {"type": "string"}}}, "required": ["type"]}]}, "scripts": {"type": "array", "minItems": 1, "items": {}}}}}, "type": "object", "properties": {"docker": {}, "final-tasks": {"type": "array"}, "key": {"type": "string"}, "other": {"type": "object", "properties": {"clean-working-dir": {"type": "boolean"}}}, "requirements": {"type": "array", "items": {"anyOf": [{"type": "string"}, {"type": "object", "patternProperties": {".": {"type": "string"}}}]}}, "tasks": {"type": "array", "items": {"anyOf": [{}, {}, {}]}}}}, "keyValue": {"type": "object", "patternProperties": {"[a-zA-Z0-9_]": {"anyOf": [{"type": "string"}, {"type": "integer"}, {"type": "boolean"}, {"type": "number"}]}}}, "notification": {"type": "object", "properties": {"recipients": {"type": "array", "anyOf": [{"type": "object", "properties": {"users": {"type": "array", "items": {"type": "string"}}}}, {"type": "object", "properties": {"groups": {"type": "array", "items": {"type": "string"}}}}]}, "events": {"type": "array", "minLength": 1, "items": {}}}}, "permission": {"type": "object", "definitions": {"permission": {"type": "string", "enum": ["view", "edit", "build", "admin", "clone", "deploy"]}}, "properties": {"groups": {"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "permissions": {"anyOf": [{"type": "array", "items": {}}, {}]}, "roles": {"type": "array", "items": {"type": "string"}}, "users": {"type": "array", "items": {"type": "string"}}}}, "plan": {"type": "object", "properties": {"project-key": {"type": "string"}, "key": {"type": "string"}, "name": {"type": "string"}}}, "predefinedTask": {"type": "string", "enum": ["inject-variables", "clean", "checkout", "artifact-download"]}, "releaseNaming": {"type": "object", "properties": {"next-version-name": {"type": "string"}, "applies-to-branches": {"type": "boolean"}, "auto-increment": {"type": "boolean"}, "auto-increment-variables": {"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}}}, "script": {"anyOf": [{"type": "string"}, {"type": "object", "properties": {"script": {"type": "string"}}}]}, "stage": {"type": "object", "additionalProperties": false, "properties": {"manual": {"type": "boolean"}, "final": {"type": "boolean"}, "jobs": {"type": "array", "items": {"type": "string"}}}}, "task": {"type": "object", "definitions": {"trigger": {"anyOf": [{"type": "object", "properties": {"stage": {"type": "string"}, "branch": {"type": "string"}}}, {"type": "object", "patternProperties": {"[a-zA-Z0-9\\s+_-]": {"type": "string"}}}]}}, "properties": {"source-plan": {"type": "string"}, "artifacts": {"type": "array", "items": {}}, "triggers": {"type": "array", "items": {"type": "object", "patternProperties": {"(build|stage|environment)-success": {}}}}, "notifications": {"type": "array", "items": {}}}}, "testParser": {"type": "string", "enum": ["junit", "mstest", "nunit", "mocha", "testng"]}, "triggers": {"type": "array", "definitions": {"polling": {"type": "object", "additionalProperties": false, "properties": {"polling": {"anyOf": [{"type": "integer"}, {"type": "object", "additionalProperties": false, "properties": {"period": {"type": "integer"}, "conditions": {"type": "array", "items": {"type": "object", "patternProperties": {"[a-zA-Z0-9\\s+_-]": {"type": "object", "additionalProperties": {"type": "boolean"}}}}}}}]}}}, "remote": {"type": "object", "additionalProperties": false, "properties": {"remote": {"anyOf": [{"type": "string"}, {"type": "object", "properties": {"ip": {"type": "string"}}}]}}}, "cron": {"type": "object", "additionalProperties": false, "properties": {"cron": {"oneOf": [{"type": "string"}, {"type": "object", "properties": {"expression": {"type": "string"}}}]}}}}, "items": {"anyOf": [{}, {}, {}, {"type": "string"}]}}}, "id": "https://json.schemastore.org/bamboo-spec.json", "properties": {"default-environment-permissions": {"type": "array", "items": {}}, "deployment": {"anyOf": [{"type": "string"}, {}]}, "deployment-permissions": {"type": "array", "items": {}}, "docker": {}, "environment-permissions": {"type": "array", "items": {"type": "object", "patternProperties": {"[a-zA-Z0-9\\s+_-]": {"type": "array", "items": {}}}}}, "environments": {"type": "array", "items": {"type": "string"}}, "labels": {"type": "array", "items": {"type": "string"}}, "notifications": {"type": "array", "items": {"type": "object", "properties": {"recipients": {"type": "array", "items": {"anyOf": [{"type": "string"}, {"type": "object", "properties": {"users": {"type": "array", "items": {"type": "string"}}, "emails": {"type": "array", "items": {"type": "string"}}}}]}}, "events": {"type": "array", "items": {"anyOf": [{}, {"type": "object"}]}}}}}, "plan": {}, "plan-permissions": {"type": "array", "items": {}}, "release-naming": {"anyOf": [{}, {"type": "string"}]}, "repositories": {"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "object", "patternProperties": {"[a-zA-Z0-9_]": {"type": "object", "properties": {"scope": {"type": "string", "enum": ["project", "global"]}, "type": {"type": "string"}, "slug": {"type": "string"}, "url": {"type": "string"}, "branch": {"type": "string"}, "viewer": {"type": "string"}, "ssh-key": {"type": "string"}, "ssh-key-passphrase": {"type": "string"}, "username": {"type": "string"}, "password": {"type": "string"}, "shared-credentials": {"type": "string"}, "lfs": {"type": "boolean"}, "use-shallow-clones": {"type": "boolean"}, "submodules": {"type": "boolean"}, "change-detection": {"type": "object", "properties": {"quiet-period": {"type": "object", "properties": {"quiet-period-seconds": {"type": "integer"}, "max-retries": {"type": "integer"}}}, "exclude-changeset-pattern": {"type": "string"}, "file-filter-type": {"type": "string"}, "file-filter-pattern": {"type": "string"}}}}}}}]}}, "stages": {"type": "array", "items": {"type": "object", "patternProperties": {"[a-zA-Z0-9\\s+_-]": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {}]}}}}, "triggers": {}, "variables": {}, "version": {"type": "integer", "default": 2}, "other": {"type": "object"}}, "type": "object"}
bamboo-spec.json
deployment
A deployment project in Bamboo is a container for holding the software project you are deploying: releases that have been built and tested, and the environments to which releases are deployed
{"type": "object", "properties": {"name": {"type": "string"}, "source-plan": {"type": "string"}}}
bamboo-spec.json
docker
Builds and deployments are normally run on the Bamboo agent's native operating system
{"anyOf": [{"type": "string"}, {"type": "object", "properties": {"image": {"type": "string"}, "volumes": {"type": "object", "default": {}}, "use-default-volumes": {"type": "boolean", "default": false}, "docker-run-arguments": {"type": "array", "items": {"type": "string"}}}, "required": ["image"]}]}
bamboo-spec.json
job
A job is a single build unit within a plan and is made up of one or more tasks.
{"definitions": {"artifact": {"type": "object", "properties": {"location": {"type": "string"}, "name": {"type": "string"}, "pattern": {"type": "string"}, "required": {"type": "boolean"}, "shared": {"type": "boolean", "default": false}}}, "task": {"type": "object", "properties": {"interpreter": {"type": "string"}, "clean": {"type": "object"}, "checkout": {"type": "object", "properties": {"repository": {"type": "string"}, "path": {"type": "string"}, "force-clean-build": {"type": "string", "default": false}}}, "inject-variables": {"anyOf": [{"type": "string"}, {"type": "object", "additionalProperties": false, "properties": {"file": {"type": "string"}, "scope": {"type": "string"}, "namespace": {"type": "string"}}}]}, "test-parser": {"anyOf": [{}, {"type": "object", "properties": {"type": {}, "ignore-time": {"type": "boolean"}, "test-results": {"type": "array", "items": {"type": "string"}}}, "required": ["type"]}]}, "scripts": {"type": "array", "minItems": 1, "items": {}}}}}, "type": "object", "properties": {"docker": {}, "final-tasks": {"type": "array"}, "key": {"type": "string"}, "other": {"type": "object", "properties": {"clean-working-dir": {"type": "boolean"}}}, "requirements": {"type": "array", "items": {"anyOf": [{"type": "string"}, {"type": "object", "patternProperties": {".": {"type": "string"}}}]}}, "tasks": {"type": "array", "items": {"anyOf": [{}, {}, {}]}}}}
bamboo-spec.json
artifact
Artifacts are files created by a job build (e.g. JAR files)
{"type": "object", "properties": {"location": {"type": "string"}, "name": {"type": "string"}, "pattern": {"type": "string"}, "required": {"type": "boolean"}, "shared": {"type": "boolean", "default": false}}}
bamboo-spec.json
location
The relative path to find your artifact; it's a path relative to the workspace directory; do not use absolute paths.
{"type": "string"}
bamboo-spec.json
name
Name of the artifact; in case artifact is shared, name must be unique within the plan.
{"type": "string"}
bamboo-spec.json
pattern
Name or Ant pattern of file(s) to keep.
{"type": "string"}
bamboo-spec.json
shared
You can share an artifact among other jobs or plans.
{"type": "boolean", "default": false}
bamboo-spec.json
task
A task is a small unit of work, such as source code checkout, or running a script
{"type": "object", "properties": {"interpreter": {"type": "string"}, "clean": {"type": "object"}, "checkout": {"type": "object", "properties": {"repository": {"type": "string"}, "path": {"type": "string"}, "force-clean-build": {"type": "string", "default": false}}}, "inject-variables": {"anyOf": [{"type": "string"}, {"type": "object", "additionalProperties": false, "properties": {"file": {"type": "string"}, "scope": {"type": "string"}, "namespace": {"type": "string"}}}]}, "test-parser": {"anyOf": [{}, {"type": "object", "properties": {"type": {}, "ignore-time": {"type": "boolean"}, "test-results": {"type": "array", "items": {"type": "string"}}}, "required": ["type"]}]}, "scripts": {"type": "array", "minItems": 1, "items": {}}}}
bamboo-spec.json
test-parser
The Test Results Parser task in Bamboo parses test data
{"anyOf": [{}, {"type": "object", "properties": {"type": {}, "ignore-time": {"type": "boolean"}, "test-results": {"type": "array", "items": {"type": "string"}}}, "required": ["type"]}]}
bamboo-spec.json
keyValue
Variables can be used to make values available when building plans in Bamboo.
{"type": "object", "patternProperties": {"[a-zA-Z0-9_]": {"anyOf": [{"type": "string"}, {"type": "integer"}, {"type": "boolean"}, {"type": "number"}]}}}
bamboo-spec.json
permission
Plan permissions allow a user to control access to the functions of the build plan.
{"type": "object", "definitions": {"permission": {"type": "string", "enum": ["view", "edit", "build", "admin", "clone", "deploy"]}}, "properties": {"groups": {"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "permissions": {"anyOf": [{"type": "array", "items": {}}, {}]}, "roles": {"type": "array", "items": {"type": "string"}}, "users": {"type": "array", "items": {"type": "string"}}}}
bamboo-spec.json
permission
Plan permissions allow a user to control access to the functions of the build plan
{"type": "string", "enum": ["view", "edit", "build", "admin", "clone", "deploy"]}
bamboo-spec.json
plan
A plan defines everything about your continuous integration build process in Bamboo.
{"type": "object", "properties": {"project-key": {"type": "string"}, "key": {"type": "string"}, "name": {"type": "string"}}}
bamboo-spec.json
stage
Stages group jobs to individual steps within a plan's build process.
{"type": "object", "additionalProperties": false, "properties": {"manual": {"type": "boolean"}, "final": {"type": "boolean"}, "jobs": {"type": "array", "items": {"type": "string"}}}}
bamboo-spec.json
manual
Will await for execution by user
{"type": "boolean"}
bamboo-spec.json
final
Will be executed regardless of other stages state (pass or fail)
{"type": "boolean"}
bamboo-spec.json
task
A task is a small unit of work, such as source code checkout, or running a script.
{"type": "object", "definitions": {"trigger": {"anyOf": [{"type": "object", "properties": {"stage": {"type": "string"}, "branch": {"type": "string"}}}, {"type": "object", "patternProperties": {"[a-zA-Z0-9\\s+_-]": {"type": "string"}}}]}}, "properties": {"source-plan": {"type": "string"}, "artifacts": {"type": "array", "items": {}}, "triggers": {"type": "array", "items": {"type": "object", "patternProperties": {"(build|stage|environment)-success": {}}}}, "notifications": {"type": "array", "items": {}}}}
bamboo-spec.json
cron
Execute deployment by schedule.
{"type": "object", "additionalProperties": false, "properties": {"cron": {"oneOf": [{"type": "string"}, {"type": "object", "properties": {"expression": {"type": "string"}}}]}}}
bamboo-spec.json
default-environment-permissions
These permissions apply to all environments defined in this deployment project
{"type": "array", "items": {}}
bamboo-spec.json
deployment-permissions
These permissions apply to the deployment project
{"type": "array", "items": {}}
bamboo-spec.json
environment-permissions
Permissions specific to an environment
{"type": "array", "items": {"type": "object", "patternProperties": {"[a-zA-Z0-9\\s+_-]": {"type": "array", "items": {}}}}}
bamboo-spec.json
environments
An environment represents the servers or groups of servers where the software release has been deployed to, and the tasks that are needed for the deployment to work smoothly
{"type": "array", "items": {"type": "string"}}
bamboo-spec.json
release-naming
You can define how releases should be named when they are created by Bamboo
{"anyOf": [{}, {"type": "string"}]}
bamboo-spec.json
stages
Stages group jobs to individual steps within a plan's build process.
{"type": "array", "items": {"type": "object", "patternProperties": {"[a-zA-Z0-9\\s+_-]": {"anyOf": [{"type": "array", "items": {"type": "string"}}, {}]}}}}
aurora-1.0.json
Make agile applications without technical debt
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": {"property": {"type": "object", "required": ["name", "type"], "additionalProperties": false, "properties": {"name": {"type": "string", "minLength": 2}, "type": {"type": "string", "enum": ["bigint.unsigned", "bigint", "blob.long", "blob.medium", "blob.tiny", "blob", "boolean", "char", "date", "decimal", "enum", "float", "id", "int.unsigned", "int", "json", "manyToMany", "password", "relationship", "smallint.unsigned", "smallint", "text", "timestamp", "tinyint.unsigned", "tinyint", "varchar"]}, "length": {"type": "number", "minimum": 1}, "maxLength": {"type": "number", "minimum": 1}, "nullable": {"type": "boolean"}, "primaryKey": {"type": "boolean"}, "index": {"type": "string", "enum": ["index", "unique"]}, "indexName": {"type": "string", "minLength": 2}, "enumOptions": {"type": "array", "items": {"type": "string", "minLength": 1}}, "defaultValue": {"type": ["number", "string", "boolean"]}, "example": {"type": ["number", "string", "boolean"]}, "decimals": {"type": "array", "items": {"type": "number", "minimum": 1}}, "autoIncrement": {"type": "boolean"}, "relationship": {}, "webComponent": {}}}, "apiDefinition": {"type": "object", "required": ["path", "resolverType", "httpMethod"], "properties": {"path": {"type": "string", "minLength": 2}, "resolverType": {"type": "string", "enum": ["query", "mutation"]}, "httpMethod": {"type": "string", "enum": ["get", "post", "put", "delete", "patch"]}}}, "relationship": {"type": "object", "additionalProperties": false, "properties": {"type": {"type": "string", "enum": ["many-to-many", "many-to-one", "none", "one-to-many", "one-to-one"]}, "singularName": {"type": "string", "minLength": 2}, "aggregate": {"type": "string", "minLength": 2}, "modulePath": {"type": "string", "minLength": 2}, "key": {"type": "string", "minLength": 2}, "field": {"type": "string", "minLength": 2}, "avoidConstraint": {"type": "boolean"}, "packageName": {"type": "string", "minLength": 2}, "isDenormalized": {"type": "boolean"}, "pivot": {}}}, "webComponent": {"type": "object", "additionalProperties": false, "properties": {"type": {"type": "string", "enum": ["grid-select-element", "grid-elements-manager", "select"]}}}, "pivotTable": {"type": "object", "additionalProperties": false, "properties": {"aggregate": {"type": "string", "minLength": 2}, "modulePath": {"type": "string", "minLength": 2}, "fileName": {"type": "string", "minLength": 2}}}}, "properties": {"version": {"type": "string", "default": "0.0.1", "minLength": 2}, "boundedContextName": {"type": "string", "minLength": 2}, "moduleName": {"type": "string", "minLength": 2}, "moduleNames": {"type": "string", "minLength": 2}, "aggregateName": {"type": "string", "minLength": 2}, "hasOAuth": {"type": "boolean", "default": false}, "hasTenant": {"type": "boolean", "default": false}, "hasAuditing": {"type": "boolean", "default": false}, "aggregateProperties": {"type": "array", "items": {}}, "aggregateI18nProperties": {"type": "array", "items": {}}, "additionalApis": {"type": "array", "items": {}}}, "required": ["boundedContextName", "moduleName", "moduleNames", "aggregateName"], "type": "object"}
aurora-1.0.json
name
The name of property, in camelCase
{"type": "string", "minLength": 2}
aurora-1.0.json
type
The type of property
{"type": "string", "enum": ["bigint.unsigned", "bigint", "blob.long", "blob.medium", "blob.tiny", "blob", "boolean", "char", "date", "decimal", "enum", "float", "id", "int.unsigned", "int", "json", "manyToMany", "password", "relationship", "smallint.unsigned", "smallint", "text", "timestamp", "tinyint.unsigned", "tinyint", "varchar"]}
aurora-1.0.json
length
Set max length to property
{"type": "number", "minimum": 1}
aurora-1.0.json
maxLength
Set max length to property
{"type": "number", "minimum": 1}
aurora-1.0.json
nullable
Set property to nullable
{"type": "boolean"}
aurora-1.0.json
primaryKey
Set property to primary key
{"type": "boolean"}
aurora-1.0.json
index
To define property like a index
{"type": "string", "enum": ["index", "unique"]}
aurora-1.0.json
indexName
The name of index, if there are various indexes with the same name, they will be grouped
{"type": "string", "minLength": 2}
aurora-1.0.json
enumOptions
Values for enum type
{"type": "array", "items": {"type": "string", "minLength": 1}}
aurora-1.0.json
defaultValue
Default value for property
{"type": ["number", "string", "boolean"]}
aurora-1.0.json
example
Example value for property, this value will be used in swagger documentation
{"type": ["number", "string", "boolean"]}
aurora-1.0.json
decimals
Total digits of the number and length of the decimal places in the back of the number, example: [10, 2].
{"type": "array", "items": {"type": "number", "minimum": 1}}
aurora-1.0.json
autoIncrement
Set number property as auto increment
{"type": "boolean"}
aurora-1.0.json
path
Path to access api
{"type": "string", "minLength": 2}
aurora-1.0.json
resolverType
Type of resolver, query or mutation
{"type": "string", "enum": ["query", "mutation"]}
aurora-1.0.json
httpMethod
Verb of api rest
{"type": "string", "enum": ["get", "post", "put", "delete", "patch"]}
aurora-1.0.json
relationship
Relationship definition for this property
{"type": "object", "additionalProperties": false, "properties": {"type": {"type": "string", "enum": ["many-to-many", "many-to-one", "none", "one-to-many", "one-to-one"]}, "singularName": {"type": "string", "minLength": 2}, "aggregate": {"type": "string", "minLength": 2}, "modulePath": {"type": "string", "minLength": 2}, "key": {"type": "string", "minLength": 2}, "field": {"type": "string", "minLength": 2}, "avoidConstraint": {"type": "boolean"}, "packageName": {"type": "string", "minLength": 2}, "isDenormalized": {"type": "boolean"}, "pivot": {}}}
aurora-1.0.json
type
The type of web component
{"type": "string", "enum": ["many-to-many", "many-to-one", "none", "one-to-many", "one-to-one"]}
aurora-1.0.json
singularName
Singular name of the property referred to in the relationship, only for one-to-many and many-to-many relationship, example: book
{"type": "string", "minLength": 2}
aurora-1.0.json
aggregate
Aggregate referring to this relationship, example: LibraryAuthor
{"type": "string", "minLength": 2}
aurora-1.0.json
modulePath
Path to the module that refers to this relationship, example: library/author
{"type": "string", "minLength": 2}
aurora-1.0.json
key
Property key that refers to this relationship, only for many-to-one relationship, example: id
{"type": "string", "minLength": 2}
aurora-1.0.json
field
Field to obtain the relationship data, example: author
{"type": "string", "minLength": 2}
aurora-1.0.json
avoidConstraint
Avoid constraint rules for this relationship
{"type": "boolean"}
aurora-1.0.json
packageName
Path to packageName where is the relationship, example: @aurora-ts/core
{"type": "string", "minLength": 2}
aurora-1.0.json
isDenormalized
Set many-to-many relationship as denormalized, creating a field to store the selected ids
{"type": "boolean"}
aurora-1.0.json
webComponent
Web Component that wil be rendered for this property
{"type": "object", "additionalProperties": false, "properties": {"type": {"type": "string", "enum": ["grid-select-element", "grid-elements-manager", "select"]}}}
aurora-1.0.json
type
The type of web component
{"type": "string", "enum": ["grid-select-element", "grid-elements-manager", "select"]}
aurora-1.0.json
pivotTable
Relationship pivot table definition for this relationship
{"type": "object", "additionalProperties": false, "properties": {"aggregate": {"type": "string", "minLength": 2}, "modulePath": {"type": "string", "minLength": 2}, "fileName": {"type": "string", "minLength": 2}}}
aurora-1.0.json
aggregate
AggregateName of Pivot table, example: IamRolesAccounts
{"type": "string", "minLength": 2}
aurora-1.0.json
modulePath
Module path where table model file will be saved, example: iam/role
{"type": "string", "minLength": 2}
aurora-1.0.json
fileName
Filename of pivot table model file, example: roles-accounts
{"type": "string", "minLength": 2}
aurora-1.0.json
version
Schema version
{"type": "string", "default": "0.0.1", "minLength": 2}
aurora-1.0.json
boundedContextName
The name of the bounded context, singular in kebab-case
{"type": "string", "minLength": 2}
aurora-1.0.json
moduleName
The name of the module, singular in kebab-case
{"type": "string", "minLength": 2}
aurora-1.0.json
moduleNames
The name of the module, plural in kebab-case
{"type": "string", "minLength": 2}
aurora-1.0.json
aggregateName
The name of the aggregateName, singular in PascalCase
{"type": "string", "minLength": 2}
aurora-1.0.json
hasOAuth
Enabled authentication for this module
{"type": "boolean", "default": false}
aurora-1.0.json
hasTenant
Enabled tenant for this module
{"type": "boolean", "default": false}
aurora-1.0.json
hasAuditing
Enabled auditing for this module
{"type": "boolean", "default": false}
workflow.json
Serverless Workflow specification - workflow schema
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {"id": {"type": "string", "minLength": 1}, "key": {"type": "string", "minLength": 1}, "name": {"type": "string", "minLength": 1}, "version": {"type": "string", "minLength": 1, "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"}, "annotations": {"type": "array", "minItems": 1, "items": {"type": "string"}, "additionalItems": false}, "dataInputSchema": {}, "dataOutputSchema": {}, "secrets": {}, "constants": {"oneOf": [{"type": "string", "format": "uri"}, {"type": "object"}]}, "start": {}, "specVersion": {"type": "string", "minLength": 1}, "expressionLang": {"type": "string", "default": "jq", "minLength": 1}, "timeouts": {}, "errors": {}, "keepActive": {"type": "boolean", "default": false}, "metadata": {}, "events": {}, "functions": {}, "autoRetries": {"type": "boolean", "default": false}, "retries": {}, "auth": {}, "extensions": {}, "states": {"type": "array", "items": {"anyOf": [{}, {}, {}, {}, {}, {}, {}, {}]}, "additionalItems": false, "minItems": 1}}, "oneOf": [{"required": ["id", "specVersion", "states"]}, {"required": ["key", "specVersion", "states"]}], "definitions": {"sleep": {"type": "object", "properties": {"before": {"type": "string"}, "after": {"type": "string"}}, "anyOf": [{"required": ["before"]}, {"required": ["after"]}, {"required": ["before", "after"]}]}, "crondef": {"oneOf": [{"type": "string", "minLength": 1}, {"type": "object", "properties": {"expression": {"type": "string", "minLength": 1}, "validUntil": {"type": "string"}}, "additionalProperties": false, "required": ["expression"]}]}, "continueasdef": {"oneOf": [{"type": "string", "minLength": 1}, {"type": "object", "properties": {"workflowId": {"type": "string"}, "version": {"type": "string", "minLength": 1, "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"}, "data": {"type": ["string", "object"]}, "workflowExecTimeout": {}}, "required": ["workflowId"]}]}, "transition": {"oneOf": [{"type": "string", "minLength": 1}, {"type": "object", "properties": {"nextState": {"type": "string", "minLength": 1}, "produceEvents": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "compensate": {"type": "boolean", "default": false}}, "additionalProperties": false, "required": ["nextState"]}]}, "error": {"type": "object", "properties": {"errorRef": {"type": "string", "minLength": 1}, "errorRefs": {"type": "array", "minItems": 1, "items": {"type": "string"}, "additionalItems": false}, "transition": {}, "end": {}}, "additionalProperties": false, "oneOf": [{"required": ["errorRef", "transition"]}, {"required": ["errorRef", "end"]}, {"required": ["errorRefs", "transition"]}, {"required": ["errorRefs", "end"]}]}, "onevents": {"type": "object", "properties": {"eventRefs": {"type": "array", "minItems": 1, "items": {"type": "string"}, "uniqueItems": true, "additionalItems": false}, "actionMode": {"type": "string", "enum": ["sequential", "parallel"], "default": "sequential"}, "actions": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "eventDataFilter": {}}, "additionalProperties": false, "required": ["eventRefs"]}, "action": {"type": "object", "properties": {"name": {"type": "string"}, "functionRef": {}, "eventRef": {}, "subFlowRef": {}, "sleep": {}, "retryRef": {"type": "string"}, "nonRetryableErrors": {"type": "array", "minItems": 1, "items": {"type": "string"}, "additionalItems": false}, "retryableErrors": {"type": "array", "minItems": 1, "items": {"type": "string"}, "additionalItems": false}, "actionDataFilter": {}, "condition": {"type": "string", "minLength": 1}}, "additionalProperties": false, "oneOf": [{"required": ["functionRef"]}, {"required": ["eventRef"]}, {"required": ["subFlowRef"]}]}, "functionref": {"oneOf": [{"type": "string", "minLength": 1}, {"type": "object", "properties": {"refName": {"type": "string"}, "arguments": {"type": "object"}, "selectionSet": {"type": "string"}, "invoke": {"type": "string", "enum": ["sync", "async"], "default": "sync"}}, "additionalProperties": false, "required": ["refName"]}]}, "eventref": {"type": "object", "properties": {"produceEventRef": {"type": "string"}, "consumeEventRef": {"type": "string"}, "consumeEventTimeout": {"type": "string"}, "data": {"type": ["string", "object"]}, "contextAttributes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false, "required": ["produceEventRef"]}, "subflowref": {"oneOf": [{"type": "string", "minLength": 1}, {"type": "object", "properties": {"workflowId": {"type": "string"}, "version": {"type": "string", "minLength": 1, "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"}, "onParentComplete": {"type": "string", "enum": ["continue", "terminate"], "default": "terminate"}, "invoke": {"type": "string", "enum": ["sync", "async"], "default": "sync"}}, "required": ["workflowId"]}]}, "branch": {"type": "object", "properties": {"name": {"type": "string"}, "timeouts": {"type": "object", "properties": {"actionExecTimeout": {}, "branchExecTimeout": {}}, "required": []}, "actions": {"type": "array", "items": {"type": "object"}, "additionalItems": false}}, "additionalProperties": false, "required": ["name", "actions"]}, "sleepstate": {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "sleep"}, "end": {}, "duration": {"type": "string"}, "transition": {}, "metadata": {}}, "additionalProperties": false, "oneOf": [{"required": ["name", "type", "duration", "end"]}, {"required": ["name", "type", "duration", "transition"]}]}, "eventstate": {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "event"}, "exclusive": {"type": "boolean", "default": true}, "onEvents": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "timeouts": {"type": "object", "properties": {"stateExecTimeout": {}, "actionExecTimeout": {}, "eventTimeout": {}}, "required": []}, "stateDataFilter": {}, "onErrors": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "transition": {}, "end": {}, "compensatedBy": {"type": "string", "minLength": 1}, "metadata": {}}, "additionalProperties": false, "oneOf": [{"required": ["name", "type", "onEvents", "end"]}, {"required": ["name", "type", "onEvents", "transition"]}]}, "operationstate": {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "operation"}, "end": {}, "stateDataFilter": {}, "actionMode": {"type": "string", "enum": ["sequential", "parallel"], "default": "sequential"}, "actions": {"type": "array", "items": {"type": "object"}}, "timeouts": {"type": "object", "properties": {"stateExecTimeout": {}, "actionExecTimeout": {}}, "required": []}, "onErrors": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "transition": {}, "compensatedBy": {"type": "string", "minLength": 1}, "usedForCompensation": {"type": "boolean", "default": false}, "metadata": {}}, "additionalProperties": false, "if": {"properties": {"usedForCompensation": {"const": true}}, "required": ["usedForCompensation"]}, "then": {"required": ["name", "type", "actions"]}, "else": {"oneOf": [{"required": ["name", "type", "actions", "end"]}, {"required": ["name", "type", "actions", "transition"]}]}}, "parallelstate": {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "parallel"}, "end": {}, "stateDataFilter": {}, "timeouts": {"type": "object", "properties": {"stateExecTimeout": {}, "branchExecTimeout": {}}, "required": []}, "branches": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "completionType": {"type": "string", "enum": ["allOf", "atLeast"], "default": "allOf"}, "numCompleted": {"type": ["number", "string"], "minimum": 0, "minLength": 0}, "onErrors": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "transition": {}, "compensatedBy": {"type": "string", "minLength": 1}, "usedForCompensation": {"type": "boolean", "default": false}, "metadata": {}}, "additionalProperties": false, "if": {"properties": {"usedForCompensation": {"const": true}}, "required": ["usedForCompensation"]}, "then": {"required": ["name", "type", "branches"]}, "else": {"oneOf": [{"required": ["name", "type", "branches", "end"]}, {"required": ["name", "type", "branches", "transition"]}]}}, "switchstate": {"oneOf": [{}, {}]}, "eventbasedswitchstate": {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "switch"}, "stateDataFilter": {}, "timeouts": {"type": "object", "properties": {"stateExecTimeout": {}, "eventTimeout": {}}, "required": []}, "eventConditions": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "onErrors": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "defaultCondition": {}, "compensatedBy": {"type": "string", "minLength": 1}, "usedForCompensation": {"type": "boolean", "default": false}, "metadata": {}}, "additionalProperties": false, "required": ["name", "type", "eventConditions", "defaultCondition"]}, "databasedswitchstate": {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "switch"}, "stateDataFilter": {}, "timeouts": {"type": "object", "properties": {"stateExecTimeout": {}}, "required": []}, "dataConditions": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "onErrors": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "defaultCondition": {}, "compensatedBy": {"type": "string", "minLength": 1}, "usedForCompensation": {"type": "boolean", "default": false}, "metadata": {}}, "additionalProperties": false, "required": ["name", "type", "dataConditions", "defaultCondition"]}, "defaultconditiondef": {"type": "object", "properties": {"name": {"type": "string"}, "transition": {}, "end": {}}, "additionalProperties": false, "oneOf": [{"required": ["transition"]}, {"required": ["end"]}]}, "eventcondition": {"oneOf": [{}, {}]}, "transitioneventcondition": {"type": "object", "properties": {"name": {"type": "string"}, "eventRef": {"type": "string"}, "transition": {}, "eventDataFilter": {}, "metadata": {}}, "additionalProperties": false, "required": ["eventRef", "transition"]}, "endeventcondition": {"type": "object", "properties": {"name": {"type": "string"}, "eventRef": {"type": "string"}, "end": {}, "eventDataFilter": {}, "metadata": {}}, "additionalProperties": false, "required": ["eventRef", "end"]}, "datacondition": {"oneOf": [{}, {}]}, "transitiondatacondition": {"type": "object", "properties": {"name": {"type": "string"}, "condition": {"type": "string"}, "transition": {}, "metadata": {}}, "additionalProperties": false, "required": ["condition", "transition"]}, "enddatacondition": {"type": "object", "properties": {"name": {"type": "string"}, "condition": {"type": "string"}, "end": {}, "metadata": {}}, "additionalProperties": false, "required": ["condition", "end"]}, "injectstate": {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "inject"}, "end": {}, "data": {"type": "object"}, "stateDataFilter": {}, "transition": {}, "compensatedBy": {"type": "string", "minLength": 1}, "usedForCompensation": {"type": "boolean", "default": false}, "metadata": {}}, "additionalProperties": false, "if": {"properties": {"usedForCompensation": {"const": true}}, "required": ["usedForCompensation"]}, "then": {"required": ["name", "type", "data"]}, "else": {"oneOf": [{"required": ["name", "type", "data", "end"]}, {"required": ["name", "type", "data", "transition"]}]}}, "foreachstate": {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "foreach"}, "end": {}, "inputCollection": {"type": "string"}, "outputCollection": {"type": "string"}, "iterationParam": {"type": "string"}, "batchSize": {"type": ["number", "string"], "minimum": 0, "minLength": 0}, "actions": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "timeouts": {"type": "object", "properties": {"stateExecTimeout": {}, "actionExecTimeout": {}}, "required": []}, "stateDataFilter": {}, "onErrors": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "transition": {}, "compensatedBy": {"type": "string", "minLength": 1}, "usedForCompensation": {"type": "boolean", "default": false}, "mode": {"type": "string", "enum": ["sequential", "parallel"], "default": "parallel"}, "metadata": {}}, "additionalProperties": false, "if": {"properties": {"usedForCompensation": {"const": true}}, "required": ["usedForCompensation"]}, "then": {"required": ["name", "type", "inputCollection", "actions"]}, "else": {"oneOf": [{"required": ["name", "type", "inputCollection", "actions", "end"]}, {"required": ["name", "type", "inputCollection", "actions", "transition"]}]}}, "callbackstate": {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "callback"}, "action": {}, "eventRef": {"type": "string"}, "timeouts": {"type": "object", "properties": {"stateExecTimeout": {}, "actionExecTimeout": {}, "eventTimeout": {}}, "required": []}, "eventDataFilter": {}, "stateDataFilter": {}, "onErrors": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "transition": {}, "end": {}, "compensatedBy": {"type": "string", "minLength": 1}, "usedForCompensation": {"type": "boolean", "default": false}, "metadata": {}}, "additionalProperties": false, "if": {"properties": {"usedForCompensation": {"const": true}}, "required": ["usedForCompensation"]}, "then": {"required": ["name", "type", "action", "eventRef"]}, "else": {"oneOf": [{"required": ["name", "type", "action", "eventRef", "end"]}, {"required": ["name", "type", "action", "eventRef", "transition"]}]}}, "startdef": {"oneOf": [{"type": "string", "minLength": 1}, {"type": "object", "properties": {"stateName": {"type": "string", "minLength": 1}, "schedule": {}}, "additionalProperties": false, "required": ["schedule"]}]}, "schedule": {"oneOf": [{"type": "string", "minLength": 1}, {"type": "object", "properties": {"interval": {"type": "string", "minLength": 1}, "cron": {}, "timezone": {"type": "string"}}, "additionalProperties": false, "oneOf": [{"required": ["interval"]}, {"required": ["cron"]}]}]}, "end": {"oneOf": [{"type": "boolean", "default": true}, {"type": "object", "properties": {"terminate": {"type": "boolean", "default": false}, "produceEvents": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "compensate": {"type": "boolean", "default": false}, "continueAs": {}}, "additionalProperties": false, "required": []}]}, "produceeventdef": {"type": "object", "properties": {"eventRef": {"type": "string"}, "data": {"type": ["string", "object"]}, "contextAttributes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false, "required": ["eventRef"]}, "statedatafilter": {"type": "object", "properties": {"input": {"type": "string"}, "output": {"type": "string"}}, "additionalProperties": false, "required": []}, "eventdatafilter": {"type": "object", "properties": {"useData": {"type": "boolean", "default": true}, "data": {"type": "string"}, "toStateData": {"type": "string"}}, "additionalProperties": false, "required": []}, "actiondatafilter": {"type": "object", "properties": {"fromStateData": {"type": "string"}, "useResults": {"type": "boolean", "default": true}, "results": {"type": "string"}, "toStateData": {"type": "string"}}, "additionalProperties": false, "required": []}, "validationSchema": {"oneOf": [{"type": "string", "minLength": 1}, {"type": "object", "properties": {"schema": {"oneof": [{"type": "string", "minLength": 1}, {"type": "object", "$schema": "http://json-schema.org/draft-07/schema#"}]}, "failOnValidationErrors": {"type": "boolean", "default": true}}, "additionalProperties": false, "required": ["schema"]}]}}}
workflow.json
id
Workflow unique identifier
{"type": "string", "minLength": 1}