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

IQSS/9555 update list curation states api call #9556

Conversation

qqmyers
Copy link
Member

@qqmyers qqmyers commented Apr 24, 2023

What this PR does / why we need it: Documents the /listCurationStates api call and makes it work with all draft versions

Which issue(s) this PR closes:

Closes #9555

Special notes for your reviewer:

Suggestions on how to test this: Assign some curation labels to first or second draft versions and verify that the datasets appear in the CSV file returned when calling /api/datasets/listCurationStates as a superuser

Does this PR introduce a user interface change? If mockups are available, please link/include them here:
No

Is there a release notes update needed for this change?:

Additional documentation:

@qqmyers qqmyers added GDCC: QDR of interest to QDR GDCC: DataverseNO Size: 3 A percentage of a sprint. 2.1 hours. labels Apr 24, 2023
@coveralls
Copy link

coveralls commented Apr 24, 2023

Coverage Status

coverage: 20.372% (-0.02%) from 20.396% when pulling 7e4e299 on QualitativeDataRepository:IQSS/9555-update_listCurationStates_api_call into 6053fa3 on IQSS:develop.

@cmbz cmbz added this to the 5.14 milestone Jul 10, 2023
Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just fixing a tiny doc thing.

doc/sphinx-guides/source/api/curation-labels.rst Outdated Show resolved Hide resolved
@kcondon kcondon self-assigned this Jul 12, 2023
@kcondon
Copy link
Contributor

kcondon commented Jul 12, 2023

@qqmyers This works except the output goes to standard out rather than to a csv file as documented: "You should expect a 200 ("OK") response with a 'datasets.status.csv' file download."

@qqmyers
Copy link
Member Author

qqmyers commented Jul 12, 2023

FWIW: Curl doesn't respect the file name being sent by the server so the example doesn't download a file (doing the api call in the browser does). I've changed the docs to just note that the response is CSV-formatted. Also merged from dev.

@kcondon kcondon merged commit ce03581 into IQSS:develop Jul 12, 2023
7 checks passed
@qqmyers qqmyers deleted the IQSS/9555-update_listCurationStates_api_call branch May 17, 2024 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GDCC: DataverseNO GDCC: QDR of interest to QDR Size: 3 A percentage of a sprint. 2.1 hours.
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

/api/datasets/listCurationStates not documented and only works for first drafts
6 participants