Code Search Result Item

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
name	string
path	string
sha	string
url	string
git_url	string
html_url	string
repository	object
score	number
file_size	integer
language	string
last_modified_at	string
line_numbers	array
text_matches	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/code-search-result-item",
  "title": "Code Search Result Item",
  "description": "Code Search Result Item",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "sha": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "git_url": {
      "type": "string",
      "format": "uri"
    },
    "html_url": {
      "type": "string",
      "format": "uri"
    },
    "repository": {
      "$ref": "#/components/schemas/minimal-repository"
    },
    "score": {
      "type": "number"
    },
    "file_size": {
      "type": "integer"
    },
    "language": {
      "type": "string",
      "nullable": true
    },
    "last_modified_at": {
      "type": "string",
      "format": "date-time"
    },
    "line_numbers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "73..77",
        "77..78"
      ]
    },
    "text_matches": {
      "$ref": "#/components/schemas/search-result-text-matches"
    }
  },
  "required": [
    "score",
    "name",
    "path",
    "sha",
    "git_url",
    "html_url",
    "url",
    "repository"
  ]
}