Find symbol definitions

Returns all locations in the codebase where the given symbol is defined.

POST /api/find_definitions

Find symbol definitions

cURL

curl --request POST \
  --url https://api.example.com/api/find_definitions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "symbolName": "<string>",
  "language": "<string>",
  "revisionName": "<string>",
  "repoName": "<string>"
}
'

200

{
  "stats": {
    "matchCount": 123
  },
  "files": [
    {
      "fileName": "<string>",
      "repository": "<string>",
      "repositoryId": 123,
      "webUrl": "<string>",
      "language": "<string>",
      "matches": [
        {
          "lineContent": "<string>",
          "range": {
            "start": {
              "byteOffset": 123,
              "lineNumber": 123,
              "column": 123
            },
            "end": {
              "byteOffset": 123,
              "lineNumber": 123,
              "column": 123
            }
          }
        }
      ]
    }
  ],
  "repositoryInfo": [
    {
      "id": 123,
      "codeHostType": "github",
      "name": "<string>",
      "displayName": "<string>",
      "webUrl": "<string>"
    }
  ]
}

Authorizations

bearerTokenapiKeyHeader

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Body

application/json

symbolName · string · required

language · string

revisionName · string

repoName · string

Response

200

application/json

Symbol definition locations.

stats · object · required

Show child attributes

files · object[] · required

Show child attributes

repositoryInfo · object[] · required

Show child attributes