GitHub · JSON Structure

Github Repo Issues Api Validation Error Structure

Validation Error

Type: object Properties: 3 Required: 2
CodePipelinesPlatformSoftware DevelopmentSource ControlT1

validation-error is a JSON Structure definition published by GitHub, describing 3 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

message documentation_url errors

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-issues-api-validation-error-structure.json",
  "name": "validation-error",
  "description": "Validation Error",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "Example body text"
    },
    "documentation_url": {
      "type": "string",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "code"
        ],
        "properties": {
          "resource": {
            "type": "string"
          },
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "index": {
            "type": "int32"
          },
          "value": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "integer"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          }
        }
      }
    }
  },
  "required": [
    "message",
    "documentation_url"
  ]
}