@wbg-mde/template-manager

{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "Timeseries Schema", "description": "Schema for timeseries data type", "type": "object", "properties": { "idno": { "type": "string", "title": "Unique user defined ID", "description": "Unique user defined ID for the dataset" }, "repositoryid": { "type": "string", "title": "Collection ID that owns the dataset", "description": "Abbreviation for the collection that owns the dataset" }, "access_policy": { "type": "string", "title": "Data access policy", "description": "Data access policy for attached microdata resources", "enum": [ "direct", "open", "public", "licensed", "remote", "na" ], "default": "na" }, "data_remote_url": { "type": "string", "title": "Data website URL", "description": "Link to the website where the data is available, this is only needed if `access_policy` is set to `remote`.", "default": 0 }, "published": { "type": "integer", "title": "Status", "description": "Status of the study - 0=draft, 1=published", "default": 0 }, "doc_desc": { "type": "object", "title": "Document Description", "description": "Document Description", "properties": { "title": { "title": "Document title", "description": "Document title", "type": "string" }, "idno": { "title": "Unique ID number for the document", "type": "string" }, "producers": { "type": "array", "title": "Producers", "description": "List of producers", "items": { "type": "object", "properties": { "name": { "title": "Name", "description": "Name (required)", "type": "string" }, "abbr": { "title": "Abbreviation", "type": "string" }, "affiliation": { "type": "string", "title": "Affiliation" }, "role": { "title": "Role", "type": "string" } } }, "required": [ "name" ] }, "prod_date": { "title": "Date of Production", "description": "Document production date using format(YYYY-MM-DD)", "type": "string" }, "version": { "title": "Document version", "description": "Identify and describe the current version of the document", "type": "string" } }, "additionalProperties": false }, "study_desc": { "type": "object", "title": "Study Description", "description": "Study Description", "properties": { "title": { "type": "string", "title": "Title", "description": "Dataset title" }, "abbreviation": { "type": "string", "title": "Abbreviation/Acronym", "description": "Acronym by which the dataset/database is referred to" }, "authoring_entity": { "type": "array", "title": "Authoring entity", "description": "The person, corporate body, or agency responsible for the work's substantive and intellectual content. Repeat the element for each author, and use 'affiliation' attribute if available. Invert first and last name and use commas.", "items": { "type": "object", "properties": { "name": { "title": "Agency Name", "type": "string", "description": "Name of the person, corporate body, or agency responsible for the work's substantive and intellectual content. If a person, invert first and last name and use commas." }, "role": { "title": "Role", "type": "string", "description": "Title of the person (if any) responsible for the work's substantive and intellectual content." }, "affiliation": { "title": "Affiliation", "type": "string" }, "abbreviation": { "title": "Abbreviation", "description": "Abbreviation" }, "email": { "title": "Email", "description": "Email" } }, "required": [ "name" ] } }, "abstract": { "title": "Abstract", "type": "string", "description": "A brief description of the database" }, "url": { "type": "string", "title": "Dataset URL", "description": "Link to the dataset web page" }, "type": { "type": "string", "title": "Dataset type", "description": "Dataset type" }, "doi": { "type": "string", "title": "DOI", "description": "DOI handle" }, "date_created": { "type": "string", "title": "Date of creation", "description": "Date this version of the dataset was created" }, "revision_dates": { "type": "array", "title": "Dates of revisions", "description": "Dates of revisions", "items": { "type": "object", "properties": { "date": { "title": "Date", "type": "string" }, "revision": { "title": "Revision", "description": "e.g. current, previous last revision", "type": "string" } } }, "required": [ "date" ] }, "date_published": { "type": "string", "title": "Dataset published date", "description": "Date this version of the dataset was published" }, "version": { "type": "object", "title": "Version Statement", "properties": { "version": { "title": "Version", "type": "string", "description": "Version number e.g. v1.0" }, "date": { "title": "Version Date", "type": "string" }, "responsibility": { "title": "Version Responsibility Statement", "description": "Version Responsibility Statement", "type": "string" }, "notes": { "title": "Version Notes", "type": "string" } } }, "update_frequency": { "title": "Frequency of update", "description": "Dataset frequency of updates (for datasets updated at regular intervals)", "type": "string" }, "update_schedule": { "title": "Schedule of updates", "description": "Dataset schedule of updates", "type": "array", "items": { "type": "object", "properties": { "identifier": { "title": "Schedule date (YYYY-MM-DD)", "type": "string" } } } }, "time_coverage": { "type": "array", "title": "Range of dates covered by the dataset", "description": "Time coverage for the whole database. This will typically be the min and max dates for which data are available in any series contained in the database.", "items": { "type": "object", "properties": { "start": { "title": "Start date", "description": "Time coverage, start date (oldest date for which data are available)", "type": "string" }, "end": { "title": "End date", "type": "string", "description": "Time coverage, end date (most recent date for which data are available)" } } } }, "periodicity": { "title": "Periodicity of series", "description": "Periodicity of the data contained in the database (NOT the periodicity of update of the database). This describes the various reference periods for the series. Example: Annual, quarterly, monthly, daily.", "type": "array", "items": { "type": "object", "properties": { "period": { "title": "Period", "type": "string", "enum": [ "annual", "semi-annual", "quarterly", "monthly", "weekly", "daily" ] } } } }, "topics": { "type": "array", "title": "Topics", "description": "Topics covered by the database (ideally, the list of topics will be a controlled vocabulary)", "items": { "type": "object", "properties": { "topic": { "title": "Topic", "type": "string" }, "vocabulary": { "title": "Vocabulary", "description": "Name of the controlled vocabulary, if the topic is from a taxonomy.", "type": "string" }, "uri": { "title": "Vocabulary URI", "description": "Link to the controlled vocabulary web page, if the topic is from a taxonomy.", "type": "string" } }, "required": [ "topic" ] } }, "keywords": { "title": "Keywords", "type": "array", "description": "Keywords describing the database (note: keywords can also be provided at the series level; see ser_keyword", "items": { "type": "object", "properties": { "keyword": { "title": "Keyword", "type": "string" }, "uri": { "title": "uri", "type": "string" } } } }, "geographic_units": { "title": "Geographic locations", "description": "List of geographic units (regions, countries, states, provinces, etc.) for which data are available in the database.", "type": "array", "items": { "type": "object", "properties": { "name": { "title": "Location name", "description": "Name of the geographic unit e.g. 'World', 'Africa', 'Afghanistan'", "type": "string" }, "code": { "title": "Location code", "description": "Code of the geographic unit (for countries, preferred = ISO3 code)", "type": "string" }, "type": { "title": "Type", "description": "Type of geographic unit e.g. country, state, region, province etc", "type": "string" } }, "required": [ "name" ] } }, "geogphic_coverage_note": { "type": "string", "title": "Geographic coverage notes", "description": "Notes on geographic coverage" }, "bbox": { "title": "Geographic bounding box", "description": "Geographic bounding box", "type": "array", "items": { "type": "object", "properties": { "west": { "title": "West", "type": "string" }, "east": { "title": "East", "type": "string" }, "south": { "title": "South", "type": "string" }, "north": { "title": "North", "type": "string" } } } }, "geographic_granularity": { "description": "Granularity of geographic coverage", "type": "string", "enum": [ "national", "regional", "provincial" ] }, "geographic_area_count": { "description": "Number of geographic areas", "type": "string" }, "sponsors": { "type": "array", "title": "Sponsor/Funding Agency", "description": "The source(s) of funds for production of the work. If different funding agencies sponsored different stages of the production process, use the 'role' attribute to distinguish them.", "items": { "type": "object", "properties": { "name": { "title": "Funding Agency/Sponsor", "type": "string", "description": "Name of the sponsoring agency" }, "abbreviation": { "title": "Abbreviation", "type": "string", "description": "Abbreviation (acronym) of the sponsoring agency" }, "role": { "title": "Role", "type": "string", "description": "Specific role of the sponsoring agency" }, "grant": { "title": "Grant", "type": "string", "description": "Grant number" } } }, "required": [ "name" ] }, "languages": { "type": "array", "description": "Supported languages", "items": { "type": "object", "properties": { "name": { "title": "Name", "description": "Language title", "type": "string" }, "code": { "title": "code", "Descripton": "Language code", "type": "string" } } }, "required": [ "name" ] }, "contacts": { "type": "array", "title": "Contacts", "description": "Contacts", "items": { "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "role": { "title": "Role", "type": "string" }, "affiliation": { "title": "Affiliation", "type": "string" }, "email": { "title": "Email", "type": "string" } } }, "required": [ "name" ] }, "access_options": { "type": "array", "title": "Access options", "description": "Access options e.g. API, Bulk, Query", "items": { "type": "object", "properties": { "type": { "title": "Access type", "description": "Access type e.g. API, Bulk, Query, etc", "type": "string" }, "uri": { "title": "URI", "type": "string" }, "note": { "title": "Note", "description": "Note", "type": "string" } }, "required": [ "type" ] } }, "license": { "type": "array", "title": "License", "description": "License information", "items": { "type": "object", "properties": { "type": { "title": "Type", "type": "string" }, "uri": { "title": "URI", "type": "string" }, "note": { "title": "Note", "type": "string" } } }, "required": [ "type" ] }, "citation": { "title": "Citation", "type": "string" }, "notes": { "title": "Notes", "type": "string" }, "acknowledgments": { "type": "array", "title": "Other Acknowledgments", "description": "Other Acknowledgments", "items": { "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "affiliation": { "title": "Affiliation", "type": "string" }, "role": { "title": "Role", "type": "string" } } }, "required": [ "name" ] }, "disclaimer": { "title": "Disclaimer", "type": "string" }, "copyright": { "title": "Copyright", "type": "string" } }, "required": [ "title" ] }, "data_files": { "type": "array", "items": { "$ref": "nada/datafile-schema.json" }, "description": "Timeseries database files" }, "series": { "type": "array", "description": "Series information", "items": { "$ref": "nada/series-schema.json#/definitions/series" } }, "additional": { "type": "object", "title": "Additional custom metadata", "description": "Any other custom metadata not covered by the schema", "properties": {} } }, "required": [ "idno", "study_desc" ] }