api-guidelines icon indicating copy to clipboard operation
api-guidelines copied to clipboard

Reference to API documentation/help

Open cvarjao opened this issue 6 years ago • 1 comments

services SHOULD include a Link header (see RFC 5988) to point to documentation for the resource in question.

Link: <{help}>; rel="help"

RFC 5988:

Relation Name: help Description: Refers to a resource offering help (more information, links to other sources information, etc.)

Reference: https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#744-options-and-link-headers

cvarjao avatar Aug 09 '19 19:08 cvarjao

Thank you for your comment! A peer review was held on August 9th and we have the following feedback:

Recognizing guidelines should have a method for seeking help, this suggestion will be implemented.

jeff-card avatar Aug 13 '19 19:08 jeff-card