Reference to API documentation/help

bcgov / api-guidelines

BC Government API Guidelines

https://developer.gov.bc.ca/Data-and-APIs/BC-Government-API-Guidelines

Other

29 stars 10 forks source link

Reference to API documentation/help #18

Open cvarjao opened 5 years ago

cvarjao commented 5 years ago

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

jeff-card commented 5 years ago

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.