Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Metadata: create/update/get a dataset description #14

Open
kyao opened this issue Jun 1, 2020 · 0 comments
Open

Metadata: create/update/get a dataset description #14

kyao opened this issue Jun 1, 2020 · 0 comments

Comments

@kyao
Copy link
Contributor

kyao commented Jun 1, 2020

The metadata API is defined here: https://datamart-upload.readthedocs.io/en/latest/api/
The minimal JSON content for POST /datasets must include properties: name, description and url. Below is a sample JSON:

{
  "name": "World Bank Development Indicators",
  "description": "World Development Indicators (WDI) is the primary World Bank collection of development indicators, compiled from officially recognized international sources.",
  "url": "https://data.worldbank.org/indicator"
}

If the optional datasetID property is included, then the value of datasetID is used as the dataset identifier. Otherwise, a dataset identifier is automatically generated.

The method PUT /datasets/id updates an existing datasets with given JSON content.
The method GET /datasets/id returns the JSON description.

@kyao kyao changed the title Metadata /datasets and /datasets/id Metadata: create/update/get a dataset description Jun 1, 2020
@szeke szeke added this to the First delivery milestone Jun 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants