v1

latestOpenAPI 3.0.32026-07-24354865.6 KB
Comparison

Impacted files comparison

Returns a comparison for either a pair of commits or a pull Will only return pre-computed impacted files comparisons if available If unavailable files will be empty, however once the computation is ready the files will appear on subsequent calls state: "processed" means files are finished computing and returned state: "pending" means files are still computing, poll again later

get/{service}/{owner_username}/repos/{repo_name}/compare/impacted_files

Path parameters

owner_usernamestring required

username from service provider

repo_namestring required

repository name

service'bitbucket' | 'bitbucket_server' | 'github' | 'github_enterprise' | 'gitlab' | 'gitlab_enterprise' required

Git hosting service provider

Query parameters

basestring

base commit SHA (head also required)

headstring

head commit SHA (base also required)

pullidinteger

pull ID on which to perform the comparison (alternative to specifying base and head)

Response

base_commitstring required
head_commitstring required
diffobject required
filesobject[] required
untrackedstring[] required
statestring required