docs: external auth missing service definition
#4.777 aberto em 18 de out. de 2018
Métricas do repositório
- Stars
- (27.997 stars)
- Métricas de merge de PR
- (Mesclagem média 8d) (378 fundiu PRs em 30d)
Description
The documentation for the (Authorization Service](https://www.envoyproxy.io/docs/envoy/latest/api-v2/service/auth/v2alpha/external_auth.proto#envoy-api-msg-service-auth-v2alpha-checkrequest) has a few issues:
-
The
Authorizationservice itself is entirely MIA in the docs, which is strange given that it exists in the.protodefinition file (https://github.com/envoyproxy/envoy/blob/master/api/envoy/service/auth/v2alpha/external_auth.proto#L26). Are services not included in the protobuf-to-rst generation? If so, it would be great to add it at some point since it would be incredibly helpful in properly understanding how the different parts of the puzzle work. -
The generated
.rstfile contains links that are "off by one" line in terms of referring to the original.protofile. For example, this.rstfile line: https://github.com/envoyproxy/envoyproxy.github.io/blame/master/docs/envoy/latest/_sources/api-v2/service/auth/v2alpha/external_auth.proto.rst.txt#L14. It refers to https://github.com/envoyproxy/envoy/blob/master/api/envoy/service/auth/v2alpha/external_auth.proto#L26 but the definition for the message being referred to starts at line 27 (not line 26).