Skip to main content

Get References in Config

GET 
/v1/configs/:configId/code-references

Request​

Path Parameters

    configId uuidrequired

    The identifier of the Config.

Responses​

Schema

  • Array [

    • setting

    object

    Metadata of a Feature Flag or Setting.

    settingId int32

    Identifier of the Feature Flag or Setting.

    key stringnullable

    Key of the Feature Flag or Setting.

    name stringnullable

    Name of the Feature Flag or Setting.

    hint stringnullable

    Description of the Feature Flag or Setting.

    order int32

    The order of the Feature Flag or Setting represented on the ConfigCat Dashboard.

    settingType SettingType

    Possible values: [boolean, string, int, double]

    The type of the Feature Flag or Setting.

    configId uuid

    Identifier of the Feature Flag's Config.

    configName stringnullable

    Name of the Feature Flag's Config.

    tags

    object[]

    nullable

    The tags attached to the Feature Flag or Setting.

  • Array [

    • product

    object

    Details of the Product.

    organization

    object

    Details of the Organization.

    organizationId uuid

    Identifier of the Organization.

    name stringnullable

    Name of the Organization.

    productId uuid

    Identifier of the Product.

    name stringnullable

    Name of the Product.

    description stringnullable

    Description of the Product.

    order int32

    The order of the Product represented on the ConfigCat Dashboard. Determined from an ascending sequence of integers.

    reasonRequired boolean

    Determines whether a mandatory reason must be given every time when the Feature Flags or Settings within a Product are saved.

    tagId int64

    Identifier of the Tag.

    name stringnullable

    Name of the Tag.

    color stringnullable

    The configured color of the Tag.

  • ]

    • codeReferences

    object[]

    nullable

    List of Code references that belongs to the Feature Flag or Setting.

  • 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...