Skip to content

Reference to API documentation/help #18

Description

@cvarjao

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    feedbackfeedback on the guidelines.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions