diff --git a/apis/sauce.json b/apis/sauce.json index 063129c1..3b787927 100644 --- a/apis/sauce.json +++ b/apis/sauce.json @@ -784,72 +784,6 @@ "name": "limit", "type": "number" }, - "manual_capabilities": { - "description": "desired capabilities to start the session", - "in": "body", - "name": "capabilities", - "required": true, - "schema": { - "properties": { - "assets": { - "description": "if true it stores assets of the manual job", - "type": "boolean" - }, - "browser": { - "description": "system browser name (e.g. \"chrome\")", - "type": "string" - }, - "browserDisplay": { - "description": "sanitized browser name displayed in the UI (e.g. \"Google Chrome\")", - "type": "string" - }, - "browserVersionDisplay": { - "description": "sanitized browser version (e.g. \"53\")", - "type": "string" - }, - "device": { - "description": "device name if manual testing is on mobile", - "type": "string" - }, - "os": { - "description": "system OS name (e.g. \"Windows 2012 R2\")", - "type": "string" - }, - "osDisplay": { - "description": "sanitized OS name (e.g. \"Windows\")", - "type": "string" - }, - "res": { - "description": "browser resolution (e.g. \"1400x1050\")", - "type": "string" - }, - "tunnel": { - "description": "tunnel id to run manual test on (if available)", - "type": "string" - }, - "url": { - "description": "url to navigate to", - "type": "string" - }, - "version": { - "description": "system browser version", - "type": "string" - } - }, - "required": [ - "assets", - "browser", - "browserDisplay", - "version", - "browserVersionDisplay", - "os", - "osDisplay", - "res", - "url" - ], - "type": "object" - } - }, "metric": { "description": "name of the category", "in": "body", @@ -884,13 +818,6 @@ "name": "subaccounts", "type": "boolean" }, - "taskId": { - "description": "task id of manual task", - "in": "path", - "name": "taskId", - "required": true, - "type": "string" - }, "username": { "description": "username", "in": "path", @@ -1219,256 +1146,6 @@ "tags": ["Info"] } }, - "/v1/manual": { - "delete": { - "description": "complete manual task", - "operationId": "delete_manual_job", - "parameters": [ - { - "description": "list of task ids that to complete", - "in": "body", - "name": "ids", - "required": true, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - } - ], - "produces": ["text/plain"], - "responses": { - "200": { - "description": "no response payload", - "schema": { - "type": "null" - } - } - }, - "summary": "complete manual task", - "tags": ["Manual"] - }, - "post": { - "description": "Creates a manual job", - "operationId": "create_manual_job", - "parameters": [ - { - "$ref": "#/parameters/manual_capabilities" - } - ], - "responses": { - "200": { - "description": "manual job was created successfully", - "schema": { - "description": "desired capabilities of manual job", - "properties": { - "error": { - "description": "false if job got created successfully", - "type": "boolean" - }, - "job_id": { - "description": "id of the job (available when created, otherwise \"null\")" - }, - "metadata": { - "description": "capabilities of the manual job", - "properties": { - "browser": { - "description": "system browser name (e.g. \"chrome\")", - "type": "string" - }, - "os": { - "description": "system OS name (e.g. \"Windows 2012 R2\")", - "type": "string" - }, - "resolution": { - "description": "browser resolution (e.g. \"1400x1050\")", - "type": "string" - }, - "tunnel": { - "description": "tunnel id to run manual test on (if available)" - }, - "url": { - "description": "start url of manual job", - "type": "string" - }, - "version": { - "description": "system browser version", - "type": "string" - } - }, - "required": ["url", "browser", "os", "version", "resolution"], - "type": "object" - }, - "task_id": { - "description": "id of the manual task", - "type": "string" - } - }, - "required": ["task_id", "metadata"], - "type": "object" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "summary": "Manual job creation", - "tags": ["Manual"] - } - }, - "/v1/manual/options/": { - "get": { - "description": "returns a list of supported platforms in the Sauce cloud", - "operationId": "list_manual_platforms", - "responses": { - "200": { - "description": "object with list of supported platforms", - "schema": { - "additionalProperties": { - "additionalProperties": { - "description": "operating system", - "properties": { - "browser": { - "type": "string" - }, - "platform": { - "type": "string" - }, - "resolutions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "version": { - "type": "string" - } - }, - "type": "object" - }, - "description": "browser version", - "type": "object" - }, - "description": "browser type (firefox, opera, chrome etc.)", - "type": "object" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "summary": "Platform list with options for desired capabilities", - "tags": ["Manual", "Platform"] - } - }, - "/v1/manual/{taskId}": { - "get": { - "description": "get manual task", - "operationId": "get_manual_job", - "parameters": [ - { - "$ref": "#/parameters/taskId" - } - ], - "responses": { - "200": { - "description": "returns manual task", - "schema": { - "description": "desired capabilities of manual job", - "properties": { - "browser": { - "description": "system browser name (e.g. \"chrome\")", - "type": "string" - }, - "members": { - "items": { - "type": "string" - }, - "type": "array" - }, - "os": { - "description": "system OS name (e.g. \"Windows 2012 R2\")", - "type": "string" - }, - "owner": { - "description": "owner of manual job", - "type": "string" - }, - "resolution": { - "description": "browser resolution (e.g. \"1400x1050\")", - "type": "string" - }, - "tunnel": { - "description": "tunnel id to run manual test on (if available)" - }, - "url": { - "description": "start url of manual job", - "type": "string" - }, - "version": { - "description": "system browser version", - "type": "string" - } - }, - "required": [ - "owner", - "url", - "browser", - "os", - "version", - "resolution", - "members" - ], - "type": "object" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "summary": "get manual task", - "tags": ["Manual"] - } - }, - "/v1/manual/{taskId}/screenshot": { - "post": { - "consumes": ["text/plain; charset=utf-8", "application/octet-stream"], - "description": "Take screenshot in manual session", - "operationId": "create_manual_job_screenshot", - "parameters": [ - { - "$ref": "#/parameters/taskId" - } - ], - "produces": ["text/plain"], - "responses": { - "201": { - "description": "screenshot successfully taken", - "schema": { - "type": "null" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "summary": "Take screenshot in manual session", - "tags": ["Manual"] - } - }, "/v1/me": { "get": { "operationId": "get_current_user", @@ -1506,107 +1183,6 @@ "summary": "Authenticated user cookie information" } }, - "/v1/tasks": { - "delete": { - "description": "complete manual task", - "operationId": "delete_manual_job_legacy", - "parameters": [ - { - "description": "list of task ids that to complete", - "in": "body", - "name": "ids", - "required": true, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - } - ], - "produces": ["text/plain"], - "responses": { - "200": { - "description": "no response payload", - "schema": { - "type": "null" - } - } - }, - "summary": "complete manual task", - "tags": ["Manual"] - }, - "post": { - "description": "Creates a manual job", - "operationId": "create_manual_job_legacy", - "parameters": [ - { - "$ref": "#/parameters/manual_capabilities" - } - ], - "responses": { - "200": { - "description": "manual job was created successfully", - "schema": { - "description": "desired capabilities of manual job", - "properties": { - "error": { - "description": "false if job got created successfully", - "type": "boolean" - }, - "job_id": { - "description": "id of the job (available when created, otherwise \"null\")" - }, - "metadata": { - "description": "capabilities of the manual job", - "properties": { - "browser": { - "description": "system browser name (e.g. \"chrome\")", - "type": "string" - }, - "os": { - "description": "system OS name (e.g. \"Windows 2012 R2\")", - "type": "string" - }, - "resolution": { - "description": "browser resolution (e.g. \"1400x1050\")", - "type": "string" - }, - "tunnel": { - "description": "tunnel id to run manual test on (if available)" - }, - "url": { - "description": "start url of manual job", - "type": "string" - }, - "version": { - "description": "system browser version", - "type": "string" - } - }, - "required": ["url", "browser", "os", "version", "resolution"], - "type": "object" - }, - "task_id": { - "description": "id of the manual task", - "type": "string" - } - }, - "required": ["task_id", "metadata"], - "type": "object" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "summary": "Manual job creation", - "tags": ["Manual"] - } - }, "/v1/users/{username}": { "get": { "operationId": "get_user",