add MyData API to dataverse documentaion #9596

sirineREKIK · 2023-05-16T07:38:32Z

add MyData API to dataverse documentaion

closes Document - Make use of MyData API "official" #5042

pdurbin · 2023-05-16T11:32:07Z

@sirineREKIK thanks for the pull request! Can you please take a look at these errors? https://github.com/IQSS/dataverse/actions/runs/4989177823/jobs/8932750403?pr=9596

Thanks!

(I'm giving this a size 3 because it shouldn't take much effort to review and QA.)

qqmyers · 2023-05-24T20:03:58Z

doc/sphinx-guides/source/api/native-api.rst

+Parameters:
+
+``key`` is the user token, for this API is must not be passed in the header.
+``role_id`` User roles, several possible values among:


Roles are customizable. Standard roles include:

qqmyers

Looks good. I think my only minor comment is that roles are customizable (i.e. by https://guides.dataverse.org/en/4.15.1/api/native-api.html#id24) so the values shown as parameters are only examples, not all possible values. It would be nice to have a change before this is merged, but I don't think it should be slowed down for that.

pdurbin

I haven't tested this and I'm wondering about the "key" thing but I left a little feedback. Thanks for working on this, @sirineREKIK! ❤️

doc/sphinx-guides/source/api/native-api.rst

pdurbin · 2023-06-01T21:48:03Z

doc/sphinx-guides/source/api/native-api.rst

+  export PUBLISHED_STATES=Unpublished
+  export PER_PAGE=10
+
+  curl -H GET http://$SERVER_URL/api/mydata/retrieve?key=$API_TOKEN&role_ids=$ROLE_IDS&dvobject_types=$DVOBJECT_TYPES&published_states=$PUBLISHED_STATES&per_page=$PER_PAGE


-H with no header?

sending -H with the API token is preferred to sending "key" (I just noticed the note about key below.) 🤔

I'd suggest removing GET since it's the default

https is preferred over http

I'd replace http://$SERVER_URL with $SERVER_URL

I'd put quotes around the URL because of all the & characters. Bash will get confused.

pdurbin · 2023-06-01T21:48:14Z

doc/sphinx-guides/source/api/native-api.rst

+
+Parameters:
+
+``key`` Is the user token, for this API is must not be passed in the header.


Is this true?

pdurbin · 2023-06-01T21:50:17Z

doc/sphinx-guides/source/api/native-api.rst

Can we have a release note snippet as well, please? For now (sorry), please see this issue:

give contributors guidance on how to write a release note snippet #9264

Co-authored-by: Philip Durbin <philipdurbin@gmail.com>

sirineREKIK · 2023-06-22T14:29:03Z

Can you check if everything is ok or if we need to do something else please?

pdurbin

https://dataverse-guide--9596.org.readthedocs.build/en/9596/api/native-api.html#mydata looks reasonable but I haven't tested it.

@kcondon if you could verify that indeed the API token can only be passes as a query parameter ("key") for this API rather than as header (curl -H ...), I would appreciate it!

kcondon · 2023-06-23T16:19:42Z

https://dataverse-guide--9596.org.readthedocs.build/en/9596/api/native-api.html#mydata looks reasonable but I haven't tested it.

@kcondon if you could verify that indeed the API token can only be passes as a query parameter ("key") for this API rather than as header (curl -H ...), I would appreciate it!

I am able to access this endpoint when passing the api_token ("key") in the header:

curl -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/mydata/retrieve?role_ids=$ROLE_IDS&dvobject_types=$DVOBJECT_TYPES&published_states=$PUBLISHED_STATES&per_page=$PER_PAGE"

This should be the preferred method since it is more secure. @sirineREKIK Would you mind updating the document to use the header or is there something we are missing here?

sirineREKIK · 2023-06-26T15:08:41Z

Hello,
@kcondon
From our side, when doing tests to access the endpoint when passing the api_token ("key") in the header, we got an authentication error, you can see the example below:

curl -H "X-Dataverse-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" "https://demo.dataverse.org/api/v1/mydata/retrieve?dvobject_types=Dataverse&dvobject_types=Dataset&published_states=Published&role_ids=8&per_page=5" | jq .
{
"success": false,
"error_message": "Requires authentication. Please login."
}

Also it is always the same return for all our installation environements.
I don't know if we are missing something, but as mentioned in the example, the test with the datavarese demo site is in error.

kcondon · 2023-06-27T13:28:52Z

@sirineREKIK Thank you for that information. I was able to reproduce the problem. I still believe passing the key in the header is the correct syntax since all of my previous testing with endpoints has confirmed this is the correct method. However, I do not yet know what's wrong in this case. Also, please note that this syntax is working on my test server.

kcondon · 2023-06-27T15:46:24Z

@sirineREKIK Ok, I have found the problem but don't know why yet. Release v5.13 appears to fail when passing the key in the header for this endpoint but works for others. in v5.14, due out soon, it works passing it in the header. So, I think we should therefore go with the header form. I'm checking here to see what's changed in the code that might have affected this endpoint. I know there was a roles change but thought it was about creating new roles and inheritance.

kcondon · 2023-06-28T15:02:13Z

@sirineREKIK It's been confirmed that due to other work in this area, the header behavior was fixed in v5.14. So, let's go with the key in the header format. Thanks! Regards, Kevin

sirineREKIK · 2023-07-07T07:21:31Z

@kcondon Thank you for that information. Changes are taken into account.
Regards, Sirine.

kcondon · 2023-07-07T13:40:22Z

@sirineREKIK Thanks, it looks great!

pdurbin · 2023-07-12T13:49:34Z

I'm glad the header works! Probably due to recent auth refactoring? 🤔

9293 - New filter-based design for the API authentication mechanisms (1/2) #9303

Not sure. 😄

kcondon · 2023-07-12T13:52:26Z

@pdurbin Yes. Guillermo fixed it. I believe this unpublished api implementation predated our move to using the header as a more secure way of passing info. So, really was just never implemented, I think?

add MyData API to dataverse documentaion

d576127

sirineREKIK mentioned this pull request May 16, 2023

Document - Make use of MyData API "official" #5042

Closed

pdurbin added Feature: API Guide Size: 3 A percentage of a sprint. 2.1 hours. labels May 16, 2023

sirineREKIK added 3 commits May 16, 2023 15:06

fix sphinx error

1792702

fix layout

ccd295f

change position api documentation

0587a7a

qqmyers reviewed May 24, 2023

View reviewed changes

qqmyers approved these changes May 24, 2023

View reviewed changes

change description of Roles

58452db

pdurbin reviewed Jun 1, 2023

View reviewed changes

sirineREKIK and others added 3 commits June 2, 2023 14:36

Update doc/sphinx-guides/source/api/native-api.rst

b80e3e9

Co-authored-by: Philip Durbin <philipdurbin@gmail.com>

curl url improvement

b14e06a

add release note

4bad996

pdurbin approved these changes Jun 22, 2023

View reviewed changes

kcondon self-assigned this Jun 23, 2023

kcondon added the Status: Needs Input Applied to issues in need of input from someone currently unavailable label Jul 6, 2023

add key in header api

1793b33

kcondon merged commit 4fcca3d into IQSS:develop Jul 7, 2023
1 check passed

kcondon removed the Status: Needs Input Applied to issues in need of input from someone currently unavailable label Jul 7, 2023

pdurbin added this to the 5.14 milestone Jul 12, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add MyData API to dataverse documentaion #9596

add MyData API to dataverse documentaion #9596

sirineREKIK commented May 16, 2023 •

edited by pdurbin

Loading

pdurbin commented May 16, 2023

qqmyers May 24, 2023

qqmyers left a comment

pdurbin left a comment

pdurbin Jun 1, 2023

pdurbin Jun 1, 2023

pdurbin Jun 1, 2023

sirineREKIK commented Jun 22, 2023

pdurbin left a comment

kcondon commented Jun 23, 2023

sirineREKIK commented Jun 26, 2023 •

edited

Loading

kcondon commented Jun 27, 2023 •

edited

Loading

kcondon commented Jun 27, 2023 •

edited

Loading

kcondon commented Jun 28, 2023

sirineREKIK commented Jul 7, 2023

kcondon commented Jul 7, 2023

pdurbin commented Jul 12, 2023

kcondon commented Jul 12, 2023


		Parameters:

		``key`` Is the user token, for this API is must not be passed in the header.

add MyData API to dataverse documentaion #9596

add MyData API to dataverse documentaion #9596

Conversation

sirineREKIK commented May 16, 2023 • edited by pdurbin Loading

pdurbin commented May 16, 2023

qqmyers May 24, 2023

Choose a reason for hiding this comment

qqmyers left a comment

Choose a reason for hiding this comment

pdurbin left a comment

Choose a reason for hiding this comment

pdurbin Jun 1, 2023

Choose a reason for hiding this comment

pdurbin Jun 1, 2023

Choose a reason for hiding this comment

pdurbin Jun 1, 2023

Choose a reason for hiding this comment

sirineREKIK commented Jun 22, 2023

pdurbin left a comment

Choose a reason for hiding this comment

kcondon commented Jun 23, 2023

sirineREKIK commented Jun 26, 2023 • edited Loading

kcondon commented Jun 27, 2023 • edited Loading

kcondon commented Jun 27, 2023 • edited Loading

kcondon commented Jun 28, 2023

sirineREKIK commented Jul 7, 2023

kcondon commented Jul 7, 2023

pdurbin commented Jul 12, 2023

kcondon commented Jul 12, 2023

sirineREKIK commented May 16, 2023 •

edited by pdurbin

Loading

sirineREKIK commented Jun 26, 2023 •

edited

Loading

kcondon commented Jun 27, 2023 •

edited

Loading

kcondon commented Jun 27, 2023 •

edited

Loading