HubSpot · JSON Structure

Source Code Api Validation Result Structure

Result of file validation

Type: object Properties: 3 Required: 1

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

ValidationResult is a JSON Structure definition published by HubSpot, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

valid errors warnings

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/source-code-api-validation-result-structure.json",
  "name": "ValidationResult",
  "description": "Result of file validation",
  "type": "object",
  "properties": {
    "valid": {
      "type": "boolean",
      "description": "Whether the file passed validation",
      "example": true
    },
    "errors": {
      "type": "array",
      "description": "List of validation errors (if any)",
      "items": {
        "type": "object",
        "description": "A validation error",
        "required": [
          "message",
          "line"
        ],
        "properties": {
          "message": {
            "type": "string",
            "description": "Error description",
            "example": "Syntax error: unexpected end of template"
          },
          "line": {
            "type": "int32",
            "description": "Line number where the error occurred",
            "example": 42
          },
          "column": {
            "type": "int32",
            "description": "Column number where the error occurred",
            "example": 15
          },
          "category": {
            "type": "string",
            "description": "Error category",
            "example": "HUBL_SYNTAX"
          }
        }
      },
      "example": [
        {
          "message": "Syntax error: unexpected end of template",
          "line": 42,
          "column": 15,
          "category": "HUBL_SYNTAX"
        }
      ]
    },
    "warnings": {
      "type": "array",
      "description": "List of validation warnings (if any)",
      "items": {
        "type": "object",
        "description": "A validation warning",
        "required": [
          "message"
        ],
        "properties": {
          "message": {
            "type": "string",
            "description": "Warning description",
            "example": "Deprecated function 'blog_recent_posts' used"
          },
          "line": {
            "type": "int32",
            "description": "Line number where the warning occurred",
            "example": 28
          },
          "suggestion": {
            "type": "string",
            "description": "Suggested fix",
            "example": "Use 'blog_posts' function instead"
          }
        }
      },
      "example": [
        {
          "message": "Deprecated function 'blog_recent_posts' used",
          "line": 28,
          "suggestion": "Use 'blog_posts' function instead"
        }
      ]
    }
  },
  "required": [
    "valid"
  ]
}