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

correct docs for api/dataverses/$id/metadatablocks API endpoint #3624

Closed
pameyer opened this issue Feb 6, 2017 · 4 comments · Fixed by #6107
Closed

correct docs for api/dataverses/$id/metadatablocks API endpoint #3624

pameyer opened this issue Feb 6, 2017 · 4 comments · Fixed by #6107

Comments

@pameyer
Copy link
Contributor

pameyer commented Feb 6, 2017

Current docs have "The query body is a JSON array with a list of metadatablocks identifiers (either id or name)."; but curl -d $json_list fails with:
{"status":"ERROR","message":"Invalid token=EOF at (line no=1, column no=0, offset=-1). Expected tokens are: [CURLYOPEN, SQUAREOPEN]"}

--upload-file $json_list_in_file works as expected; but it's a field of the POST body (not the entire thing).

@pdurbin
Copy link
Member

pdurbin commented Feb 8, 2017

The native API docs could use a lot of work. That's what #2174 is about.

@pameyer
Copy link
Contributor Author

pameyer commented Feb 8, 2017

I've been adding functionality to #3440 as I've been running across things. Should I treat #2174 the same way for docs?

@pdurbin
Copy link
Member

pdurbin commented Feb 8, 2017

@pameyer let's both read or re-read http://blog.atom.io/2016/04/19/managing-the-deluge-of-atom-issues.html and chat sometime about the Dataverse GitHub issue tracker. I think there good ideas in there. Sometimes it makes sense to have a issue with a punchlist that is added to. The native API page is probably one of these. Here's my punchlist for the Installation Guide: #2944. We should also set expectations for the entire community in the CONTRIBUTING.md file per #2594, especially with regard to creating issues. You should keep doing what you're doing unless we update that doc, I'd say. 😄

@pdurbin
Copy link
Member

pdurbin commented Aug 21, 2019

We talked about this issue after standup today and decided to include a fix in pull request #6107 and add a "closes" to that pull request to close that issue after it goes through QA.

@pameyer is right. Using --file-upload works fine. I also like that now all the "out of the box" metadata blocks are enumerated. Here's a screenshot of this part of the API Guide looks now (in that pull request):

Screen Shot 2019-08-21 at 12 25 50 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants