openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 86.7 kB
JSON
{"openapi":"3.0.0","info":{"contact":{"name":"Google","url":"https://google.com"},"description":"Reads and publishes results from Firebase Test Lab.","title":"Cloud Tool Results","version":"v1beta3","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-apisguru-categories":["developer_tools"],"x-logo":{"url":"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"},"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.7.18"},"format":"google","url":"https://www.googleapis.com/discovery/v1/apis/toolresults/v1beta3/rest","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"toolresults"},"externalDocs":{"url":"https://firebase.google.com/docs/test-lab/"},"tags":[{"name":"projects"}],"paths":{"/{projectId}/histories":{"get":{"description":"Lists Histories for a given Project.\n\nThe histories are sorted by modification time in descending order. The history_id key will be used to order the history with the same modification time.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist","operationId":"toolresults.projects.histories.list","parameters":[{"description":"If set, only return histories with the given name.\n\nOptional.","in":"query","name":"filterByName","schema":{"type":"string"}},{"description":"The maximum number of Histories to fetch.\n\nDefault value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100.\n\nOptional.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"A continuation token to resume the query at the next item.\n\nOptional.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListHistoriesResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Creates a History.\n\nThe returned History will have the id set.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing project does not exist","operationId":"toolresults.projects.histories.create","parameters":[{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"A unique request ID for server to detect duplicated requests. For example, a UUID.\n\nOptional, but strongly recommended.","in":"query","name":"requestId","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/History"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/History"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/{projectId}/histories/{historyId}":{"get":{"description":"Gets a History.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist","operationId":"toolresults.projects.histories.get","parameters":[{"description":"A History id.\n\nRequired.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/History"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/{projectId}/histories/{historyId}/executions":{"get":{"description":"Lists Executions for a given History.\n\nThe executions are sorted by creation_time in descending order. The execution_id key will be used to order the executions with the same creation_time.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist","operationId":"toolresults.projects.histories.executions.list","parameters":[{"description":"A History id.\n\nRequired.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"The maximum number of Executions to fetch.\n\nDefault value: 25. The server will use this default if the field is not set or has a value of 0.\n\nOptional.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"A continuation token to resume the query at the next item.\n\nOptional.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListExecutionsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Creates an Execution.\n\nThe returned Execution will have the id set.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist","operationId":"toolresults.projects.histories.executions.create","parameters":[{"description":"A History id.\n\nRequired.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"A unique request ID for server to detect duplicated requests. For example, a UUID.\n\nOptional, but strongly recommended.","in":"query","name":"requestId","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Execution"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Execution"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/{projectId}/histories/{historyId}/executions/{executionId}":{"get":{"description":"Gets an Execution.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Execution does not exist","operationId":"toolresults.projects.histories.executions.get","parameters":[{"description":"An Execution id.\n\nRequired.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"A History id.\n\nRequired.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Execution"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"patch":{"description":"Updates an existing Execution with the supplied partial entity.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal - NOT_FOUND - if the containing History does not exist","operationId":"toolresults.projects.histories.executions.patch","parameters":[{"description":"Required.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"Required.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"A Project id. Required.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"A unique request ID for server to detect duplicated requests. For example, a UUID.\n\nOptional, but strongly recommended.","in":"query","name":"requestId","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Execution"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Execution"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/{projectId}/histories/{historyId}/executions/{executionId}/clusters":{"get":{"description":"Lists Screenshot Clusters\n\nReturns the list of screenshot clusters corresponding to an execution. Screenshot clusters are created after the execution is finished. Clusters are created from a set of screenshots. Between any two screenshots, a matching score is calculated based off their metadata that determines how similar they are. Screenshots are placed in the cluster that has screens which have the highest matching scores.","operationId":"toolresults.projects.histories.executions.clusters.list","parameters":[{"description":"An Execution id.\n\nRequired.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"A History id.\n\nRequired.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListScreenshotClustersResponse"}}}}},"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/{projectId}/histories/{historyId}/executions/{executionId}/clusters/{clusterId}":{"get":{"description":"Retrieves a single screenshot cluster by its ID","operationId":"toolresults.projects.histories.executions.clusters.get","parameters":[{"description":"A Cluster id\n\nRequired.","in":"path","name":"clusterId","required":true,"schema":{"type":"string"}},{"description":"An Execution id.\n\nRequired.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"A History id.\n\nRequired.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ScreenshotCluster"}}}}},"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/{projectId}/histories/{historyId}/executions/{executionId}/steps":{"get":{"description":"Lists Steps for a given Execution.\n\nThe steps are sorted by creation_time in descending order. The step_id key will be used to order the steps with the same creation_time.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if an attempt is made to list the children of a nonexistent Step - NOT_FOUND - if the containing Execution does not exist","operationId":"toolresults.projects.histories.executions.steps.list","parameters":[{"description":"A Execution id.\n\nRequired.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"A History id.\n\nRequired.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"The maximum number of Steps to fetch.\n\nDefault value: 25. The server will use this default if the field is not set or has a value of 0.\n\nOptional.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"A continuation token to resume the query at the next item.\n\nOptional.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListStepsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Creates a Step.\n\nThe returned Step will have the id set.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist","operationId":"toolresults.projects.histories.executions.steps.create","parameters":[{"description":"A Execution id.\n\nRequired.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"A History id.\n\nRequired.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"A unique request ID for server to detect duplicated requests. For example, a UUID.\n\nOptional, but strongly recommended.","in":"query","name":"requestId","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Step"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Step"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}":{"get":{"description":"Gets a Step.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Step does not exist","operationId":"toolresults.projects.histories.executions.steps.get","parameters":[{"description":"A Execution id.\n\nRequired.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"A History id.\n\nRequired.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"A Step id.\n\nRequired.","in":"path","name":"stepId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Step"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"patch":{"description":"Updates an existing Step with the supplied partial entity.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal (e.g try to upload a duplicate xml file), if the updated step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist","operationId":"toolresults.projects.histories.executions.steps.patch","parameters":[{"description":"A Execution id.\n\nRequired.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"A History id.\n\nRequired.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"A unique request ID for server to detect duplicated requests. For example, a UUID.\n\nOptional, but strongly recommended.","in":"query","name":"requestId","schema":{"type":"string"}},{"description":"A Step id.\n\nRequired.","in":"path","name":"stepId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Step"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Step"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary":{"get":{"description":"Retrieves a PerfMetricsSummary.\n\nMay return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist","operationId":"toolresults.projects.histories.executions.steps.getPerfMetricsSummary","parameters":[{"description":"A tool results execution ID.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"A tool results history ID.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"The cloud project","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"A tool results step ID.","in":"path","name":"stepId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PerfMetricsSummary"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Creates a PerfMetricsSummary resource. Returns the existing one if it has already been created.\n\nMay return any of the following error code(s): - NOT_FOUND - The containing Step does not exist","operationId":"toolresults.projects.histories.executions.steps.perfMetricsSummary.create","parameters":[{"description":"A tool results execution ID.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"A tool results history ID.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"The cloud project","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"A tool results step ID.","in":"path","name":"stepId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfMetricsSummary"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PerfMetricsSummary"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries":{"get":{"description":"Lists PerfSampleSeries for a given Step.\n\nThe request provides an optional filter which specifies one or more PerfMetricsType to include in the result; if none returns all. The resulting PerfSampleSeries are sorted by ids.\n\nMay return any of the following canonical error codes: - NOT_FOUND - The containing Step does not exist","operationId":"toolresults.projects.histories.executions.steps.perfSampleSeries.list","parameters":[{"description":"A tool results execution ID.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"Specify one or more PerfMetricType values such as CPU to filter the result","in":"query","name":"filter","explode":true,"schema":{"type":"array","items":{"enum":["cpu","graphics","memory","network","perfMetricTypeUnspecified"],"type":"string"}}},{"description":"A tool results history ID.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"The cloud project","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"A tool results step ID.","in":"path","name":"stepId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListPerfSampleSeriesResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Creates a PerfSampleSeries.\n\nMay return any of the following error code(s): - ALREADY_EXISTS - PerfMetricSummary already exists for the given Step - NOT_FOUND - The containing Step does not exist","operationId":"toolresults.projects.histories.executions.steps.perfSampleSeries.create","parameters":[{"description":"A tool results execution ID.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"A tool results history ID.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"The cloud project","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"A tool results step ID.","in":"path","name":"stepId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfSampleSeries"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PerfSampleSeries"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}":{"get":{"description":"Gets a PerfSampleSeries.\n\nMay return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist","operationId":"toolresults.projects.histories.executions.steps.perfSampleSeries.get","parameters":[{"description":"A tool results execution ID.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"A tool results history ID.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"The cloud project","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"A sample series id","in":"path","name":"sampleSeriesId","required":true,"schema":{"type":"string"}},{"description":"A tool results step ID.","in":"path","name":"stepId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PerfSampleSeries"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples":{"get":{"description":"Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit\n\nMay return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries does not exist","operationId":"toolresults.projects.histories.executions.steps.perfSampleSeries.samples.list","parameters":[{"description":"A tool results execution ID.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"A tool results history ID.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"The default page size is 500 samples, and the maximum size is 5000. If the page_size is greater than 5000, the effective page size will be 5000","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional, the next_page_token returned in the previous response","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"The cloud project","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"A sample series id","in":"path","name":"sampleSeriesId","required":true,"schema":{"type":"string"}},{"description":"A tool results step ID.","in":"path","name":"stepId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListPerfSamplesResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples:batchCreate":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Creates a batch of PerfSamples - a client can submit multiple batches of Perf Samples through repeated calls to this method in order to split up a large request payload - duplicates and existing timestamp entries will be ignored. - the batch operation may partially succeed - the set of elements successfully inserted is returned in the response (omits items which already existed in the database).\n\nMay return any of the following canonical error codes: - NOT_FOUND - The containing PerfSampleSeries does not exist","operationId":"toolresults.projects.histories.executions.steps.perfSampleSeries.samples.batchCreate","parameters":[{"description":"A tool results execution ID.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"A tool results history ID.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"The cloud project","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"A sample series id","in":"path","name":"sampleSeriesId","required":true,"schema":{"type":"string"}},{"description":"A tool results step ID.","in":"path","name":"stepId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreatePerfSamplesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BatchCreatePerfSamplesResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails":{"get":{"description":"Lists thumbnails of images attached to a step.\n\nMay return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from the project, or from any of the images - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the step does not exist, or if any of the images do not exist","operationId":"toolresults.projects.histories.executions.steps.thumbnails.list","parameters":[{"description":"An Execution id.\n\nRequired.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"A History id.\n\nRequired.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"The maximum number of thumbnails to fetch.\n\nDefault value: 50. The server will use this default if the field is not set or has a value of 0.\n\nOptional.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"A continuation token to resume the query at the next item.\n\nOptional.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"A Step id.\n\nRequired.","in":"path","name":"stepId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListStepThumbnailsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}:publishXunitXmlFiles":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Publish xml files to an existing Step.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal, e.g try to upload a duplicate xml file or a file too large. - NOT_FOUND - if the containing Execution does not exist","operationId":"toolresults.projects.histories.executions.steps.publishXunitXmlFiles","parameters":[{"description":"A Execution id.\n\nRequired.","in":"path","name":"executionId","required":true,"schema":{"type":"string"}},{"description":"A History id.\n\nRequired.","in":"path","name":"historyId","required":true,"schema":{"type":"string"}},{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"A Step id. Note: This step must include a TestExecutionStep.\n\nRequired.","in":"path","name":"stepId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishXunitXmlFilesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Step"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/{projectId}/settings":{"get":{"description":"Gets the Tool Results settings for a project.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read from project","operationId":"toolresults.projects.getSettings","parameters":[{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ProjectSettings"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/{projectId}:initializeSettings":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Creates resources for settings which have not yet been set.\n\nCurrently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in an FTL-own storage project. Except for in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days.\n\nThe bucket is created with the following permissions: - Owner access for owners of central storage project (FTL-owned) - Writer access for owners/editors of customer project - Reader access for viewers of customer project The default ACL on objects created in the bucket is: - Owner access for owners of central storage project - Reader access for owners/editors/viewers of customer project See Google Cloud Storage documentation for more details.\n\nIf there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deleted, a new bucket will be created.\n\nMay return any canonical error codes, including the following:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage","operationId":"toolresults.projects.initializeSettings","parameters":[{"description":"A Project id.\n\nRequired.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ProjectSettings"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}}},"servers":[{"url":"https://www.googleapis.com/toolresults/v1beta3/projects"}],"components":{"parameters":{"alt":{"description":"Data format for the response.","in":"query","name":"alt","schema":{"type":"string","enum":["json"],"default":"json"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean","default":true}},"quotaUser":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"userIp":{"description":"Deprecated. Please use quotaUser instead.","in":"query","name":"userIp","schema":{"type":"string"}}},"requestBodies":{"Execution":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Execution"}}}},"Step":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Step"}}}}},"securitySchemes":{"Oauth2":{"description":"Oauth 2.0 authentication","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://accounts.google.com/o/oauth2/auth","scopes":{"https://www.googleapis.com/auth/cloud-platform":"View and manage your data across Google Cloud Platform services"}}}}},"schemas":{"AndroidAppInfo":{"description":"Android app information.","properties":{"name":{"description":"The name of the app. Optional","type":"string"},"packageName":{"description":"The package name of the app. Required.","type":"string"},"versionCode":{"description":"The internal version code of the app. Optional.","type":"string"},"versionName":{"description":"The version name of the app. Optional.","type":"string"}},"type":"object"},"AndroidInstrumentationTest":{"description":"A test of an Android application that can control an Android component independently of its normal lifecycle.\n\nSee for more information on types of Android tests.","properties":{"testPackageId":{"description":"The java package for the test to be executed. Required","type":"string"},"testRunnerClass":{"description":"The InstrumentationTestRunner class. Required","type":"string"},"testTargets":{"description":"Each target must be fully qualified with the package name or class name, in one of these formats: - \"package package_name\" - \"class package_name.class_name\" - \"class package_name.class_name#method_name\"\n\nIf empty, all targets in the module will be run.","items":{"type":"string"},"type":"array"},"useOrchestrator":{"description":"The flag indicates whether Android Test Orchestrator will be used to run test or not.","type":"boolean"}},"type":"object"},"AndroidRoboTest":{"description":"A test of an android application that explores the application on a virtual or physical Android device, finding culprits and crashes as it goes.","properties":{"appInitialActivity":{"description":"The initial activity that should be used to start the app. Optional","type":"string"},"bootstrapPackageId":{"description":"The java package for the bootstrap. Optional","type":"string"},"bootstrapRunnerClass":{"description":"The runner class for the bootstrap. Optional","type":"string"},"maxDepth":{"description":"The max depth of the traversal stack Robo can explore. Optional","format":"int32","type":"integer"},"maxSteps":{"description":"The max number of steps/actions Robo can execute. Default is no limit (0). Optional","format":"int32","type":"integer"}},"type":"object"},"AndroidTest":{"description":"An Android mobile test specification.","properties":{"androidAppInfo":{"$ref":"#/components/schemas/AndroidAppInfo"},"androidInstrumentationTest":{"$ref":"#/components/schemas/AndroidInstrumentationTest"},"androidRoboTest":{"$ref":"#/components/schemas/AndroidRoboTest"},"testTimeout":{"$ref":"#/components/schemas/Duration"}},"type":"object"},"Any":{"description":"`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\nFoo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }\n\nExample 2: Pack and unpack a message in Java.\n\nFoo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }\n\nExample 3: Pack and unpack a message in Python.\n\nfoo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...\n\nExample 4: Pack and unpack a message in Go\n\nfoo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ... }\n\nThe pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example \"foo.bar.com/x/y.z\" will yield type name \"y.z\".\n\n\n\nJSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:\n\npackage google.profile; message Person { string first_name = 1; string last_name = 2; }\n\n{ \"@type\": \"type.googleapis.com/google.profile.Person\", \"firstName\": , \"lastName\": }\n\nIf the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):\n\n{ \"@type\": \"type.googleapis.com/google.protobuf.Duration\", \"value\": \"1.212s\" }","properties":{"typeUrl":{"description":"A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)\n\nNote: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.","type":"string"},"value":{"description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte","type":"string"}},"type":"object"},"AppStartTime":{"properties":{"fullyDrawnTime":{"$ref":"#/components/schemas/Duration"},"initialDisplayTime":{"$ref":"#/components/schemas/Duration"}},"type":"object"},"BasicPerfSampleSeries":{"description":"Encapsulates the metadata for basic sample series represented by a line chart","properties":{"perfMetricType":{"enum":["cpu","graphics","memory","network","perfMetricTypeUnspecified"],"type":"string"},"perfUnit":{"enum":["byte","bytesPerSecond","framesPerSecond","kibibyte","percent","perfUnitUnspecified"],"type":"string"},"sampleSeriesLabel":{"enum":["cpuKernel","cpuTotal","cpuUser","graphicsFrameRate","memoryRssPrivate","memoryRssShared","memoryRssTotal","memoryTotal","networkReceived","networkSent","ntBytesReceived","ntBytesTransferred","sampleSeriesTypeUnspecified"],"type":"string"}},"type":"object"},"BatchCreatePerfSamplesRequest":{"description":"The request must provide up to a maximum of 5000 samples to be created; a larger sample size will cause an INVALID_ARGUMENT error","properties":{"perfSamples":{"description":"The set of PerfSamples to create should not include existing timestamps","items":{"$ref":"#/components/schemas/PerfSample"},"type":"array"}},"type":"object"},"BatchCreatePerfSamplesResponse":{"properties":{"perfSamples":{"items":{"$ref":"#/components/schemas/PerfSample"},"type":"array"}},"type":"object"},"CPUInfo":{"properties":{"cpuProcessor":{"description":"description of the device processor ie '1.8 GHz hexa core 64-bit ARMv8-A'","type":"string"},"cpuSpeedInGhz":{"description":"the CPU clock speed in GHz","format":"float","type":"number"},"numberOfCores":{"description":"the number of CPU cores","format":"int32","type":"integer"}},"type":"object"},"Duration":{"description":"A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years.\n\n# Examples\n\nExample 1: Compute Duration from two Timestamps in pseudo code.\n\nTimestamp start = ...; Timestamp end = ...; Duration duration = ...;\n\nduration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos;\n\nif (duration.seconds 0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (durations.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; }\n\nExample 2: Compute Timestamp from Timestamp + Duration in pseudo code.\n\nTimestamp start = ...; Duration duration = ...; Timestamp end = ...;\n\nend.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos;\n\nif (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; }\n\nExample 3: Compute Duration from datetime.timedelta in Python.\n\ntd = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td)\n\n# JSON Mapping\n\nIn JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix \"s\" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as \"3s\", while 3 seconds and 1 nanosecond should be expressed in JSON format as \"3.000000001s\", and 3 seconds and 1 microsecond should be expressed in JSON format as \"3.000001s\".","properties":{"nanos":{"description":"Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.","format":"int32","type":"integer"},"seconds":{"description":"Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years","format":"int64","type":"string"}},"type":"object"},"Execution":{"description":"An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step\n\nThe maximum size of an execution message is 1 MiB.\n\nAn Execution can be updated until its state is set to COMPLETE at which point it becomes immutable.","properties":{"completionTime":{"$ref":"#/components/schemas/Timestamp"},"creationTime":{"$ref":"#/components/schemas/Timestam