v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1329113117.1 KB
projects

Creates a Step. The returned Step will have the id set. May return any of the following canonical error codes: - 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

post/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps

Path parameters

projectIdstring required

Required. A Project id.

historyIdstring required

Required. A History id.

executionIdstring required

Required. An Execution id.

Query parameters

requestIdstring

A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.

Request body

descriptionstring

A description of this tool For example: mvn clean package -D skipTests=true - In response: present if set by create/update request - In create/update request: optional

hasImagesboolean

Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails. - In response: always set - In create/update request: never set

stepIdstring

A unique identifier within a Execution for this Step. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response: always set - In create/update request: never set

namestring

A short human-readable name to display in the UI. Maximum of 100 characters. For example: Clean build A PRECONDITION_FAILED will be returned upon creating a new step if it shares its name and dimension_value with an existing step. If two steps represent a similar action, but have different dimension values, they should share the same name. For instance, if the same set of tests is run on two different platforms, the two steps should have the same name. - In response: always set - In create request: always set - In update request: never set

state'unknownState' | 'pending' | 'inProgress' | 'complete'

The initial state is IN_PROGRESS. The only legal state transitions are * IN_PROGRESS -> COMPLETE A PRECONDITION_FAILED will be returned if an invalid transition is requested. It is valid to create Step with a state set to COMPLETE. The state can only be set to COMPLETE once. A PRECONDITION_FAILED will be returned if the state is set to COMPLETE multiple times. - In response: always set - In create/update request: optional

Response

Successful response