envoyproxy / envoyproxy/envoy

docs: external auth missing service definition

Aperta
#4,777 2 commenti 0 reazioni 1 assegnatario Rivendicata da @gsagula Vedi su GitHub
area/docs help wanted
Lingua principale
C++
Stelle
28.9k
Fork
5.6k
Merge medio
1g 22h
PR unite (30g)
430

Descrizione

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 `Authorization` service itself is entirely MIA in the docs, which is strange given that it exists in the `.proto` definition 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 `.rst` file contains links that are "off by one" line in terms of referring to the original `.proto` file. For example, this `.rst` file 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).

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.