Skip to content

Commit

Permalink
[TF-2155] Add and list groups (#3021)
Browse files Browse the repository at this point in the history
* [TF-2155] Add and list groups

* [TF-2155] Add and list groups

* [TF-2155] Add and list groups - minor correction
  • Loading branch information
simon-sarrafi authored Nov 22, 2024
1 parent 0813329 commit d313391
Showing 1 changed file with 107 additions and 0 deletions.
107 changes: 107 additions & 0 deletions docs/testfairy/api-reference/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,7 @@ Delete a specific build. When all builds of a project are deleted, the project i
<p></p>

Use this endpoint to copy a specific build to a specified folder. You can either create a new folder or copy the build to an existing one.

#### Parameters

<table id="table-api">
Expand Down Expand Up @@ -660,6 +661,9 @@ Add a single or multiple testers to a specific group.

Remove a single or multiple testers from a specific group.

<p></p>
**Note:** Groups without any members will be discarded.

#### Parameters

<table id="table-api">
Expand Down Expand Up @@ -698,6 +702,109 @@ Remove a single or multiple testers from a specific group.

</details>

---

### List All Tester groups

<details>
<summary><span className="api get">GET</span><code>/api/1/testers/groups</code></summary>
<p></p>

List all tester groups in this account.

#### 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",
"groups": [
{
"id": 14,
"name": "group1",
"testers": [
[
{
"email": "[email protected]"
},
{
"email": "[email protected]"
},
{
"email": "[email protected]"
}
]
]
},
{
"id": 39,
"name": "group2",
"testers": [
[
{
"email": "[email protected]"
}
]
]
}
]
}
```

</details>

---

### Create a Tester Group

<details>
<summary><span className="api post">POST</span><code>/api/1/testers/groups</code></summary>
<p></p>

Create a new tester group

#### Parameters

<table id="table-api">
<tbody>
<tr>
<td><code>groupName</code></td>
<td><p><small>| REQUIRED | STRING |</small></p><p>Specify a group name.</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",
"id": "40",
"name": "group3"
}
```

</details>

---

## Feedbacks

### Get Latest Recorded Feedbacks
Expand Down

0 comments on commit d313391

Please sign in to comment.