Skip to main content

Upload References

POST 

/v1/code-references

Request

Body

required

    configId uuidrequired

    The Config's identifier the scanning was performed against.

    repository stringrequired

    Possible values: <= 255 characters

    The source control repository that contains the scanned code. (Source of the repository selector on the ConfigCat Dashboard)

    branch stringrequired

    Possible values: <= 255 characters

    The source control branch on where the scan was performed. (Source of the branch selector on the ConfigCat Dashboard)

    commitUrl stringnullable

    Possible values: <= 1000 characters

    The related commit's URL. (Appears on the ConfigCat Dashboard)

    commitHash stringnullable

    Possible values: <= 255 characters

    The related commit's hash. (Appears on the ConfigCat Dashboard)

    uploader stringnullable

    Possible values: <= 255 characters

    The scanning tool's name. (Appears on the ConfigCat Dashboard)

    activeBranches string[]nullable

    The currently active branches of the repository. Each previously uploaded report that belongs to a non-reported active branch is being deleted.

    flagReferences

    object[]

    nullable

    The actual code reference collection.

  • Array [

  • settingId int32required

    The identifier of the Feature Flag or Setting the code reference belongs to.

    references

    object[]

    required

    The actual references to the given Feature Flag or Setting.

  • Array [

  • file stringrequired

    Possible values: <= 255 characters

    The file's name in where the code reference has been found. (Appears on the ConfigCat Dashboard)

    fileUrl stringnullable

    Possible values: <= 1000 characters

    The file's url. (Used to point to the file on the repository's website)

    preLines

    object[]

    nullable

    The lines before the actual reference line.

  • Array [

  • lineText stringnullable

    Possible values: <= 1000 characters

    The content of the reference line.

    lineNumber int32required

    The line number.

  • ]

  • postLines

    object[]

    nullable

    The lines after the actual reference line.

  • Array [

  • lineText stringnullable

    Possible values: <= 1000 characters

    The content of the reference line.

    lineNumber int32required

    The line number.

  • ]

  • referenceLine

    object

    required

    Determines a code reference line.

    lineText stringnullable

    Possible values: <= 1000 characters

    The content of the reference line.

    lineNumber int32required

    The line number.

  • ]

  • ]

Responses

Success

Loading...