MFTF 2.3.12 documentation updates #3431
Conversation
… when making a request - added document
…tadata - added document
…tadata - added document
… when making a request - added document
… when making a request - added document
MFTF 2.3.12: Describe how to use reference to data key in `url` of metadata
MFTF 2.3.12: Add description for the array value element in metadata
dshevtsov
added
Major Update
| Example: | ||
| 1. The `dataType` value must match the `type` value of the corresponding entity. | ||
| 2. The file name contains data type split with `_` and ends with `-meta`. | ||
| Example: `product_attribute-meta.xml`. |
There was a problem hiding this comment.
file name can be anything but needs to ends with -meta. We use data type a lot by convention.
There was a problem hiding this comment.
will change to:
The file name should contain data type split with _ and must end with -meta.
mftf/2.3/metadata.md
Outdated
| - \*`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}`. | ||
| When the data to reuse is of a different type, declare also the type of data such as `{product.sku}`. | ||
| Examples: `"/V1/products/{sku}/media/{id}"`. |
There was a problem hiding this comment.
missing type? should be
Examples: "/V1/products/{product.sku}/media/{id}".
| content="GET is used for retrieving data from objects.<br/> | ||
| POST is used for creating new objects.<br/> | ||
| PUT is used for updating objects.<br/> | ||
| DELETE is used for deleting objects.<br/>" %} |
There was a problem hiding this comment.
DELETE is removed. Is this on purpose?
There was a problem hiding this comment.
yes, this text duplicates the text above in this topic
mftf/2.3/metadata.md
Outdated
|
|
||
| It contains one or more `value` elements. | ||
|
|
||
| ### value {#value-tag} | ||
|
|
||
| An item in `array`. | ||
| Declares a data type of the parent array items. |
There was a problem hiding this comment.
It's the array itself. Not parent array.
|
Donald Booth, --global seem not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. |
mftf/2.3/metadata.md
Outdated
| An item in `array`. | ||
| Declares a data type for items within `<array>`. | ||
|
|
||
| 1. Example of an array with value of a primitive data type: |
There was a problem hiding this comment.
General question, should these be in a numbered list? Is there a specific task they are completing with the steps? Or you can remove the numbering and keep the bullets under each example.
Co-Authored-By: dobooth <dobooth@adobe.com>
|
running tests |
This PR is a:
Summary
When this pull request is merged, it will update Metadata topic with more details about referencing to data from
urlof an<operation>and in<value>of an<array>.whatsnew
MFTF 2.3.12 was released:
<value>in metadata array.urlof metadata operation.