"Link Relation Types for Web Services" I-D Update

The "Link Relation Types for Web Services" Internet Draft was updated today. It helps with better interlinking of supporting resources for Web APIs, specifically with resources for description (such as OpenAPI), documentation (such as Web-based HTML documentation), general metadata resources, and Web API status resources.

The draft defines service-doc, service-desc, service-meta, and status link relations, which can be used to make resources relating to Web APIs easier to discover. This is particularly useful in scenarios where the goal is to build any kind of automation around collecting information about Web APIs.

Here is the draft's abstract:

"Many resources provided on the Web are part of sets of resources that are provided in a context that is managed by one particular service provider. Often, these sets of resources are referred to as 'Web Services' or 'Web APIs'. This specification defines link relations for representing relationships from those resources to ones that provide documentation, descriptions, or metadata for these Web services. Documentation is primarily intended for human consumers, whereas descriptions are primarily intended for automated consumers; metadata is supposed to be information about a service's context. It also defines a link relation to identify status resources that are used to represent operational information about service status."

If you have any comments about this draft, please feel free to share them via the draft's GitHub repo. It also would be interesting to get feedback about already existing usage of the draft. The plan is to move this draft towards RFC state in the second half of 2018.

The Author

Erik Wilde

Lead API Technologist

An expert in protocol design and structured data, Erik Wilde consults with organizations to help them get the most out of APIs and microservices. Erik has been involved in the development of innovative technologies since the advent of the Web and is active in the IETF and W3C communities. He obtained his PhD from ETH Zurich and served as Associate Adjunct Professor at Berkeley before working at EMC, Siemens and now CA Technologies.

Join the Conversation