Skip to main content

Get References for Feature Flag or Setting

GET 
/v1/settings/:settingId/code-references

Request​

Path Parameters

    settingId int32required

    The identifier of the Feature Flag or Setting.

Responses​

Schema

  • Array [

    • branch stringnullable

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

    references

    object[]

    nullable

    The actual references to the given Feature Flag or Setting.

  • Array [

    • file stringrequired

    Possible values: non-empty and <= 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.

  • ]

    • commitUrl stringnullable

    The related commit's URL.

    commitHash stringnullable

    The related commit's hash.

    syncedAt date-time

    The date and time when the reference report was uploaded.

    repository stringnullable

    The source control repository that contains the scanned code.

    codeReferenceId uuid

    The identifier of the reference report.

    uploader stringnullable

    The code reference scanning tool's name.

  • ]

Loading...