GitQueryCommitsCriteria interface

Package:

azure-devops-extension-api

Properties

$skip	Number of entries to skip
$top	Maximum number of entries to retrieve
author	Alias or display name of the author
compareVersion	Only applicable when ItemVersion specified. If provided, start walking history starting at this commit.
excludeDeletes	Only applies when an itemPath is specified. This determines whether to exclude delete entries of the specified path.
fromCommitId	If provided, a lower bound for filtering commits alphabetically
fromDate	If provided, only include history entries created after this date (string)
historyMode	What Git history mode should be used. This only applies to the search criteria when Ids = null and an itemPath is specified.
ids	If provided, specifies the exact commit ids of the commits to fetch. May not be combined with other parameters.
includeLinks	Whether to include the _links field on the shallow references
includePushData	Whether to include the push information
includeUserImageUrl	Whether to include the image Url for committers and authors
includeWorkItems	Whether to include linked work items
itemPath	Path of item to search under
itemVersion	If provided, identifies the commit or branch to search
showOldestCommitsFirst	If enabled, this option will ignore the itemVersion and compareVersion parameters
toCommitId	If provided, an upper bound for filtering commits alphabetically
toDate	If provided, only include history entries created before this date (string)
user	Alias or display name of the committer

Property Details

$skip

Number of entries to skip

$skip: number

Property Value

number

$top

Maximum number of entries to retrieve

$top: number

Property Value

number

author

Alias or display name of the author

author: string

Property Value

string

compareVersion

Only applicable when ItemVersion specified. If provided, start walking history starting at this commit.

compareVersion: GitVersionDescriptor

Property Value

GitVersionDescriptor

excludeDeletes

Only applies when an itemPath is specified. This determines whether to exclude delete entries of the specified path.

excludeDeletes: boolean

Property Value

boolean

fromCommitId

If provided, a lower bound for filtering commits alphabetically

fromCommitId: string

Property Value

string

fromDate

If provided, only include history entries created after this date (string)

fromDate: string

Property Value

string

historyMode

What Git history mode should be used. This only applies to the search criteria when Ids = null and an itemPath is specified.

historyMode: GitHistoryMode

Property Value

GitHistoryMode

ids

If provided, specifies the exact commit ids of the commits to fetch. May not be combined with other parameters.

ids: string[]

Property Value

string[]

includeLinks

Whether to include the _links field on the shallow references

includeLinks: boolean

Property Value

boolean

includePushData

Whether to include the push information

includePushData: boolean

Property Value

boolean

includeUserImageUrl

Whether to include the image Url for committers and authors

includeUserImageUrl: boolean

Property Value

boolean

includeWorkItems

Whether to include linked work items

includeWorkItems: boolean

Property Value

boolean

itemPath

Path of item to search under

itemPath: string

Property Value

string

itemVersion

If provided, identifies the commit or branch to search

itemVersion: GitVersionDescriptor

Property Value

GitVersionDescriptor

showOldestCommitsFirst

If enabled, this option will ignore the itemVersion and compareVersion parameters

showOldestCommitsFirst: boolean

Property Value

boolean

toCommitId

If provided, an upper bound for filtering commits alphabetically

toCommitId: string

Property Value

string

toDate

If provided, only include history entries created before this date (string)

toDate: string

Property Value

string

user

Alias or display name of the committer

user: string

Property Value

string