Profile for describedby

24 views
Skip to first unread message

Yudong Zhang

unread,
Jun 14, 2024, 6:17:42 AM6/14/24
to signposting
Hi,

it is Yudong from Gesis.

I have a question regarding the attribute "profile". in the description in Conventions - Signposting the Scholarly Web.  I found the following:

"... Note that the use of the profile attribute is standardized for certain MIME types, such as application/ld+json... "

My question is how should we interpret "is  standardized"?  is profile interpreted standardly by Signposting. i.e. When type="application/ld+json", is it necessary to additionally add profile for application/ld+json?  
  
As an example, we have a signposting link like this. 
<link rel="describedby" type="application/ld+json" href="https://search.gesis.org/getSchemaOrg.php?id=ZA0068">  

When we use F-uji tool. F-uji tool works well to identify/interpret the Json-ld with schema.org schema.  however, a question was asked,  if the profile is also mandatory in this case for type="application/Id+json" because of the description above.

I look forward to your help.

Best regards,

Yudong

Herbert Van de Sompel

unread,
Jun 18, 2024, 3:16:09 AM6/18/24
to Yudong Zhang, signposting
hi Yudong,

The use of the "profile" attribute as a means to convey a Profile URI has been formally defined for certain media types and not others. For example:
* For the media type "application/ld+json" the use of the "profile" attribute is formally defined in the W3C JSON-LD spec at https://www.w3.org/TR/json-ld11/#iana-considerations
* For the media type "applicacation/linkset+json" the use of the "profile" attribute is formally defined in the RFC9264 spec at https://www.rfc-editor.org/rfc/rfc9264.html#name-the-profile-parameter-for-m

For other media types, such as application/xml, the use of the "profile" attribute has not been formally defined. However, RFC8288 that specifies Web Linking, which is the basis for Signposting, allows for the definition of extension attributes, see https://datatracker.ietf.org/doc/html/rfc8288#section-3.4.2. As such, Signposting introduces the convention to also use the "profile" attribute for media types for which it has not formally been defined.

Use of the "profile" attribute is not mandatory. But in many cases, it can be very helpful. Media types such as "application/ld+json" and "application/xml" come in many flavours and use of the "profile" attribute by a server can help the client pick the flavour it prefers out of various links with the same media type. For example, various links with the "application/xml" media type but one pointing at Dublin Core, the other at MODS, etc, etc. A nice is example is at https://signposting.org/adopters/#biblio. Note that the example shows an abbreviated response. If you check out the live response many more links are shown, including several more using the "profile" attribute.

The value for a "profile" attribute must be a Profile URI. Obviously, things become meaningful when a single Profile URI is used to refer to a specific flavour of a media type. Profile URIs can be agreed upon within specific communities. But they can also be registered in a central IANA registry at https://www.iana.org/assignments/profile-uris/profile-uris.xhtml. Although the registry doesn't seem to be very successful (yet), it has two entries from the research community.

Greetings

Herbert





--
You received this message because you are subscribed to the Google Groups "signposting" group.
To unsubscribe from this group and stop receiving emails from it, send an email to signposting...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/signposting/aac7c2b4-ab19-4e3e-bab7-052289687been%40googlegroups.com.


--
==================
Herbert Van de Sompel
Reply all
Reply to author
Forward
0 new messages