Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reference to API documentation/help #18

Open
cvarjao opened this issue Aug 9, 2019 · 1 comment
Open

Reference to API documentation/help #18

cvarjao opened this issue Aug 9, 2019 · 1 comment
Labels
feedback feedback on the guidelines.

Comments

@cvarjao
Copy link
Member

cvarjao commented Aug 9, 2019

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 cvarjao changed the title Reference to documentation/help Reference to API documentation/help Aug 9, 2019
@ll911 ll911 added the feedback feedback on the guidelines. label Aug 9, 2019
@jeff-card
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feedback feedback on the guidelines.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@cvarjao @ll911 @jeff-card