Skip to content

Commit

Permalink
docs: fix a typo and incorrect rendering of URLs (#2991)
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
  • Loading branch information
peterj authored Nov 15, 2023
1 parent 648947e commit 419f9a3
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 30 deletions.
25 changes: 15 additions & 10 deletions extensions/v1alpha1/wasm.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 16 additions & 10 deletions extensions/v1alpha1/wasm.pb.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 15 additions & 10 deletions extensions/v1alpha1/wasm.proto
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ message WasmPlugin {
FailStrategy fail_strategy = 13;

// Configuration for a Wasm VM.
// more details can be found [here](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/wasm/v3/wasm.proto#extensions-wasm-v3-vmconfig).
// More details can be found [here](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/wasm/v3/wasm.proto#extensions-wasm-v3-vmconfig).
VmConfig vm_config = 11;

// TrafficSelector provides a mechanism to select a specific traffic flow
Expand Down Expand Up @@ -375,15 +375,20 @@ message WasmPlugin {
}


// PluginType indicates the type of Wasm Extension to be used.
// There are two types of Extensions: `HTTP` and `NETWORK`.
// HTTP Extension work at "Layer 7"(for example as an HTTP filters in Envoy).
// The detailed HTTP interface for can be found at [C++] (https://github.com/proxy-wasm/proxy-wasm-cpp-host/blob/b7e690703c7f26707438a2f1ebd7c197bc8f0296/include/proxy-wasm/context_interface.h#L199)
// and [Rust] (https://github.com/proxy-wasm/proxy-wasm-rust-sdk/blob/6b47aec926bc29971c727471d6f4c972ec407c7f/src/traits.rs#L309).
// NETWORK Extension work at "Layer 4"(for example, as a network filter in Envoy).
// The detailed NETWORK interface for can be found at [C++] (https://github.com/proxy-wasm/proxy-wasm-cpp-host/blob/b7e690703c7f26707438a2f1ebd7c197bc8f0296/include/proxy-wasm/context_interface.h#L257)
// and [Rust] (https://github.com/proxy-wasm/proxy-wasm-rust-sdk/blob/6b47aec926bc29971c727471d6f4c972ec407c7f/src/traits.rs#L257).
// The NETWORK Extension can be applied to HTTP traffic as well.
// PluginType indicates the type of Wasm extension to be used.
// There are two types of extensions: `HTTP` and `NETWORK`.
//
// The `HTTP` extension works at Layer 7 (for example, as an HTTP filter in Envoy).
// The detailed HTTP interface can be found here:
// - [C++](https://github.com/proxy-wasm/proxy-wasm-cpp-host/blob/b7e690703c7f26707438a2f1ebd7c197bc8f0296/include/proxy-wasm/context_interface.h#L199)
// - [Rust](https://github.com/proxy-wasm/proxy-wasm-rust-sdk/blob/6b47aec926bc29971c727471d6f4c972ec407c7f/src/traits.rs#L309)
//
// The `NETWORK` extension works at Layer 4 (for example, as a network filter in Envoy).
// The detailed `NETWORK` interface can be found here:
// - [C++](https://github.com/proxy-wasm/proxy-wasm-cpp-host/blob/b7e690703c7f26707438a2f1ebd7c197bc8f0296/include/proxy-wasm/context_interface.h#L257)
// - [Rust](https://github.com/proxy-wasm/proxy-wasm-rust-sdk/blob/6b47aec926bc29971c727471d6f4c972ec407c7f/src/traits.rs#L257)
//
// The `NETWORK` extension can be applied to HTTP traffic as well.
enum PluginType {
// Defaults to HTTP.
UNSPECIFIED_PLUGIN_TYPE = 0;
Expand Down

0 comments on commit 419f9a3

Please sign in to comment.