Skip to content

Commit

Permalink
Document that well-known names are no longer needed. (#763)
Browse files Browse the repository at this point in the history
Envoy hasn't needed well-known filter names for a long while. Document
that fact so that this package stops confusing people.

This fixes #756.

Signed-off-by: James Peach <jpeach@apache.org>
  • Loading branch information
jpeach authored Aug 30, 2023
1 parent 64254e4 commit 7a5247a
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions pkg/wellknown/wellknown.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@
// limitations under the License.

// Package wellknown contains common names for filters, listeners, etc.
//
// Deprecated: Envoy no longer requires specific names when configuring
// filters or other properties, since it inspects the Protobuf type URL
// to decide how to the decode a message. Because of this, no new names
// are being added to this package.
package wellknown

// HTTP filter names
Expand Down

0 comments on commit 7a5247a

Please sign in to comment.