website icon indicating copy to clipboard operation
website copied to clipboard

Service profile documentation has a few errors

Open bourquep opened this issue 5 years ago • 1 comments

Bug Report

What is the issue?

The documentation located here: https://linkerd.io/2/reference/service-profiles/ has 2 errors (that I know of):

  1. In the Route section:responses should be responseClasses
  2. In the Response class section: isSuccess should be isFailure

bourquep avatar Sep 04 '19 16:09 bourquep

A route object must contain the following fields:

For RFC-ness MUST is not correct, since responses is optional, as are isRetryable and timeout.

A request match object must contain exactly one of the following fields:

All examples show two or more of the following fields as a top-level condition. Definition needs to be updated I think, since lower-level RequestMatch objects do conform to this definition.

007 avatar Sep 04 '19 16:09 007