Github API - Test Config

Flexydox

CheckAnnotation [object]

A single check annotation.

Attributes
annotationLevel CheckAnnotationLevel

CheckAnnotationLevel [enum]

Represents an annotation's information level.

Possible values
FAILURE

An annotation indicating an inescapable error.

NOTICE

An annotation indicating some information.

WARNING

An annotation indicating an ignorable error.

API:
Github GraphQL API

The annotation's severity level.

blobUrl URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

The path to the file that this annotation was made on.

databaseId Int

Int [scalar]

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

API:
Github GraphQL API

Identifies the primary key from the database.

location CheckAnnotationSpan

CheckAnnotationSpan [object]

An inclusive pair of positions for a check annotation.

Attributes
end CheckAnnotationPosition

End position (inclusive).

start CheckAnnotationPosition

Start position (inclusive).

API:
Github GraphQL API

The position of this annotation.

message String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The annotation's message.

path String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The path that this annotation was made on.

rawDetails String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

Additional information about the annotation.

title String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The annotation's title

API:
Github GraphQL API