API - content negotiation

[rduyme]

http content negotiation is a simple way to exchange json-ld info. this ticket is to discuss it for skg-if

see : https://citation.doi.org/docs.html

resource : https://en.wikipedia.org/wiki/Media_type

Initial proposition :

• content-type : "application/vnd.skgif.ld+json"
• http content negociation should be implemented on single core skg-if entity pages
• json-ld content should match "get by id" operations in skg-if OpenAPI. (which clearly defines the json structure of linked entities)
• the supported SKG-IF version is declared in the JSON-LD output @context ex: https://skg-if.github.io/context/ver/1.0.1/skg-if.json

get by id example

  "@context": [
    "https://w3id.org/skg-if/context/1.0.1/skg-if.json",
  ],
  "local_identifier": "11345813512",
  "entity_type": "product",
  "product_type": "literature",
  "titles": {
    "en": [
      "The FAIR Guiding Principles for scientific data management and stewardship"
    ]
...
// embedded authors.
  "contributions": [
    {
      "contribution": "writing – original draft",
      "role": "author",
      "rank": 1,
      "by": {
       "local_identifier": "otf___1730027051396___person-1",
        "name": "Mark Wilkinson",
        "given_name": "Mark",
        "family_name": "Wilkinson",
...
 }

[rapw3k]

hi @rduyme as mentioned via email, content negotiation is the way to go for me as well. in ROHub we have implemented this to get RO(-crate) in different formats:

Content negotiation is on the RO ( or resource ) PID (the html page you get is after content negotiation).

For example for the RO with PID https://w3id.org/ro-id/37db5a42-5a5d-420e-9422-c85007514eba

this will return the full semantic data about the research object (modelled according the former RO ontologies)

curl -i -X GET \

-H "Accept:text/turtle" \

'https://w3id.org/ro-id/37db5a42-5a5d-420e-9422-c85007514eba'

The ro-crate is retrieved by adding /crate to PID, e.g,

To get ro-crate manifest

curl -i -X GET \

-H "Accept:application/ld+json" \

'https://w3id.org/ro-id/37db5a42-5a5d-420e-9422-c85007514eba/crate'

Or to get ro-crate zip package

curl -i -X GET \

-H "Accept:application/zip" \

'https://w3id.org/ro-id/37db5a42-5a5d-420e-9422-c85007514eba/crate'

Or html preview (which you can also open in browser https://w3id.org/ro-id/37db5a42-5a5d-420e-9422-c85007514eba/crate )

curl -i -X GET \

-H "Accept:text/html" \

'https://w3id.org/ro-id/37db5a42-5a5d-420e-9422-c85007514eba/crate'

[rduyme]

@rapw3k are you ok with suggested content-type ? ( see references I found in my initial issues post)

content-type : "application/vnd.skgif.ld+json"

[rapw3k]

yes @rduyme fine with me!