{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://catholiccorpus.org/schemas/source-sidecar-v1.json",
  "title": "CatholicCorpus Source Sidecar",
  "description": "Schema for _source.json provenance files that accompany downloaded content in CatholicCorpus. Each sidecar documents where a file (or group of files) came from, its license, and how to attribute it.",
  "type": "object",
  "required": [
    "corpus",
    "source_name",
    "source_url",
    "upstream_url",
    "description",
    "language",
    "date_downloaded",
    "license",
    "license_url",
    "license_details",
    "attribution_required",
    "attribution_text",
    "credit",
    "format",
    "estimated_words",
    "notes"
  ],
  "properties": {
    "corpus": {
      "type": "string",
      "const": "CatholicCorpus.org",
      "description": "Identifies this sidecar as belonging to the CatholicCorpus project. Always set to 'CatholicCorpus.org'."
    },
    "source_name": {
      "type": "string",
      "description": "Human-readable name of the source collection or text. Used in documentation and attribution. Examples: 'CSEL Latin Church Fathers', 'SBL Greek New Testament', 'Catholic Encyclopedia (1913)'."
    },
    "source_url": {
      "type": "string",
      "format": "uri",
      "description": "The URL from which the file(s) were actually downloaded. This may differ from upstream_url if the content is mirrored or repackaged. For git repos, this is the clone URL."
    },
    "upstream_url": {
      "type": "string",
      "format": "uri",
      "description": "The canonical URL of the original project or institution that produced the content. This is where a researcher would go to learn about the source. May be the same as source_url."
    },
    "description": {
      "type": "string",
      "description": "Detailed description of what this source contains, its scholarly significance, and its scope. Should be understandable to someone unfamiliar with the collection."
    },
    "language": {
      "type": "string",
      "description": "Primary language(s) of the content. Use standard language names. For multilingual sources, list all with the primary first. Examples: 'Latin', 'Ancient Greek', 'Latin (primary), English (translations)', 'Multilingual'."
    },
    "date_downloaded": {
      "type": "string",
      "format": "date",
      "description": "ISO 8601 date (YYYY-MM-DD) when the content was downloaded. Used to track provenance freshness."
    },
    "license": {
      "type": "string",
      "description": "Short license identifier. Controlled vocabulary: 'Public Domain', 'CC BY 4.0', 'CC BY-NC-SA 4.0', 'CC BY 4.0 with additional EULA', 'Non-commercial use permitted', 'Copyrighted (not redistributable)', 'Unclear'. If unclear, explain in license_details.",
      "examples": ["Public Domain", "CC BY 4.0", "CC BY-NC-SA 4.0", "Copyrighted (not redistributable)"]
    },
    "license_url": {
      "type": ["string", "null"],
      "format": "uri",
      "description": "URL to the full license text. Set to null for public domain works or when no license URL exists."
    },
    "license_details": {
      "type": "string",
      "description": "Extended explanation of the licensing situation. Should cover: why this license applies, any special conditions, whether commercial use is permitted, and any attribution requirements beyond what is captured in attribution_text."
    },
    "attribution_required": {
      "type": "boolean",
      "description": "Whether users of this content must provide attribution. True for Creative Commons licensed works; typically false for public domain. When true, the required attribution text is in attribution_text."
    },
    "attribution_text": {
      "type": ["string", "null"],
      "description": "The specific attribution text that must be included when using this content. Set to null when attribution_required is false. Should be copy-paste ready for inclusion in derivative works."
    },
    "credit": {
      "type": "object",
      "description": "Structured credit information for the digitization chain: who created the original, who translated it, who edited it, who digitized it, and who should be thanked.",
      "required": ["digitized_by", "digitizer_url", "original_author"],
      "properties": {
        "digitized_by": {
          "type": "string",
          "description": "The institution or individual responsible for creating the digital version. Examples: 'Internet Archive', 'Corpus Corporum (University of Zurich)', 'Christian Classics Ethereal Library'."
        },
        "digitizer_url": {
          "type": "string",
          "format": "uri",
          "description": "URL of the digitization project or institution."
        },
        "original_author": {
          "type": "string",
          "description": "The original author(s) of the text. For collections with multiple authors, name the primary or use 'Various'. For anonymous works, use the conventional attribution."
        },
        "translator": {
          "type": ["string", "null"],
          "description": "Translator name(s), if the content is a translation. Null for texts in their original language."
        },
        "editor": {
          "type": ["string", "null"],
          "description": "Editor of the edition used. For critical editions, name the editor. For Migne Patrologia, this is 'J.-P. Migne'. Null if no specific editor."
        },
        "publisher": {
          "type": ["string", "null"],
          "description": "Historical publisher of the print edition that was digitized. Null if not applicable or unknown."
        },
        "publication_year": {
          "type": ["string", "null"],
          "description": "Year or year range of the print edition. Examples: '1844-1865', '1885', '1913'. Null if unknown."
        },
        "thank_you": {
          "type": "string",
          "description": "A human-readable acknowledgment of the work involved in making this content available. Used in ACKNOWLEDGMENTS.md generation."
        }
      }
    },
    "format": {
      "type": "string",
      "description": "File format(s) of the downloaded content. Examples: 'TEI XML, plain text', 'PDF', 'EPUB and PDF', 'Unicode plain text', 'HTML (bilingual parallel text)'."
    },
    "estimated_words": {
      "type": ["string", "number"],
      "description": "Approximate word count of the content. Can be a number (140000) or a descriptive string ('Varies by translation', '55,000,000-113,000,000'). Used for corpus statistics."
    },
    "notes": {
      "type": ["string", "null"],
      "description": "Any additional context about this source that does not fit other fields. Null if nothing to add. Common uses: download caveats, known issues, relationship to other collections."
    },
    "article_count": {
      "type": "string",
      "description": "Number of discrete articles or entries, for encyclopedia-type sources. Optional; only present where meaningful (e.g., Catholic Encyclopedia with '10000+' articles)."
    }
  },
  "additionalProperties": false
}