{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/open-government-portugal/json-schema/open-government-portugal-harvest-source-page-schema.json",
  "title": "HarvestSourcePage",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/open-government-portugal-harvest-api-openapi.yml#/components/schemas/HarvestSourcePage",
  "properties": {
    "data": {
      "description": "The page data",
      "items": {
        "$ref": "#/$defs/HarvestSource"
      },
      "type": "array"
    },
    "next_page": {
      "description": "The next page URL if exists",
      "type": "string"
    },
    "page": {
      "description": "The current page",
      "minimum": 1,
      "type": "integer"
    },
    "page_size": {
      "description": "The page size used for pagination",
      "minimum": 0,
      "type": "integer"
    },
    "previous_page": {
      "description": "The previous page URL if exists",
      "type": "string"
    },
    "total": {
      "description": "The total paginated items",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "page",
    "page_size",
    "total"
  ],
  "type": "object",
  "$defs": {
    "Badge__read": {
      "properties": {
        "kind": {
          "type": "string"
        }
      },
      "required": [
        "kind"
      ],
      "type": "object"
    },
    "BaseReference": {
      "properties": {
        "class": {
          "description": "The object class",
          "type": "string"
        },
        "id": {
          "description": "The object unique identifier",
          "type": "string"
        }
      },
      "required": [
        "class",
        "id"
      ],
      "type": "object"
    },
    "DataserviceReference": {
      "allOf": [
        {
          "$ref": "#/$defs/BaseReference"
        },
        {
          "properties": {
            "self_api_url": {
              "description": "Link to the API endpoint for this dataservice",
              "readOnly": true,
              "type": "string"
            },
            "self_web_url": {
              "description": "Link to the udata web page for this dataservice",
              "readOnly": true,
              "type": "string"
            },
            "title": {
              "type": "string"
            }
          },
          "required": [
            "title"
          ],
          "type": "object"
        }
      ]
    },
    "DatasetReference": {
      "allOf": [
        {
          "$ref": "#/$defs/BaseReference"
        },
        {
          "properties": {},
          "type": "object"
        }
      ]
    },
    "HarvestError": {
      "properties": {
        "level": {
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      },
      "required": [
        "level",
        "message"
      ],
      "type": "object"
    },
    "HarvestItem": {
      "properties": {
        "args": {
          "default": [],
          "description": "The item positional arguments",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "created": {
          "description": "The item creation date",
          "format": "date-time",
          "type": "string"
        },
        "dataservice": {
          "allOf": [
            {
              "$ref": "#/$defs/DataserviceReference"
            }
          ],
          "description": "The processed dataservice"
        },
        "dataset": {
          "allOf": [
            {
              "$ref": "#/$defs/DatasetReference"
            }
          ],
          "description": "The processed dataset"
        },
        "ended": {
          "description": "The item end date",
          "format": "date-time",
          "type": "string"
        },
        "errors": {
          "description": "The item errors",
          "items": {
            "$ref": "#/$defs/HarvestError"
          },
          "type": "array"
        },
        "kwargs": {
          "default": {},
          "description": "The item keyword arguments",
          "type": "object"
        },
        "logs": {
          "description": "The item logs",
          "items": {
            "$ref": "#/$defs/HarvestError"
          },
          "type": "array"
        },
        "remote_id": {
          "description": "The item remote ID to process",
          "type": "string"
        },
        "remote_url": {
          "description": "The item remote url (if available)",
          "type": "string"
        },
        "started": {
          "description": "The item start date",
          "format": "date-time",
          "type": "string"
        },
        "status": {
          "description": "The item status",
          "enum": [
            "pending",
            "started",
            "done",
            "failed",
            "skipped",
            "archived"
          ],
          "type": "string"
        }
      },
      "required": [
        "created",
        "remote_id",
        "status"
      ],
      "type": "object"
    },
    "HarvestJob": {
      "properties": {
        "created": {
          "description": "The job creation date",
          "format": "date-time",
          "type": "string"
        },
        "ended": {
          "description": "The job end date",
          "format": "date-time",
          "type": "string"
        },
        "errors": {
          "description": "The job initialization errors",
          "items": {
            "$ref": "#/$defs/HarvestError"
          },
          "type": "array"
        },
        "id": {
          "description": "The job execution ID",
          "type": "string"
        },
        "items": {
          "description": "The job collected items",
          "items": {
            "$ref": "#/$defs/HarvestItem"
          },
          "type": "array"
        },
        "source": {
          "description": "The source owning the job",
          "type": "string"
        },
        "started": {
          "description": "The job start date",
          "format": "date-time",
          "type": "string"
        },
        "status": {
          "description": "The job status",
          "enum": [
            "pending",
            "initializing",
            "initialized",
            "processing",
            "done",
            "done-errors",
            "failed"
          ],
          "type": "string"
        }
      },
      "required": [
        "created",
        "id",
        "source",
        "status"
      ],
      "type": "object"
    },
    "HarvestSource": {
      "properties": {
        "active": {
          "default": false,
          "description": "Is this source active",
          "type": "boolean"
        },
        "autoarchive": {
          "default": true,
          "description": "If enabled, datasets not present on the remote source will be automatically archived",
          "type": "boolean"
        },
        "backend": {
          "description": "The source backend",
          "enum": [
            "ckan",
            "ckanpt",
            "csw-dcat",
            "csw-iso-19139",
            "cswudata",
            "dcat",
            "dgt",
            "dkan",
            "ine",
            "inehvd",
            "odspt",
            "ogc"
          ],
          "type": "string"
        },
        "config": {
          "description": "The configuration as key-value pairs, served only to readers who may edit the source",
          "type": "object"
        },
        "created_at": {
          "description": "The source creation date",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "datasets_count": {
          "description": "Number of datasets harvested by this source",
          "readOnly": true,
          "type": "integer"
        },
        "deleted": {
          "description": "The source deletion date",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "description": {
          "description": "The source description",
          "format": "markdown",
          "type": "string"
        },
        "id": {
          "description": "The source unique identifier",
          "readOnly": true,
          "type": "string"
        },
        "last_job": {
          "allOf": [
            {
              "$ref": "#/$defs/HarvestJob"
            }
          ],
          "description": "The last job for this source",
          "readOnly": true
        },
        "name": {
          "description": "The source display name",
          "type": "string"
        },
        "organization": {
          "allOf": [
            {
              "$ref": "#/$defs/OrganizationReference"
            }
          ],
          "description": "The producer organization"
        },
        "owner": {
          "allOf": [
            {
              "$ref": "#/$defs/UserReference"
            }
          ],
          "description": "The owner information"
        },
        "permissions": {
          "allOf": [
            {
              "$ref": "#/$defs/HarvestSourcePermissions"
            }
          ],
          "readOnly": true
        },
        "schedule": {
          "description": "The source schedule (interval or cron expression)",
          "readOnly": true,
          "type": "string"
        },
        "url": {
          "description": "The source base URL",
          "type": "string"
        },
        "validation": {
          "allOf": [
            {
              "$ref": "#/$defs/HarvestSourceValidation"
            }
          ],
          "description": "Has the source been validated",
          "readOnly": true
        }
      },
      "required": [
        "active",
        "autoarchive",
        "backend",
        "created_at",
        "name",
        "url"
      ],
      "type": "object"
    },
    "HarvestSourcePermissions": {
      "properties": {
        "delete": {
          "type": "boolean"
        },
        "edit": {
          "type": "boolean"
        },
        "preview": {
          "type": "boolean"
        },
        "run": {
          "type": "boolean"
        },
        "schedule": {
          "type": "boolean"
        },
        "validate": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "HarvestSourceValidation": {
      "properties": {
        "by": {
          "allOf": [
            {
              "$ref": "#/$defs/UserReference"
            }
          ],
          "description": "Who performed the validation",
          "readOnly": true
        },
        "comment": {
          "description": "A comment about the validation. Required on rejection",
          "type": "string"
        },
        "on": {
          "description": "Date date on which validation was performed",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "state": {
          "description": "Is it validated or not",
          "enum": [
            "pending",
            "accepted",
            "refused"
          ],
          "type": "string"
        }
      },
      "required": [
        "state"
      ],
      "type": "object"
    },
    "OrganizationPermissions": {
      "properties": {
        "delete": {
          "type": "boolean"
        },
        "edit": {
          "type": "boolean"
        },
        "harvest": {
          "type": "boolean"
        },
        "members": {
          "type": "boolean"
        },
        "private": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "OrganizationReference": {
      "allOf": [
        {
          "$ref": "#/$defs/BaseReference"
        },
        {
          "properties": {
            "acronym": {
              "description": "The organization acronym",
              "type": "string"
            },
            "badges": {
              "description": "The organization badges",
              "items": {
                "$ref": "#/$defs/Badge__read"
              },
              "readOnly": true,
              "type": "array"
            },
            "logo": {
              "description": "The organization logo URL",
              "type": "string"
            },
            "logo_thumbnail": {
              "description": "The organization logo thumbnail URL. This is the square (100x100) and cropped version.",
              "type": "string"
            },
            "name": {
              "description": "The organization name",
              "readOnly": true,
              "type": "string"
            },
            "page": {
              "description": "The organization web page URL",
              "readOnly": true,
              "type": "string"
            },
            "permissions": {
              "allOf": [
                {
                  "$ref": "#/$defs/OrganizationPermissions"
                }
              ],
              "readOnly": true
            },
            "slug": {
              "description": "The organization string used as permalink",
              "readOnly": true,
              "type": "string"
            },
            "uri": {
              "description": "The API URI for this organization",
              "readOnly": true,
              "type": "string"
            }
          },
          "type": "object"
        }
      ]
    },
    "UserReference": {
      "allOf": [
        {
          "$ref": "#/$defs/BaseReference"
        },
        {
          "properties": {
            "avatar": {
              "description": "The user avatar URL",
              "type": "string"
            },
            "avatar_thumbnail": {
              "description": "The user avatar thumbnail URL. This is the square (500x500) and cropped version.",
              "type": "string"
            },
            "first_name": {
              "description": "The user first name",
              "readOnly": true,
              "type": "string"
            },
            "last_name": {
              "description": "The user larst name",
              "readOnly": true,
              "type": "string"
            },
            "page": {
              "description": "The user web page URL",
              "readOnly": true,
              "type": "string"
            },
            "slug": {
              "description": "The user permalink string",
              "readOnly": true,
              "type": "string"
            },
            "uri": {
              "description": "The API URI for this user",
              "readOnly": true,
              "type": "string"
            }
          },
          "type": "object"
        }
      ]
    }
  }
}