Upsource API Documentation Index

Messages

View as JSON

M CodeInspectionsDTO

FieldTypeLabelDescription
inspections InspectionCodeMarkupItemDTO repeated
See InspectionCodeMarkupItemDTO parameters
fileLevel FileWarningLevelEnum required
See FileWarningLevelEnum parameters

M FileContentDTO

FieldTypeLabelDescription
text string required
File text
foldings FoldingInfoDTO repeated
See FoldingInfoDTO parameters
isSyntaxSupported bool optional
Whether syntax markup is available for this file type
syntax TextMarkupDTO repeated
See TextMarkupDTO parameters

M FileContentRawResponseDTO

FieldTypeLabelDescription
base64 string required
Base64-encoded contents of a file

M FileContentResponseDTO

FieldTypeLabelDescription
contentType FileContentTypeDTO required
See FileContentTypeDTO parameters
fileContent FileContentDTO optional
See FileContentDTO parameters

M FileContentTypeDTO

FieldTypeLabelDescription
isText bool required
Whether the file is presentable as text
isDirectory bool required
Whether the file is a directory
isGenerated bool required
Whether file contents are generated
canDownload bool required
Whether the file can be downloaded
fileType string required
File extension

M FileContributorsResponseDTO

FieldTypeLabelDescription
authorIds string repeated
User IDs of the contributors
authoredChangesCounts int32 repeated
Number of changes made to the file
reviewedChangesCounts int32 repeated
Number of reviews performed on the file
majorContributorUserId string optional
The major contributor to the file, if there is one

M FilePsiRequestDTO

FieldTypeLabelDescription
file FileInRevisionDTO required
See FileInRevisionDTO parameters
requestReferences bool optional
Whether to request references
requestGutterMarks bool optional
Whether to request gutter marks
requestInspections bool optional
Whether to request inspections

M FilePsiResponseDTO

FieldTypeLabelDescription
hasPsi bool optional
Whether the code model is available for a file
psiStatusMessage string optional
PSI status message, e.g. a failure to provide code intelligence or another message regarding the file in general
referenceMarkup FileReferenceCodeMarkupDTO optional
See FileReferenceCodeMarkupDTO parameters
textMarkup FileTextMarkupDTO optional
See FileTextMarkupDTO parameters
gutterMarks GutterCodeMarkupsDTO optional
See GutterCodeMarkupsDTO parameters
inspections CodeInspectionsDTO optional
See CodeInspectionsDTO parameters
externalInspections InspectionCodeMarkupItemDTO repeated
External inspections

M FileReferenceCodeMarkupDTO

FieldTypeLabelDescription
markup ReferenceCodeMarkupItemDTO repeated
See ReferenceCodeMarkupItemDTO parameters
navigationPointsTable MarkupNavigationPointDTO repeated
See MarkupNavigationPointDTO parameters
fileNameTable FileInRevisionDTO repeated
See FileInRevisionDTO parameters
localDeclarationRanges LocalDeclarationRangeDTO repeated
See LocalDeclarationRangeDTO parameters

M FileTextMarkupDTO

FieldTypeLabelDescription
markup TextMarkupDTO repeated
See TextMarkupDTO parameters

M FoldingInfoDTO

FieldTypeLabelDescription
fromOffset int32 required
Start offset of the foldable range
toOffset int32 required
End offset of the foldable range
isInitialCollapsed bool required
Whether the range is initially collapsed
collapsedText string required
Text to be displayed in place of the folded range

M GutterCodeMarkupItemDTO

FieldTypeLabelDescription
range RangeDTO required
See RangeDTO parameters
gutterMark GutterMarkEnum repeated
See GutterMarkEnum parameters
relatedSemanticMarkup int32 required
Index in 'referenceMarkup' list this gutter mark corresponds to

M GutterCodeMarkupsDTO

FieldTypeLabelDescription
items GutterCodeMarkupItemDTO repeated
See GutterCodeMarkupItemDTO parameters

M InspectionCodeMarkupItemDTO

FieldTypeLabelDescription
range RangeDTO required
See RangeDTO parameters
textAttribute TextAttributeDTO required
See TextAttributeDTO parameters
message string required
Inspection message
severity InspectionSeverityEnum required
See InspectionSeverityEnum parameters
textAttributesKey string optional
Name (if any) of this markup key, given by IntelliJ IDEA

M InspectionsDiffDTO

FieldTypeLabelDescription
diffForFile InspectionsDiffForFileDTO repeated
See InspectionsDiffForFileDTO parameters

M InspectionsDiffForFileDTO

FieldTypeLabelDescription
path string required
A full path to the file starting with a slash (e.g. /directory/file.txt)
introduced InspectionCodeMarkupItemDTO repeated
Introduced problems. See InspectionCodeMarkupItemDTO parameters
fixed InspectionCodeMarkupItemDTO repeated
Fixed problems. See InspectionCodeMarkupItemDTO parameters
fixedOriginalRanges RangeDTO repeated
A list of ranges pointing to fixed problems in the original revision

M LocalDeclarationRangeDTO

FieldTypeLabelDescription
targetId int32 required
ID of the target element
startOffset int32 required
Start offset
endOffset int32 required
End offset

M MarkupNavigationPointDTO

FieldTypeLabelDescription
targetId int32 required
ID of the target element
fileId int32 required
Index of the file name as stored in the 'fileNameTable' table of the Upsource database
startOffset int32 required
Start offset
endOffset int32 required
End offset
stubIndex int32 required
Stub index ID

M ReferenceCodeMarkupItemDTO

FieldTypeLabelDescription
range RangeDTO required
See RangeDTO parameters
markupId int32 required
ID of the markup element
targetId int32 required
ID of the target element
capabilityFlags int32 required
Bit mask of the 'CapabilityFlagsEnum' enum
localIndex int32 required
Used to identify the exact reference when references overlap
hash string optional
Hash of the PSI element (if any), used to test PSI elements for equality

M TextAttributeDTO

FieldTypeLabelDescription
fgColor string optional
Foreground color
bgColor string optional
Background color
fontStyle string optional
Font style (italic, bold)
effectStyle string optional
Text effect (underline, wave underline, strikeout, etc.)
effectColor string optional
Effect color
errorStripeColor string optional
Error stripe color

M TextMarkupDTO

FieldTypeLabelDescription
range RangeDTO required
Text range
textAttribute TextAttributeDTO required
See TextAttributeDTO parameters

Enums

View as JSON

E CapabilityFlagsEnum

Describes "capabilities" of a PSI element
NameNumberDescription
canGotoDeclaration 1
canFindUsages 2
canViewHierarchy 4
canHaveDocumentation 8
isDeclaration 16
isWriteAccess 32

E FileWarningLevelEnum

Describes PSI inspections level
NameNumberDescription
none 1
ok 2
warning 3
error 4

E GutterMarkEnum

Describes the properties of a gutter marker
NameNumberDescription
hasSuperElements 1
hasDerivedElements 2

E InspectionSeverityEnum

Describes severity of an inspection result
NameNumberDescription
information 1
weak_warning 2
warning 3
error 4