library/com.gabrielfeo.develocity.api/ComparisonApi/getComparisonInputs

getComparisonInputs

@GET(value = "api/comparison/inputs")

abstract suspend fun getComparisonInputs(@Query(value = "buildIdA") buildIdA: String, @Query(value = "buildIdB") buildIdB: String, @Query(value = "workUnitPath") workUnitPath: List<String>? = null, @Query(value = "cacheability") cacheability: String? = null, @Query(value = "className") className: String? = null, @Query(value = "offset") offset: Int? = 0, @Query(value = "limit") limit: Int? = 20): ComparisonInputsResponse

GET api/comparison/inputs Get work unit input differences between two builds. <mark>Beta:</mark> Returns work unit input comparison data with full detail for each work unit. Each work unit includes identity, difference types, build metadata, and all change details (value input changes, file input changes with recursive file tree, output changes, and action changes). Optional filters narrow which work units are returned: - `workUnitPath`: filter by specific work unit path(s). For Gradle, this is the task path (e.g. `:app:compileJava`). For Maven, this is the full goal execution coordinates (e.g. `groupId:artifactId:goalName:executionId`). - `cacheability`: filter by cacheability status (e.g. `CACHEABLE`). - `className`: filter by work unit implementation class name (e.g. `org.gradle.api.tasks.compile.JavaCompile`). Responses:

200: Work unit input comparison data with full detail for each work unit.
400: The request cannot be fulfilled due to a problem.
404: The referenced resource either does not exist or the permissions to know about it are missing.
500: The server encountered an unexpected error.
503: The server is not ready to handle the request.

Return

ComparisonInputsResponse

Parameters

buildIdA

Build Scan ID of build A.

buildIdB

Build Scan ID of build B.

workUnitPath

Filter by specific work unit path(s). Can be repeated for multiple paths. For Gradle, this is the task path (e.g. `:app:compileJava`). For Maven, this is the full goal execution coordinates (e.g. `groupId:artifactId:goalName:executionId`). (optional)

cacheability

Filter work units by cacheability status (e.g. `CACHEABLE`). Only returns work units where at least one build has this cacheability. (optional)

className

Filter work units by implementation class name (e.g. `org.gradle.api.tasks.compile.JavaCompile`). Returns all work units matching this class in either build. (optional)

offset

The offset of the first work unit to return. (optional, default to 0)

limit

The maximum number of work units to return. (optional, default to 20)