api-guidelines
api-guidelines copied to clipboard
Reference to API documentation/help
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
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.