Skip to content

Commit

Permalink
[TF-2082] Update documentation with latest changes in TF API responses.
Browse files Browse the repository at this point in the history
- Adding project Id to the upload endpoint response
- Changing project id and build ids to string.
- updating upload response
  • Loading branch information
simon-sarrafi committed Sep 19, 2024
1 parent 3340079 commit 09ded4a
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 8 deletions.
6 changes: 3 additions & 3 deletions docs/testfairy/api-reference/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Returns a list of all projects (iOS and Android apps) in this account.
"status": "ok",
"projects": [
{
"id": "19-groupshot",
"id": "6905338",
"self": "/projects/19-groupshot",
"name":"GroupShot",
"packageName":"com.groupshot",
Expand Down Expand Up @@ -89,7 +89,7 @@ Get all builds in a specific project. Each build is a distinct version that is e
"status": "ok",
"builds": [
{
"id":8830728,
"id":"8830728",
"self":"/projects/6806100-myapplication/builds/8830728",
"projectId":"6806100",
"appName":"My Application",
Expand Down Expand Up @@ -140,7 +140,7 @@ Get a specific build of a specific project. Query the /api/1/projects/{proj
{
"status": "ok",
"build": {
"id":8830728,
"id":"8830728",
"self":"/projects/6806100-myapplication/builds/8830728",
"projectId":"6806100",
"appName":"My Application",
Expand Down
24 changes: 19 additions & 5 deletions docs/testfairy/api-reference/upload-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,11 +185,25 @@ In the case of an error, TestFairy returns a JSON with `status` => `fail` and `c
```json title="Sample Response"
{
"status": "ok",
"app_name": "Jigsaw Puzzlers",
"app_version": "0.9.5",
"app_url": "https://app.testfairy.com/download/6CWKJCHD60PPVWYJHGM4AADJQYA4SDR0/filename.apk",
"landing_page_url": "https://tsfr.io/3tajti",
"status": "ok",
"build_id": "106410",
"project_id": "61545",
"app_name": "My Demo App",
"app_version": "2.0.2",
"file_size": 2319620,
"build_url": "https://app.testfairy.com/projects/61545/builds/106410",
"download_page_url": "https://tsfr.io/31thr2",
"app_url": "https://app.testfairy.com/download/64R3CE1R6GRK0B9AXMCY77GJWBAW5K7XYV8K0T0CW/getapp",
"invite_testers_url": "https://app.testfairy.com/projects/61545/builds/106410/invite",
"icon_url": "https://s3.amazonaws.com/testfairy/icons/876033/230c74eece00376eb476516755.png",
"options": "video-quality=medium,screenshot-interval=1,session-length=60m,video,logcat,shake,cpu,memory,phone-signal,battery,wifi",
"platform": "iOS",
"tags": [],
"metadata": [],
"has_testfairy_sdk": true,
"symbols_download_url": "https://app.testfairy.com/api/1/projects/61545/builds/106410/symbols/download/",
"attachments": null,
"landing_page_url": "https://tsfr.io/31thr2"
}
```
Expand Down

0 comments on commit 09ded4a

Please sign in to comment.