-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TF-2142] API add/remove tester from group (#3012)
- Loading branch information
1 parent
d6e3917
commit 5a4efd2
Showing
1 changed file
with
98 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,11 +17,13 @@ Getting started with the REST API can be done via the command line with any prog | |
| Supported Public Cloud endpoints: | ||
|
|
||
| ### US-East-1 | ||
|
|
||
| ```bash | ||
| curl -u "[email protected]:00001234cafecafe" "https://mobile.saucelabs.com/api/1/projects/" | ||
| ``` | ||
|
|
||
| ### EU-Central-1 (Access keys are different in each Data Center) | ||
|
|
||
| ```bash | ||
| curl -u "[email protected]:coffee00001234" "https://mobile.eu-central-1.saucelabs.com/api/1/projects/" | ||
| ``` | ||
|
|
@@ -273,7 +275,6 @@ Invite one or more tester groups to this specific build. You can optionally send | |
|
|
||
| </details> | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ### List All Recorded Sessions in Build | ||
|
|
@@ -560,6 +561,102 @@ Delete a single tester, remove them from any tester-groups they might be in, and | |
|
|
||
| </details> | ||
|
|
||
| --- | ||
|
|
||
| ### Add a Tester to a Group | ||
|
|
||
| <details> | ||
| <summary><span className="api post">POST</span><code>/api/1/testers/groups/{group-id}</code></summary> | ||
| <p></p> | ||
|
|
||
| Add a single or multiple testers to a specific group. | ||
|
|
||
| #### Parameters | ||
|
|
||
| <table id="table-api"> | ||
| <tbody> | ||
| <tr> | ||
| <td><code>email</code></td> | ||
| <td><p><small>| REQUIRED | STRING |</small></p><p>One or more email addresses, separated by commas, to be added to a group.</p></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| #### Responses | ||
|
|
||
| <table id="table-api"> | ||
| <tbody> | ||
| <tr> | ||
| <td><code>200</code></td> | ||
| <td colSpan='2'>Success.</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| ```json title="Sample Response" | ||
| { | ||
| "status": "ok", | ||
| "testers": [ | ||
| { | ||
| "email": "[email protected]" | ||
| }, | ||
| { | ||
| "email": "[email protected]" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
| --- | ||
|
|
||
| ### Remove a Tester from a Group | ||
|
|
||
| <details> | ||
| <summary><span className="api delete">DELETE</span><code>/api/1/testers/groups/{group-id}</code></summary> | ||
| <p></p> | ||
|
|
||
| Remove a single or multiple testers from a specific group. | ||
|
|
||
| #### Parameters | ||
|
|
||
| <table id="table-api"> | ||
| <tbody> | ||
| <tr> | ||
| <td><code>email</code></td> | ||
| <td><p><small>| REQUIRED | STRING |</small></p><p>One or more email addresses, separated by commas, to be removed from a group.</p></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| #### Responses | ||
|
|
||
| <table id="table-api"> | ||
| <tbody> | ||
| <tr> | ||
| <td><code>200</code></td> | ||
| <td colSpan='2'>Success.</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| ```json title="Sample Response" | ||
| { | ||
| "status": "ok", | ||
| "testers": [ | ||
| { | ||
| "email": "[email protected]" | ||
| }, | ||
| { | ||
| "email": "[email protected]" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
| ## Feedbacks | ||
|
|
||
| ### Get Latest Recorded Feedbacks | ||
|
|
||