File and column descriptions from dataset-metadata.json are still not saved (after #1055)
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
Research direction
Start with docs/datasets_metadata.md and trace datasets create, datasets version, and metadata --update through DatasetApiService.UpdateDatasetMetadata. Reproduce with the supplied dataset-metadata.json, inspect GetDatasetMetadata, and verify that file and column descriptions survive each command and appear in the Data Explorer.
Written by the indexing model from the issue text.
Description
Summary
File and column descriptions in dataset-metadata.json are accepted without error but never saved. This happens on datasets create, datasets version and datasets metadata --update. #447 and #248 were closed by #1055, but that PR changed only how the CLI builds the request. The server still drops the descriptions. Descriptions entered in the web editor are saved as expected.
The documentation says this should work:
- docs/datasets_metadata.md lists
resources(withpath,descriptionandschema.fields[].description) as supported forkaggle datasets createandkaggle datasets version. - The same page says
kaggle datasets metadata --update"supports all fields mentioned above forkaggle datasets version".
Environment
- kaggle 2.2.4, kagglesdk 0.1.37
- Python 3.14.3, Ubuntu (GitHub Actions
ubuntu-latest) - Authenticated with
KAGGLE_API_TOKEN
Steps to reproduce
-
Make a folder with
data.csv:year,category,grants 1977-78,Refugee,9326 1978-79,Refugee,12750 -
Add
dataset-metadata.jsonbeside it, following the documented format:{ "title": "Metadata description test", "id": "<your-username>/metadata-description-test", "licenses": [{"name": "CC0-1.0"}], "resources": [ { "path": "data.csv", "description": "Rows of the table, as CSV.", "schema": { "fields": [ {"name": "year", "description": "Financial year.", "type": "string"}, {"name": "category", "description": "Visa category.", "type": "string"}, {"name": "grants", "description": "Visas granted.", "type": "number"} ] } } ] } -
Create the dataset, wait until it is ready, then upload the same files as a new version:
kaggle datasets create -p . -u kaggle datasets status <your-username>/metadata-description-test # until "ready" kaggle datasets version -p . -m "second version with the same resources" -
Send the same file again as a metadata update:
kaggle datasets metadata <your-username>/metadata-description-test --update -p . -
Open the dataset page and select
data.csvin the Data Explorer.
Expected
"About this file" shows "Rows of the table, as CSV.", and each column shows its description. The usability rating ticks File Description and Column Description.
Actual
- "About this file" says "This file does not have a description yet", and no column has a description.
- The usability rating still crosses File Description and Column Description.
- Every command exits 0.
metadata --updateprints "successfully updated dataset metadata". - The other fields in the same update are saved: keywords,
expectedUpdateFrequency,userSpecifiedSourcesand the cover image.
What else we tried
All of these were accepted with an empty errors list, and none changed the page:
resourceswith the documented types (string,number,datetime), and withinteger.- Calling
DatasetApiService.UpdateDatasetMetadatathrough kagglesdk directly, withsettings.dataset toDatasetSettingsFileentries in four forms: description only; description andtotalBytes; those pluscolumns; and all three files of the dataset. - Three dataset versions uploaded with
resourcespresent (createonce, thenversiontwice).
GetDatasetMetadata returns info.data as an empty list after each update, as #410 also notes.
Example
A public dataset that shows the problem: https://www.kaggle.com/datasets/nationaldigitalau/au-humanitarian-program-grants. Version 3 was uploaded with resources for all three files and then sent the same settings through metadata --update.
- Dominant language
- Python
- Stars
- 7.7k
- Forks
- 1.5k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 17
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Kaggle/kaggle-cli
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Kaggle/kaggle-cli#1254 ·
Maintainers usually reply within 1 day
-
duplicate
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Kaggle/kaggle-cli#1248 · 1 comment ·
Maintainers usually reply within 1 day
-
datasets metadata --update crops cover images larger than 560x280 to their top-left cornerPossibly taken @tb91117 claimed this today. Open
Difficulty 4/5 3-5 days Newbie friendliness 55/100
Kaggle/kaggle-cli#1250 ·
Maintainers usually reply within 1 day
-
bug dependencies
Difficulty 3/5 1-2 days Newbie friendliness 52/100
Kaggle/kaggle-cli#1229 · 2 comments ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 Under an hour Newbie friendliness 50/100
Kaggle/kaggle-cli#1217 ·
Maintainers usually reply within 1 day
All issues in Kaggle/kaggle-cli
Similar issues
-
Implement parse_url and accept http URLs for CPAN backendPossibly taken @patelshivani2283-lab claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
fedora-infra/anitya#2203 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
jingyaogong/minimind#947 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
berntpopp/litvar-link#173 ·
Maintainers usually reply within 1 day
-
area/compression comp/agent P2 type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
NousResearch/hermes-agent#158133 ·
Maintainers usually reply within 1 day