{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/open-government-portugal/json-schema/open-government-portugal-resource-schema.json",
  "title": "Resource",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/open-government-portugal-datasets-api-openapi.yml#/components/schemas/Resource",
  "properties": {
    "checksum": {
      "allOf": [
        {
          "$ref": "#/$defs/Checksum"
        }
      ],
      "description": "A checksum to validate file validity"
    },
    "created_at": {
      "description": "The resource creation date",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "description": {
      "description": "The resource markdown description",
      "format": "markdown",
      "type": "string"
    },
    "extras": {
      "description": "Extra attributes as key-value pairs",
      "type": "object"
    },
    "filesize": {
      "description": "The resource file size in bytes",
      "type": "integer"
    },
    "filetype": {
      "description": "Whether the resource is an uploaded file, a remote file or an API",
      "enum": [
        "file",
        "remote"
      ],
      "type": "string"
    },
    "format": {
      "description": "The resource format",
      "type": "string"
    },
    "harvest": {
      "allOf": [
        {
          "$ref": "#/$defs/HarvestResourceMetadata"
        }
      ],
      "description": "Harvest attributes metadata information",
      "readOnly": true
    },
    "id": {
      "description": "The resource unique ID",
      "readOnly": true,
      "type": "string"
    },
    "internal": {
      "allOf": [
        {
          "$ref": "#/$defs/ResourceInternals"
        }
      ],
      "description": "Site internal and specific object's data",
      "readOnly": true
    },
    "last_modified": {
      "description": "The resource last modification date",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "latest": {
      "description": "The permanent URL redirecting to the latest version of the resource. When the resource data is updated, the URL will change, the latest URL won't.",
      "readOnly": true,
      "type": "string"
    },
    "metrics": {
      "description": "The resource metrics",
      "readOnly": true,
      "type": "object"
    },
    "mime": {
      "description": "The resource mime type",
      "type": "string"
    },
    "preview_url": {
      "description": "An optional preview URL to be loaded as a standalone page (ie. iframe or new page)",
      "readOnly": true,
      "type": "string"
    },
    "schema": {
      "allOf": [
        {
          "$ref": "#/$defs/Schema"
        }
      ],
      "description": "Reference to the associated schema"
    },
    "title": {
      "description": "The resource title",
      "type": "string"
    },
    "type": {
      "description": "Resource type (documentation, API...)",
      "enum": [
        "main",
        "documentation",
        "update",
        "api",
        "code",
        "other"
      ],
      "type": "string"
    },
    "url": {
      "description": "The resource URL",
      "type": "string"
    }
  },
  "required": [
    "filetype",
    "format",
    "title",
    "type",
    "url"
  ],
  "type": "object",
  "$defs": {
    "Checksum": {
      "properties": {
        "type": {
          "default": "sha1",
          "description": "The hashing algorithm used to compute the checksum",
          "enum": [
            "sha1",
            "sha2",
            "sha256",
            "md5",
            "crc"
          ],
          "type": "string"
        },
        "value": {
          "description": "The resulting checksum/hash",
          "type": "string"
        }
      },
      "required": [
        "value"
      ],
      "type": "object"
    },
    "HarvestResourceMetadata": {
      "properties": {
        "issued_at": {
          "description": "The resource harvested release date",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "modified_at": {
          "description": "The resource harvest last modification date",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "uri": {
          "description": "The resource harvest uri",
          "type": "string"
        }
      },
      "type": "object"
    },
    "ResourceInternals": {
      "properties": {
        "created_at_internal": {
          "description": "The resource's internal creation date on the site",
          "format": "date-time",
          "type": "string"
        },
        "last_modified_internal": {
          "description": "The resource's internal last modification date",
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "created_at_internal",
        "last_modified_internal"
      ],
      "type": "object"
    },
    "Schema": {
      "properties": {
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "version": {
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}