diff --git a/docs/data.md b/docs/data.md index 2a1b845d4..8705bf7ba 100644 --- a/docs/data.md +++ b/docs/data.md @@ -197,6 +197,7 @@ Attributes|Type|Use|Description ---|---|---|--- `name`|string|optional|Name of the ``. `type`|string|optional|Node containing the exact name of `` type. Used later to find specific Persistence Layer Model class. `type` in `` can be whatever the user wants; There are no constraints. It is important when persisting data, depending on the `type` given, as it will try to match a metadata definition with the operation being done. Example: A `myCustomer` entity with `type="customer"`, calling ``, will try to find a metadata entry with the following attributes: ``. +`deprecated`|string|optional|Used to warn about the future deprecation of the data entity. String will appear in Allure reports and console output at runtime. `` may contain one or more [``][], [``][], [``][], or [``][] elements in any sequence. diff --git a/docs/metadata.md b/docs/metadata.md index 795c8a038..d99a37346 100644 --- a/docs/metadata.md +++ b/docs/metadata.md @@ -421,6 +421,7 @@ Root element that points to the corresponding XML Schema. | `returnIndex` | string | optional | Specifies index at which the value will be returned when `returnRegex` matches multiple values | | `removeBackend` | boolean | optional | Removes backend name from requested URL. Applicable when `auth="adminFormKey"`. | | `filename` | string | optional | | +|`deprecated`|string|optional|Used to warn about the future deprecation of the test. String will appear in Allure reports and console output at runtime.| - \*`url` - full URL is a concatenation of _ENV.baseUrl_ + `/rest/` + _url_. To reuse data of a required entity or returned response use a field key wrapped in curly braces such as `{sku}`. diff --git a/docs/page.md b/docs/page.md index 705a94294..cf8448dd8 100644 --- a/docs/page.md +++ b/docs/page.md @@ -145,6 +145,7 @@ Attributes|Type|Use|Description `area`|string|required|The area where this page lives. Three possible values: `admin` prepends `BACKEND_NAME` to `url`, `storefront` does not prepend anything to `url`, `external` flags the page for use with `amOnUrl`. The `url` provided must be a full URL, such as `http://myFullUrl.com/`, instead of the URL for a Magento page. `parameterized`|boolean |optional|Include and set to `"true"` if the `url` for this page has parameters that need to be replaced for proper use. `remove`|boolean|optional|The default value is `"false"`. Set to `"true"` to remove this element during parsing. +`deprecated`|string|optional|Used to warn about the future deprecation of the data entity. String will appear in Allure reports and console output at runtime. `` may contain several [`
`] elements. diff --git a/docs/section.md b/docs/section.md index 98221ec44..aa3555dc4 100644 --- a/docs/section.md +++ b/docs/section.md @@ -89,6 +89,7 @@ The following is an example of a call in test: Attributes|Type|Use|Description ---|---|---|--- `name`|string|required|Unique section name identifier. +`deprecated`|string|optional|Used to warn about the future deprecation of the section. String will appear in Allure reports and console output at runtime. `remove`|boolean|optional|The default is `false`. Set to `true` to remove this element during parsing. ### element {#element-tag} @@ -103,6 +104,7 @@ Attributes|Type|Use|Description `locatorFunction`|string|optional|[Locator function][] declaration to be used in lieu of a selector. `timeout`|string|optional|The timeout after interaction with the element (in seconds). The default is _none_. `parameterized`|boolean|optional|Include and set to `true` if the `selector` for this element has parameters that need to be replaced for proper use. Learn more in [Parameterized selectors][]. +`deprecated`|string|optional|Used to warn about the future deprecation of the element. String will appear in Allure reports and console output at runtime. `remove`|boolean|optional|The default is `false`. Set to `true` to remove this element during parsing. #### `timeout` attribute {#timeout-attribute} diff --git a/docs/section/locator-functions.md b/docs/section/locator-functions.md index d52c2fc72..1e3dffd24 100644 --- a/docs/section/locator-functions.md +++ b/docs/section/locator-functions.md @@ -1,6 +1,5 @@ # Locator functions - ## Define Locator::functions in elements Codeception has a set of very useful [Locator functions][] that may be used by elements inside a [section][]. diff --git a/docs/test.md b/docs/test.md index dcda0ba50..363732fd7 100644 --- a/docs/test.md +++ b/docs/test.md @@ -73,6 +73,7 @@ Attribute|Type|Use|Description `remove`|boolean|optional|Set `true` to remove the test when merging. `insertBefore`|string|optional| This option is used for [merging]. It enables you to add all test actions contained in the original test into a test with the same name BEFORE the test step with `stepKey` that you assigned in `insertBefore`. `insertAfter`|string|optional| Set `stepKey` of the test step after which you want to insert the test when [merging]. +`deprecated`|string|optional|Used to warn about the future deprecation of the test. String will appear in Allure reports and console output at runtime. `extends`|string|optional|A name of the parent test to [extend]. `` may also contain [``], [``], [``], any [action][actions], or [``]. diff --git a/docs/test/action-groups.md b/docs/test/action-groups.md index e036073a8..162ac0541 100644 --- a/docs/test/action-groups.md +++ b/docs/test/action-groups.md @@ -255,6 +255,7 @@ Attribute|Type|Use|Description ---|---|---|--- `name`|string|required|Identifier of the action group. `extends`|string|optional|Identifies the action group to extend. +`deprecated`|string|optional|Used to warn about the future deprecation of the actionGroup. String will appear in Allure reports and console output at runtime. It may contain ``.