docs: misc empty filters (#315)

Signed-off-by: Matt Klein <mklein@lyft.com>
pull/316/head
Matt Klein 7 years ago committed by htuch
parent 2f7459baf7
commit b9582012f6
  1. 19
      docs/root/api-v1/http_filters/dynamodb_filter.rst
  2. 13
      docs/root/api-v1/http_filters/grpc_http1_bridge_filter.rst
  3. 13
      docs/root/api-v1/http_filters/grpc_web_filter.rst
  4. 13
      docs/root/api-v1/network_filters/echo_filter.rst
  5. 17
      docs/root/configuration/http_filters/dynamodb_filter.rst
  6. 11
      docs/root/configuration/http_filters/grpc_http1_bridge_filter.rst
  7. 7
      docs/root/configuration/http_filters/grpc_json_transcoder_filter.rst
  8. 11
      docs/root/configuration/http_filters/grpc_web_filter.rst
  9. 8
      docs/root/configuration/network_filters/echo_filter.rst

@ -0,0 +1,19 @@
.. _config_http_filters_dynamo_v1:
DynamoDB
========
DynamoDB :ref:`configuration overview <config_http_filters_dynamo>`.
.. code-block:: json
{
"name": "http_dynamo_filter",
"config": {}
}
name
*(required, string)* Filter name. The only supported value is `http_dynamo_filter`.
config
*(required, object)* The filter does not use any configuration.

@ -0,0 +1,13 @@
.. _config_http_filters_grpc_bridge_v1:
gRPC HTTP/1.1 bridge
====================
gRPC HTTP/1.1 bridge :ref:`configuration overview <config_http_filters_grpc_bridge>`.
.. code-block:: json
{
"name": "grpc_http1_bridge",
"config": {}
}

@ -0,0 +1,13 @@
.. _config_http_filters_grpc_web_v1:
gRPC-Web filter
===============
gRPC-Web filter :ref:`configuration overview <config_http_filters_grpc_web>`.
.. code-block:: json
{
"name": "grpc_web",
"config": {}
}

@ -0,0 +1,13 @@
.. _config_network_filters_echo_v1:
Echo
====
Echo :ref:`configuration overview <config_network_filters_echo>`.
.. code-block:: json
{
"name": "echo",
"config": {}
}

@ -3,20 +3,9 @@
DynamoDB
========
DynamoDB :ref:`architecture overview <arch_overview_dynamo>`.
.. code-block:: json
{
"name": "http_dynamo_filter",
"config": {}
}
name
*(required, string)* Filter name. The only supported value is `http_dynamo_filter`.
config
*(required, object)* The filter does not use any configuration.
* DynamoDB :ref:`architecture overview <arch_overview_dynamo>`
* :ref:`v1 API reference <config_http_filters_dynamo_v1>`
* :ref:`v2 API reference <envoy_api_field_filter.network.HttpFilter.name>`
Statistics
----------

@ -3,7 +3,9 @@
gRPC HTTP/1.1 bridge
====================
gRPC :ref:`architecture overview <arch_overview_grpc>`.
* gRPC :ref:`architecture overview <arch_overview_grpc>`
* :ref:`v1 API reference <config_http_filters_grpc_bridge_v1>`
* :ref:`v2 API reference <envoy_api_field_filter.network.HttpFilter.name>`
This is a simple filter which enables the bridging of an HTTP/1.1 client which does not support
response trailers to a compliant gRPC server. It works by doing the following:
@ -34,13 +36,6 @@ More info: http://www.grpc.io/docs/guides/wire.html
This filter also collects stats for all gRPC requests that transit, even if those requests are
normal gRPC requests over HTTP/2.
.. code-block:: json
{
"name": "grpc_http1_bridge",
"config": {}
}
Statistics
----------

@ -3,11 +3,10 @@
gRPC-JSON transcoder filter
===========================
gRPC :ref:`architecture overview <arch_overview_grpc>`.
* gRPC :ref:`architecture overview <arch_overview_grpc>`
* :ref:`v1 API reference <config_http_filters_grpc_json_transcoder_v1>`
* :ref:`v2 API reference <envoy_api_msg_filter.http.GrpcJsonTranscoder>`
This is a filter which allows a RESTful JSON API client to send requests to Envoy over HTTP
and get proxied to a gRPC service. The HTTP mapping for the gRPC service has to be defined by
`custom options <https://cloud.google.com/service-management/reference/rpc/google.api#http>`_.
* :ref:`v1 API reference <config_http_filters_grpc_json_transcoder_v1>`
* :ref:`v2 API reference <envoy_api_msg_filter.http.GrpcJsonTranscoder>`

@ -3,14 +3,9 @@
gRPC-Web filter
====================
gRPC :ref:`architecture overview <arch_overview_grpc>`.
* gRPC :ref:`architecture overview <arch_overview_grpc>`
* :ref:`v1 API reference <config_http_filters_grpc_web_v1>`
* :ref:`v2 API reference <envoy_api_field_filter.network.HttpFilter.name>`
This is a filter which enables the bridging of a gRPC-Web client to a compliant gRPC server by
following https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-WEB.md.
.. code-block:: json
{
"name": "grpc_web",
"config": {}
}

@ -6,9 +6,5 @@ Echo
The echo is a trivial network filter mainly meant to demonstrate the network filter API. If
installed it will echo (write) all received data back to the connected downstream client.
.. code-block:: json
{
"name": "echo",
"config": {}
}
* :ref:`v1 API reference <config_network_filters_echo_v1>`
* :ref:`v2 API reference <envoy_api_field_Filter.name>`

Loading…
Cancel
Save