WTO: Store descriptions of some datasets
Connected to #35 (closed)
- As a Web API software
- I want to read the description of datasets (if available) in
dataset.json
files - in order to respond them to the requester.
Acceptance criteria
-
The description of datasets stored in HTML pages MUST appear in the description
property ofdataset.json
. -
The description of datasets stored in XLS files MUST NOT be stored to complete this issue. -
The description MUST be plain text (not contain any HTML formatting). -
The description
property MUST NOT appear if there is no description. -
The descriptions DO NOT HAVE to be updated dynamically from the HTML.
Resources
Examples
Some providers publish a description of datasets (ie a text paragraph on the website, or a cell in an Excel file).
See a real-world example
Those descriptions should be stored in dataset.json
under a description
property, like so:
{
"dataset_code": "WTO-UNCTAD-ITC",
"description": "This file contains the complete WTO-UNCTAD-ITC trade in services dataset. It covers exports and imports of total commercial services broken down by detailed sector and by partner country when available. In addition to individual country data, some regional aggregations and economic groupings are available."
}
Edited by Christophe Benz