bcgov / bcgov/api-guidelines

Reference to API documentation/help

Open
#18 1 comment 0 reactions 0 assignees View on GitHub
feedback
Dominant language
No language data
Stars
34
Forks
10
PR merge metrics
No merged PRs in 30d

Description

> services SHOULD include a Link header (see [RFC 5988](https://tools.ietf.org/html/rfc5988)) 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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.