Skip to content

[DevDoc]MQE-1729: Added document for PR #377 #444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 9, 2019
Merged

[DevDoc]MQE-1729: Added document for PR #377 #444

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9a91579
MQE-1729: Added document for PR #377
jilu1 Sep 5, 2019
55c30ac
Small grammar change.
dobooth Sep 6, 2019
d5ff5f5
Merge branch 'develop' into MQE-1729
jilu1 Sep 6, 2019
bce86c4
Merge branch 'develop' into MQE-1729
KevinBKozan Sep 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This directory contains XML files with metadata required to create a valid reque
A metadata file contains a list of operations with different types (defined in `type`).
Each [operation] includes:

- The set of adjustments for processing a request in [attributes][operation], and in some cases, a response (see `successRegex` and `returnRegex` in [reference details][operation]).
- The set of adjustments for processing a request in [attributes][operation], and in some cases, a response (see `successRegex`, `returnRegex` and `returnIndex` in [reference details][operation]).
- The type of body content encoding in [contentType].
- The body of the request represented as a tree of objects, arrays, and fields.

Expand Down Expand Up @@ -336,7 +336,7 @@ There are two different attributes to split access to different areas:
- `auth="adminFormKey"` is used for objects in an Admin area.
- `auth="customerFormKey"` is used for objects in a storefront.

You are able to create assurances with `successRegex`, and even return values with `returnRegex`.
You are able to create assurances with `successRegex`, and, optionally, return values with `returnRegex`. You can also use `returnIndex` when `returnRegex` matches multiple values.

### Create an object in Admin {#create-object-as-adminFormKey}

Expand Down Expand Up @@ -418,6 +418,7 @@ Root element that points to the corresponding XML Schema.
| `method` | string | optional | HTTP method of the operation. Possible values: `POST`, `DELETE`, `PUT`, `GET`. |
| `successRegex` | string | optional | Determines if the operation was successful. Parses the HTML body in response and asserts if the value assigned to the `successRegex` exists. |
| `returnRegex` | string | optional | Determines if the response contains the matching value to return. |
| `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 | |

Expand Down