-
Notifications
You must be signed in to change notification settings - Fork 5.3k
docs: correct api/envoy/service/auth/v2 docs #6211
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -83,7 +83,8 @@ message AttributeContext { | |
| // lowercased, because HTTP header keys are case-insensitive. | ||
| map<string, string> headers = 3; | ||
|
|
||
| // The HTTP URL path. | ||
| // The request target, as it appears in the first line of the HTTP request. This includes | ||
| // the URL path and query-string. No decoding is performed. | ||
| string path = 4; | ||
|
|
||
| // The HTTP request `Host` or 'Authority` header value. | ||
|
|
@@ -92,18 +93,21 @@ message AttributeContext { | |
| // The HTTP URL scheme, such as `http` and `https`. | ||
| string scheme = 6; | ||
|
|
||
| // The HTTP URL query in the format of `name1=value`&name2=value2`, as it | ||
| // appears in the first line of the HTTP request. No decoding is performed. | ||
| // This field is always empty, and exists for compatibility reasons. The HTTP URL query is | ||
| // included in `path` field. | ||
| string query = 7; | ||
|
|
||
| // The HTTP URL fragment, excluding leading `#`. No URL decoding is performed. | ||
| // This field is always empty, and exists for compatibility reasons. The URL fragment is | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same as above |
||
| // not submitted as part of HTTP requests; it is unknowable. | ||
| string fragment = 8; | ||
|
|
||
| // The HTTP request size in bytes. If unknown, it must be -1. | ||
| int64 size = 9; | ||
|
|
||
| // The network protocol used with the request, such as | ||
| // "http/1.1", "spdy/3", "h2", "h2c" | ||
| // The network protocol used with the request, such as "HTTP/1.0", "HTTP/1.1", or "HTTP/2". | ||
| // | ||
| // See :repo:`headers.h:ProtocolStrings <source/common/http/headers.h>` for a list of all | ||
| // possible values. | ||
| string protocol = 10; | ||
| } | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -61,7 +61,8 @@ message OkHttpResponse { | |
|
|
||
| // Intended for gRPC and Network Authorization servers `only`. | ||
| message CheckResponse { | ||
| // Status `OK` allows the request. Any other status indicates the request should be denied. | ||
| // Status `OK` allows the request. Status `UNKNOWN` causes Envoy to abort. Any other status | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. what does abort mean here?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "abort" means "exit with a stack trace", which I guess is probably a bug (#6210). |
||
| // indicates the request should be denied. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See also: #6210 |
||
| google.rpc.Status status = 1; | ||
|
|
||
| // An message that contains HTTP response attributes. This message is | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we enforce empty here? Is it worth it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you mean "enforce empty"? Note that Envoy is what populates this, not the AuthService talking to Envoy. I don't believe that code outside of Envoy ever needs to create this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
got it thanks.