Skip to content

Commit

Permalink
replace deprecated fields
Browse files Browse the repository at this point in the history
  • Loading branch information
Kerem Beygo committed Aug 20, 2024
1 parent 84a82ef commit 8c6d06b
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/visual-testing/workflows/api-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,15 @@ First, obtain a signed URL for uploading your image by using the `createSnapshot

```graphql
mutation {
createSnapshotUpload(input: {buildId: "build-id-here"}) {
createSnapshotUpload(input: {buildUuid: "build-id-here"}) {
id
uploadUrl
imageUploadUrl
domUploadUrl
}
}
```

- `buildId`: The ID of the build created in the previous step.
- `buildUuid`: The ID of the build created in the previous step.

**Expected Response:**

Expand All @@ -81,18 +81,18 @@ mutation {
"data": {
"createSnapshotUpload": {
"id": "upload-id-here",
"uploadUrl": "image-upload-url-here",
"imageUploadUrl": "image-upload-url-here",
"domUploadUrl": "dom-upload-url-here"
}
}
}
```

- `id`: Upload ID to use in the subsequent steps.
- `uploadUrl`: The URL to upload the image in the next step.
- `imageUploadUrl`: The URL to upload the image in the next step.
- `domUploadUrl`: The URL to upload the DOM to (if desired and available). Explained in the optional step below.

Next, send a `PUT` request to `uploadUrl` with image file in the body of the request. Only **PNG** files are supported.
Next, send a `PUT` request to `imageUploadUrl` with image file in the body of the request. Only **PNG** files are supported.

**cURL Request:**

Expand Down Expand Up @@ -135,7 +135,7 @@ mutation {
createSnapshot(
input: {
buildUuid: "build-id-here",
uploadId: "upload-id-here",
uploadUuid: "upload-id-here",
name: "Your snapshot name",
operatingSystem: OS,
operatingSystemVersion: "os-version",
Expand All @@ -149,7 +149,7 @@ mutation {
}
```
- `buildUuid`: Build ID that was used in previous steps.
- `uploadId`: Upload ID acquired with `createSnapshotUpload` in the previous step.
- `uploadUuid`: Upload ID acquired with `createSnapshotUpload` in the previous step.
- `operatingSystem`: The operating system used to take the snapshot. Strongly advised to be filled in. Available options: `ANDROID`, `IOS`, `LINUX`, `MACOS`, `WINDOWS`.
- `operatingSystemVersion`: The operating system version. e.g. "14.5" for `MACOS` or "11" for `WINDOWS`.
- `browser`: The browser used to take the snapshot. Strongly advised to be filled in (if available). Available options: `CHROME`, `EDGE`, `FIREFOX`, `PLAYWRIGHT_WEBKIT`, `SAFARI`.
Expand Down

0 comments on commit 8c6d06b

Please sign in to comment.