Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gggeek committed May 14, 2018
1 parent 97e6abc commit 0840957
Show file tree
Hide file tree
Showing 11 changed files with 45 additions and 12 deletions.
3 changes: 3 additions & 0 deletions Resources/doc/DSL/ContentTypeGroups.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
attribute: attributeId # An attribute to get the value of for the reference.
# Supports content type group id and identifier
# The shorthand 'id' can be used instead of 'content_type_group_id'
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand Down Expand Up @@ -41,6 +42,7 @@
# Supports content type group id and identifier
# The shorthand 'id' can be used instead of 'content_type_group_id'
# 'count' can be used to set a reference to the number of items matched
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand All @@ -66,6 +68,7 @@
not: # matches elements NOT satisfying the wrapped condition
_condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
references: # Optional. See above for allowed values
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
3 changes: 3 additions & 0 deletions Resources/doc/DSL/ContentTypes.yml
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@
# attributes.title.required (boolean value)
# attributes.ezobjectrelationlist."field-settings".selectionContentTypes.length(@) (nr. of cotent-types allowed in an object-relations field)
# (for the full syntax supported, see jmespath)
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand Down Expand Up @@ -189,6 +190,7 @@
# The shorthand 'id' can be used instead of 'content_type_id'
# The shorthand 'identifier' can be used instead of 'content_type_identifier'
# 'count' can be used to set a reference to the number of items matched
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand All @@ -215,6 +217,7 @@
not: # matches elements NOT satisfying the wrapped condition
_condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
references: # Optional. See above for allowed values
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand Down
1 change: 1 addition & 0 deletions Resources/doc/DSL/Languages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
identifier: referenceId # A string used to identify the reference
attribute: attributeId # An attribute to get the value of for the reference.
# Supports: language_id, enabled, language_code, name
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand Down
4 changes: 4 additions & 0 deletions Resources/doc/DSL/Locations.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
# depth, is_hidden, main_language_code, main_location_id, main_language_code,
# modification_date, name, owner_id, parent_location_id, path, priority,
# publication_date, section_id, sort_field, sort_order)
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand Down Expand Up @@ -119,6 +120,7 @@
# modification_date, name, owner_id, parent_location_id, path, priority,
# publication_date, section_id, sort_field, sort_order)
# 'count' can be used to set a reference to the number of items matched
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand Down Expand Up @@ -177,6 +179,7 @@
# modification_date, name, owner_id, parent_location_id, path, priority,
# publication_date, section_id, sort_field, sort_order)
# 'count' can be used to set a reference to the number of items matched
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand Down Expand Up @@ -242,6 +245,7 @@
# modification_date, name, owner_id, parent_location_id, path, priority,
# publication_date, section_id, sort_field, sort_order)
# 'count' can be used to set a reference to the number of items matched
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
6 changes: 6 additions & 0 deletions Resources/doc/DSL/ObjectStatesAndGoups.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
attribute: attribute # An attribute to get the value of for the reference.
# Supports: object_state_group_id, object_state_group_identifier
# The shorthand 'id' can be used instead of 'object_state_group_id'
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand Down Expand Up @@ -55,6 +56,7 @@
# Supports: object_state_group_id, object_state_group_identifier
# The shorthand 'id' can be used instead of 'object_state_group_id'
# 'count' can be used to set a reference to the number of items matched
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand All @@ -80,6 +82,7 @@
not: # matches elements NOT satisfying the wrapped condition
_condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
references: # Optional. See above for allowed values
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand All @@ -103,6 +106,7 @@
attribute: attribute # An attribute to get the value of for the reference.
# Supports object_state_id, priority
# The shorthand 'id' can be used instead of 'object_state_id'
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand Down Expand Up @@ -142,6 +146,7 @@
# Supports object_state_id, priority
# The shorthand 'id' can be used instead of 'object_state_id'
# 'count' can be used to set a reference to the number of items matched
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand All @@ -166,6 +171,7 @@
not: # matches elements NOT satisfying the wrapped condition
_condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
references: # Optional. See above for allowed values
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
3 changes: 3 additions & 0 deletions Resources/doc/DSL/RolesAndPolicies.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
# Supports: role_id and role_identifier
# The shorthand 'id' can be used instead of 'role_id'
# The shorthand 'identifier' can be used instead of 'role_identifier'
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand Down Expand Up @@ -140,6 +141,7 @@
# The shorthand 'id' can be used instead of 'role_id'
# The shorthand 'identifier' can be used instead of 'role_identifier'
# 'count' can be used to set a reference to the number of items matched
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand All @@ -164,6 +166,7 @@
not: # matches elements NOT satisfying the wrapped condition
_condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
references: # Optional. See above for allowed values
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
2 changes: 2 additions & 0 deletions Resources/doc/DSL/Sections.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
# Supports: section_id, section_identifier, section_name
# The shorthand 'id' can be used instead of 'user_id'
# 'count' can be used to set a reference to the number of items matched
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand All @@ -69,6 +70,7 @@
not: # matches elements NOT satisfying the wrapped condition
_condition_: value # where _condition_ can be any of ones specified above, including 'and' and 'or'
references: # Optional. See above for allowed values
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
4 changes: 4 additions & 0 deletions Resources/doc/DSL/Tags.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
attribute: attributeId # The attribute to get the value of for the reference
# supports: always_available, depth, main_language_code, main_tag_id, modification_date,
# path, parent_tag_id, remote_id, keyword
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand Down Expand Up @@ -53,6 +54,7 @@
attribute: attributeId # The attribute to get the value of for the reference
# supports: always_available, depth, main_language_code, main_tag_id, modification_date,
# path, parent_tag_id, remote_id, keyword
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand Down Expand Up @@ -82,6 +84,7 @@
attribute: attributeId # The attribute to get the value of for the reference
# supports: always_available, depth, main_language_code, main_tag_id, modification_date,
# path, parent_tag_id, remote_id, keyword
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand All @@ -96,6 +99,7 @@
attribute: attributeId # The attribute to get the value of for the reference
# supports: always_available, depth, main_language_code, main_tag_id, modification_date,
# path, parent_tag_id, remote_id, keyword
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
2 changes: 2 additions & 0 deletions Resources/doc/DSL/Trash.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
identifier: referenceId # A string used to identify the reference
attribute: attribute # An attribute to get the value of for the reference.
# Supports: see location/create
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Expand All @@ -32,6 +33,7 @@
identifier: referenceId # A string used to identify the reference
attribute: attribute # An attribute to get the value of for the reference.
# Supports: see location/create
references_type: "array" # Optional. If not set, created references values will be scalars. If set, they will be arrays
if: # Optional. If set, the migration step will be skipped unless the condition is matched
"reference:_ref_name": # name of a reference to be used for the test
_operator_: value # allowed operators: eq, gt, gte, lt, lte, ne, count, length, regexp
Loading

0 comments on commit 0840957

Please sign in to comment.