Skip to content
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

Replace deprecated fields in Sauce Visual API Lifecycle documentation #2894

Merged
merged 1 commit into from
Aug 20, 2024
Merged

Replace deprecated fields in Sauce Visual API Lifecycle documentation #2894

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions docs/visual-testing/workflows/api-lifecycle.md
View file
Open in desktop
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
Loading