Tronald Dump · Schema

SourceListResponse

HAL response wrapper for the source document listing.

CommunityGames And ComicsOpen SourcePoliticsPublic APIsQuotesTrump

Properties

Name Type Description
count integer Number of sources returned on this page.
total integer Total number of sources in the system.
_embedded object
_links object HAL pagination links.
View JSON Schema on GitHub

JSON Schema

tronald-dump-source-list-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tronald-dump/refs/heads/main/json-schema/tronald-dump-source-list-response-schema.json",
  "title": "SourceListResponse",
  "description": "HAL response wrapper for the source document listing.",
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "description": "Number of sources returned on this page.",
      "example": 1
    },
    "total": {
      "type": "integer",
      "description": "Total number of sources in the system.",
      "example": 1
    },
    "_embedded": {
      "type": "object",
      "properties": {
        "sources": {
          "type": "array",
          "items": {
            "type": "object",
            "description": "A source document (tweet, transcript, article) underpinning a quote.",
            "properties": {
              "source_id": {
                "type": "string",
                "description": "Unique URL-safe identifier for the source.",
                "example": "2u3o8DcvSluqZ27WtmlGCw"
              },
              "url": {
                "type": "string",
                "format": "uri",
                "description": "Canonical URL of the source document.",
                "example": "https://twitter.com/realDonaldTrump/status/780494805192454144"
              },
              "filename": {
                "type": "string",
                "description": "Filename of the archived source on disk.",
                "example": "780494805192454144.txt"
              },
              "created_at": {
                "type": "string",
                "format": "date-time",
                "description": "The date and time the source was created.",
                "example": "2017-02-15T16:13:32.456Z"
              },
              "updated_at": {
                "type": "string",
                "format": "date-time",
                "description": "The date and time the source was last updated.",
                "example": "2017-02-15T16:13:32.456Z"
              },
              "_links": {
                "type": "object",
                "description": "HAL hypermedia links related to the source.",
                "additionalProperties": true
              }
            }
          }
        }
      }
    },
    "_links": {
      "type": "object",
      "description": "HAL pagination links.",
      "additionalProperties": true
    }
  }
}