Upsource API Documentation Index

Messages

View as JSON

M ElementDocumentationDTO

FieldTypeLabelDescription
docString string optional
Text of the element documentation

M FilePathToRootDTO

FieldTypeLabelDescription
fileName string required
A full path to the file starting with a slash (e.g. /directory/file.txt)
pathToRoot ProjectItemsListDTO required
See ProjectItemsListDTO parameters

M FindBranchRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
pattern string required
Search query, e.g. part of the branch name
limit int32 required
Max number of results to return

M FindBranchResponseDTO

FieldTypeLabelDescription
branches string repeated
The list of matched branches
hasMore bool required
Whether all available items have been returned or more can be requested by passing the corresponding 'limit' value in the subsequent request

M FindHierarchyResultDTO

FieldTypeLabelDescription
ancestors NavigationTargetItemDTO repeated
The list of element's ancestors
inheritors NavigationTargetItemDTO repeated
The list of element's inheritors

M FindUsagesItemDTO

FieldTypeLabelDescription
navigationTarget NavigationTargetItemDTO required
See NavigationTargetItemDTO parameters
previewText string required
Preview text
startOffsetInPreview int32 required
Start offset
endOffsetInPreview int32 required
End offset
lineNumber int32 required
Line number
isImportant bool required
Identifies if this usage is semantic-sensitive or not

M FindUsagesResponseDTO

FieldTypeLabelDescription
filePathToRoot FilePathToRootDTO repeated
See FilePathToRootDTO parameters
item FindUsagesItemDTO repeated
See FindUsagesItemDTO parameters

M GotoFileItemDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
revisionId string required
ID of the revision
fileName string required
A full path to the file starting with a slash (e.g. /directory/file.txt)
isDeleted bool required
Whether the file is deleted
lastModified int64 optional
Unix timestamp of the last modification
branch string optional
Branch name

M GotoFileRequestDTO

FieldTypeLabelDescription
projectId string optional
Project ID in Upsource
revisionId string optional
ID of the revision (search in heads if not provided)
reviewId ReviewIdDTO optional
See ReviewIdDTO parameters
pattern string required
Search query, e.g. part of the name
limit int32 required
Number of results to return

M GotoFileResponseDTO

FieldTypeLabelDescription
items GotoFileItemDTO repeated
See GotoFileItemDTO parameters
hasMore bool required
Whether all available items have been returned or more can be requested by passing the corresponding 'limit' value in the subsequent request

M NavigationTargetItemDTO

FieldTypeLabelDescription
fileId FileInRevisionDTO required
See FileInRevisionDTO parameters
startOffset int32 required
Start offset
endOffset int32 required
End offset
stubIndex int32 required
Stub index ID
targetDescription TargetDescriptionDTO optional
See TargetDescriptionDTO parameters

M PsiElementIdDTO

FieldTypeLabelDescription
fileId FileInRevisionDTO required
See FileInRevisionDTO parameters
range RangeDTO required
Text range of the given PSI element
localIndex int32 required
Copy of the localIndex from 'ReferenceCodeMarkupItemDTO' to identify the exact PSI element

M SameUsagesDTO

FieldTypeLabelDescription
oldUsage FindUsagesItemDTO required
Old usage of the element. See FindUsagesItemDTO parameters
newUsage FindUsagesItemDTO required
New usage of the element. See FindUsagesItemDTO parameters

M StubIdDTO

FieldTypeLabelDescription
fileId FileInRevisionDTO required
See FileInRevisionDTO parameters
stubIndex int32 required
Stub index ID

M TargetDescriptionDTO

FieldTypeLabelDescription
imageName string optional
ID of the element's image (if 'image' is none)
image string optional
Base62-encoded image (if 'imageName' is none)
targetPresentation string optional
Text representation of the given element
locationPresentation string optional
Text surrounding the element

M TextSearchItem

FieldTypeLabelDescription
file FileInRevisionDTO required
The file in a particular project and revision
revisionInfo RevisionInfoDTO required
See RevisionInfoDTO parameters
contentType FileContentTypeDTO required
File content type
isDeleted bool required
Whether this file is deleted
projectDetails TextSearchProjectDetails required
Project details
snippets TextSearchSnippet repeated
Code snippets
totalMatches int32 required
Total number of matches in the file

M TextSearchProjectDetails

FieldTypeLabelDescription
projectName string required
Holds the project name

M TextSearchRequestDTO

FieldTypeLabelDescription
projectId string optional
Project ID in Upsource
query string required
The search query
filenameFilter string optional
File name filter
ignoreDeleted bool required
Ignore matches in deleted files
ignoreArchived bool required
Whether to search in archived projects

M TextSearchResponseDTO

FieldTypeLabelDescription
items TextSearchItem repeated
The items that match the search query

M TextSearchSnippet

FieldTypeLabelDescription
text string required
Snippet text
startLineNumber int32 required
Start line number
rangeInSnippet RangeDTO required
Matching range in the snippet
rangeInFile RangeDTO required
Matching range in the file

M UsagesDiffByAnotherRevisionRequestDTO

FieldTypeLabelDescription
originElement PsiElementIdDTO required
Original element. See PsiElementIdDTO parameters
anotherRevisionId string required
ID of the other revision
isAnotherOld bool required
Whether the other revision is older

M UsagesDiffByBoundaryRevisionsRequestDTO

FieldTypeLabelDescription
originElement PsiElementIdDTO required
Original element. See PsiElementIdDTO parameters
newRevisionId string required
ID of the new revision
boundaryRevisionId string required
ID of the boundary revision

M UsagesDiffDTO

FieldTypeLabelDescription
oldFilePathToRoot FilePathToRootDTO optional
See FilePathToRootDTO parameters
newFilePathToRoot FilePathToRootDTO optional
See FilePathToRootDTO parameters
removedUsage FindUsagesItemDTO repeated
See FindUsagesItemDTO parameters
sameUsage SameUsagesDTO repeated
See SameUsagesDTO parameters
addedUsage FindUsagesItemDTO repeated
See FindUsagesItemDTO parameters

M UsagesDiffFullRequestDTO

FieldTypeLabelDescription
oldElement PsiElementIdDTO required
Old element. See PsiElementIdDTO parameters
newElement PsiElementIdDTO required
New element. See PsiElementIdDTO parameters

M UsagesDiffRequestDTO

FieldTypeLabelDescription
fullRequest UsagesDiffFullRequestDTO optional
See UsagesDiffFullRequestDTO parameters
requestByAnotherRevision UsagesDiffByAnotherRevisionRequestDTO optional
See UsagesDiffByAnotherRevisionRequestDTO parameters
requestByBoundaryRevisions UsagesDiffByBoundaryRevisionsRequestDTO optional
See UsagesDiffByBoundaryRevisionsRequestDTO parameters

M UsagesDiffResponseDTO

FieldTypeLabelDescription
oldRevisionId string required
ID of the old revision
newRevisionId string required
ID of the new revision
usages UsagesDiffDTO repeated
See UsagesDiffDTO parameters