GitHub · JSON Structure

Github Repo Code Scanning Api Basic Error Structure

Basic Error

Type: object Properties: 4
CodePipelinesPlatformSoftware DevelopmentSource ControlT1

basic-error is a JSON Structure definition published by GitHub, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

message documentation_url url status

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-structure/github-repo-code-scanning-api-basic-error-structure.json",
  "name": "basic-error",
  "description": "Basic Error",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "Example body text"
    },
    "documentation_url": {
      "type": "string",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "url": {
      "type": "string",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "status": {
      "type": "string",
      "example": "open"
    }
  }
}