Schema of Dataverse API

[黃晴]

Dear all,

If there is a schema for Dataverse API, either in json or yaml format, that i can use to create the api in my Postman! Any feedback would be appreciated!

[Vyacheslav Tikhonov]

Hi,

There is Dataverse schema in .nt format, you can easily get it in the knowledge graph with rdflib and serialise as json-ld:

https://github.com/Dans-labs/semaf-client/tree/master/schema

Best,

Slava

[D. M. Wen]

I think there is some misunderstanding here. What we were trying to do is to get a schema, in JSON or YAML file format, that we can create a Dataverse API environment on the API Platform --  Postman! Hope this would clarify our needs.

Best,

Joseph Wen 

[Vyacheslav Tikhonov]

Got it, it looks like you want OpenAPI specs for Dataverse API. Phil?

[D. M. Wen]

Indeed, in a more specifically manner, both schema type -- OpenAPI is one of the options, and also schema format -- which is either JSON or YAML file format!

[o.be...@fz-juelich.de]

Depending on what you are trying to do:

No support for JSON Schema: https://github.com/IQSS/dataverse/issues/7173

Support for OpenAPI: https://github.com/IQSS/dataverse/issues/5794 see https://demo.dataverse.org/openapi for an example

[Philip Durbin]

Just a +1 for Oliver's post.

It sounds like OpenAPI/Swagger for Dataverse APIs is what's wanted. You can get this in YAML at https://demo.dataverse.org/openapi (or from your own server).

Thanks,

Phil

p.s. Very cool that Slava figured out the JSON Schema for the JSON we use to create datasets. People have been asking for this for years (such as Oliver in #7173, like he mentioned)!

--
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/20cbe0d9-0881-4326-a911-2146c3c30558n%40googlegroups.com.

--

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

[D. M. Wen]

Folks,

Got it! Right to the point, this is exactly what I need. 

Philip, your reference on YAML point is extremely valuable! Thanks again

Joseph Wen
 

[R F]

Hi,

It seems like the OpenApi specs are not up to date or am I missing something

E.g. the endpoint for getting dataset information according to the OpenApi specs is:

/api/v1/access/dataset/{id}

while the documentation rightly writes:

api/datasets/:persistentId/?persistentId={PERSISTENT_ID}.

[Sherry Lake]

Hello,

Both are correct ways to use API endpoints, either with a dataset  (or file) "ID" or with the Persistent ID. Here is where that is documented in the documents & applies to dataset ids as well. I think that this information does need to go in other parts of the API documentation. I'll add that to my hacktoberfest list (after I create a ticket).

https://guides.dataverse.org/en/latest/api/dataaccess.html#basic-file-access 

Basic File Access

Basic access URI:

/api/access/datafile/$id

Note

Files can be accessed using persistent identifiers. This is done by passing the constant :persistentId where the numeric id of the file is expected, and then passing the actual persistent id as a query parameter with the name persistentId.

Example: Getting the file whose DOI is 10.5072/FK2/J8SJZB

GET http://$SERVER/api/access/datafile/:persistentId?persistentId=doi:10.5072/FK2/J8SJZB

--

Sherry Lake

To view this discussion on the web visit https://groups.google.com/d/msgid/dataverse-community/401ad04f-a5b5-4d09-870e-10458a74f068n%40googlegroups.com.