Dataverse rest api swagger (open api) documentation

[olimi...@gmail.com]

Hello every one,

I hope this mail finds you well.

I'm a user of dataverse APIs. I want to know if there is a swagger documentation of these APIs. if true, where can I find this documentation?

Best regards,

Michel

[danny...@g.harvard.edu]

Hi Michel, I hope you're doing well. To answer your question, this may be possible on Dataverse installations running Dataverse 5. I'm basing this answer on the discussion in https://github.com/IQSS/dataverse/issues/5794 that mentions the /openapi endpoint available on installations running Payara. Give it try on dataverse.harvard.edu and see if it provides the information that you expect. I'll let a more technical person give a better answer and perhaps we can also close that issue. 

Thanks for bringing this up!

- Danny

[Philip Durbin]

We used to get a large YAML dump (in Swagger/OpenAPI format) from endpoints like http://localhost:8080/openapi but now I'm seeing this:

paths: {}
components: {}

(I'm seeing the same on the demo server and Harvard Dataverse.)

On my laptop in server.log (attached) I'm seeing "OpenAPI document creation failed" followed by a long stack trace (including "Caused by: java.lang.StackOverflowError") followed by "No OpenAPI document found".

This is on Payara 5.2020.2.

So it seems pretty broken right now, unfortunately.

Phil

--
You received this message because you are subscribed to the Google Groups "Dataverse Users Community" group.
To unsubscribe from this group and stop receiving emails from it, send an email to dataverse-commu...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/dataverse-community/e19588bb-7f07-4c83-a01c-869e585ba2fdn%40googlegroups.com.

--

Philip Durbin
Software Developer for http://dataverse.org
http://www.iq.harvard.edu/people/philip-durbin

[olimi...@gmail.com]

Hi Danny and Phil

Thanks for answers. https://dataverse.harvard.edu/openapi give me the same response you et Phil.

Let's me know when the issue is resolve.

Best regards

[Philip Durbin]

I would suggest keeping an eye on https://github.com/IQSS/dataverse/issues/5794 which is the original issue about Swagger/OpenAPI support.

As I just wrote there, the next steps are probably to try newer versions of Payara and if that doesn't work, open a GitHub issue with Payara to report the problem. Anyone in the community is welcome to work on this, of course. :)

Thanks,

Phil

To view this discussion on the web visit https://groups.google.com/d/msgid/dataverse-community/24bd3010-b167-497c-850c-ffdb58d8ac74n%40googlegroups.com.