Searches through source code

v1.0.0

Performs a search through the full Debian Code Search corpus, blocking until all results are available (might take a few seconds depending on the search query).

Search results are ordered by their ranking (best results come first).

Input

{
  "type": "object",
  "properties": {
    "match_mode": {
      "type": "string",
      "enum": [
        "literal",
        "regexp"
      ]
    },
    "query": {
      "type": "string"
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "description": "A search result matching the specified query. You can use sources.debian.org to view the file contents. See https://github.com/Debian/dcs/blob/master/cmd/dcs-web/show/show.go for how to construct a sources.debian.org URL from a search result.",
    "required": [
      "context",
      "line",
      "package",
      "path"
    ],
    "properties": {
      "context": {
        "type": "string",
        "description": "The full line containing the search result."
      },
      "context_after": {
        "type": "array",
        "description": "Up to 2 full lines after the search result (see `context`).",
        "items": {
          "type": "string"
        }
      },
      "context_before": {
        "type": "array",
        "description": "Up to 2 full lines before the search result (see `context`).",
        "items": {
          "type": "string"
        }
      },
      "line": {
        "type": "integer",
        "format": "uint32",
        "description": "Line number containing the search result."
      },
      "package": {
        "type": "string",
        "description": "The Debian source package containing this search result, including the full Debian version number."
      },
      "path": {
        "type": "string",
        "description": "Path to the file containing the this search result, starting with `package`."
      }
    }
  }
}