post_v1_code_references

{
  "type": "object",
  "required": [
    "branch",
    "configId",
    "repository"
  ],
  "properties": {
    "activeBranches": {
      "type": "array",
      "description": "The currently active branches of the repository. Each previously uploaded report that belongs to a non-reported active branch is being deleted.",
      "items": {
        "type": "string"
      }
    },
    "branch": {
      "type": "string",
      "description": "The source control branch on where the scan was performed. (Source of the branch selector on the ConfigCat Dashboard)"
    },
    "commitHash": {
      "type": "string",
      "description": "The related commit's hash. (Appears on the ConfigCat Dashboard)"
    },
    "commitUrl": {
      "type": "string",
      "description": "The related commit's URL. (Appears on the ConfigCat Dashboard)"
    },
    "configId": {
      "type": "string",
      "format": "uuid",
      "description": "The Config's identifier the scanning was performed against."
    },
    "flagReferences": {
      "type": "array",
      "description": "The actual code reference collection.",
      "items": {
        "type": "object",
        "required": [
          "references",
          "settingId"
        ],
        "properties": {
          "references": {
            "type": "array",
            "description": "The actual references to the given Feature Flag or Setting.",
            "items": {
              "type": "object",
              "required": [
                "file",
                "referenceLine"
              ],
              "properties": {
                "file": {
                  "type": "string",
                  "description": "The file's name in where the code reference has been found. (Appears on the ConfigCat Dashboard)"
                },
                "fileUrl": {
                  "type": "string",
                  "description": "The file's url. (Used to point to the file on the repository's website)"
                },
                "postLines": {
                  "type": "array",
                  "description": "The lines after the actual reference line.",
                  "items": {
                    "type": "object",
                    "required": [
                      "lineNumber"
                    ],
                    "properties": {
                      "lineNumber": {
                        "type": "integer",
                        "format": "int32",
                        "description": "The line number of the reference line."
                      },
                      "lineText": {
                        "type": "string",
                        "description": "The content of the reference line."
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "preLines": {
                  "type": "array",
                  "description": "The lines before the actual reference line.",
                  "items": {
                    "type": "object",
                    "required": [
                      "lineNumber"
                    ],
                    "properties": {
                      "lineNumber": {
                        "type": "integer",
                        "format": "int32",
                        "description": "The line number of the reference line."
                      },
                      "lineText": {
                        "type": "string",
                        "description": "The content of the reference line."
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "referenceLine": {
                  "type": "object",
                  "required": [
                    "lineNumber"
                  ],
                  "properties": {
                    "lineNumber": {
                      "type": "integer",
                      "format": "int32",
                      "description": "The line number of the reference line."
                    },
                    "lineText": {
                      "type": "string",
                      "description": "The content of the reference line."
                    }
                  },
                  "additionalProperties": false
                }
              },
              "additionalProperties": false
            }
          },
          "settingId": {
            "type": "integer",
            "format": "int32",
            "description": "The identifier of the Feature Flag or Setting the code reference belongs to."
          }
        },
        "additionalProperties": false
      }
    },
    "repository": {
      "type": "string",
      "description": "The source control repository that contains the scanned code. (Source of the repository selector on the ConfigCat Dashboard)"
    },
    "uploader": {
      "type": "string",
      "description": "The scanning tool's name. (Appears on the ConfigCat Dashboard)"
    }
  },
  "additionalProperties": false
}