Time
S
Nick
Message
08:43 JonathanNeal joined #dataverse
08:59 stefankasberger joined #dataverse
09:39 stefankasberger joined #dataverse
10:36 pdurbin joined #dataverse
10:36 pdurbin
mornin' all
11:02 stefankasberger
morning!
11:03 pdurbin
stefankasberger: back from vacation? How was it?
11:08 yoh joined #dataverse
11:25 stefankasberger
nice. been at my parents house on the countryside. most time at the lake near by. really relaxing. :)
11:30 pdurbin
Nice. Can I pick your brain about API documentation?
11:32 pdurbin
I'm giving a talk tomorrow morning about Dataverse APIs: https://groups.google.com/d/msg/dataverse-community/V5WkMGDS4VI/maxXTdmzDwAJ
11:59 stefankasberger
Sure. The comments from Sherry and Dimitri are the things I have thought of first. So great to add them.
12:01 stefankasberger
here my slides from the community meeting. maybe they help. https://zenodo.org/record/3265128
12:03 stefankasberger
one thing, that i asked myself: is it mandatory to add the typeClass and multiple attributes to the Dataset JSON ?
12:03 stefankasberger
and which attributes are required in the JSON file, for Dataverse, Dataset and Datafile.
12:04 stefankasberger
kind of a specification for the JSON files.
12:04 stefankasberger
and: which fields can only have one value, and which can have multiple (arrays)?
12:05 stefankasberger
this can be seen from the JSON file by coders, but not for non-programmers.
12:21 donsizemore joined #dataverse
12:28 pdurbin
stefankasberger: I'm looking at your slides. Thanks.
12:29 pdurbin
Also, I deployed some preliminary API Guide changes to https://dev2.dataverse.org/guides/ if anyone here would like to take a look.
12:34 pdurbin
Here are the names of the new sections I'm working on. These are working titles:
12:34 pdurbin
- Support Team API Intro
12:34 pdurbin
- API Frequently Asked Questions
12:34 pdurbin
- Getting Started with APIs
12:34 pdurbin
- Automating Tasks via API
12:36 pdurbin
I also created this image that is intended to explain to non-developers what an API is. I show how while there is a button to upload files, files can also be uploaded via API and that's how a variety of systems get files into Dataverse: https://i.imgur.com/KB44QKg.png
14:43 pdurbin
I guest created this "Beginner friendly API documentation" issue to reflect the hacking on the API Guide that I'm doing: https://github.com/IQSS/dataverse/issues/6086 . Comments are welcome. :)
14:51 pdurbin
just*
17:41 donsizemore
@pdurbin "Someone aside from @pdurbin (and @donsizemore :)) being able to run this" <<-- documentation? I need to add the branch flag to README.md
17:42 pdurbin
ah, that would be nice
17:42 pdurbin
Oh, that reminds me, I push a main.yml config file right into the sample data repo.
17:53 pdurbin
And I was thinking I'd add a bit to that README, the one in https://github.com/IQSS/dataverse-sample-data
17:53 pdurbin
Because people might want to point the sample data at Dataverse running on their laptops.
17:54 pdurbin
Or they might want to just have dataverse-ansible spin it all up, including sample data, on EC2.
