Skip to content

Commit

Permalink
Update comments on plugin interface (#11)
Browse files Browse the repository at this point in the history
* Update comments on plugin interface
* Fix indentation
  • Loading branch information
marcogschmidt authored and soloio-bulldozer[bot] committed Nov 12, 2019
1 parent c68a5e9 commit af279cb
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 21 deletions.
35 changes: 14 additions & 21 deletions api/interface.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,31 +60,24 @@ type AuthService interface {

// External authorization plugins must implement this interface
type ExtAuthPlugin interface {
// Gloo will deserialize the external authorization plugin configuration defined on your Virtual Hosts into the
// Gloo will deserialize the external authorization plugin configuration defined on your AuthConfig into the
// type returned by this function. The returned type MUST be a pointer.
//
// For example, given the following plugin configuration:
//
// apiVersion: gateway.solo.io/v1
// kind: VirtualService
// metadata:
// name: test-auth
// namespace: gloo-system
// spec:
// virtualHost:
// domains: [...]
// routes: [...]
// virtualHostPlugins:
// extensions:
// configs:
// extauth:
// plugin_auth:
// plugins:
// - name: MyAuthPlugin
// config:
// some_key: value-1
// some_struct:
// another_key: value-2
// apiVersion: enterprise.gloo.solo.io/v1
// kind: AuthConfig
// metadata:
// name: plugin-auth
// namespace: gloo-system
// spec:
// configs:
// - pluginAuth:
// name: MyAuthPlugin
// config:
// someKey: value-1
// someStruct:
// anotherKey: value-2
//
// the `NewConfigInstance` function on your `ExtAuthPlugin` implementation should return a pointer to
// the following Go struct:
Expand Down
3 changes: 3 additions & 0 deletions changelog/v0.1.2/update-comments.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
changelog:
- type: NON_USER_FACING
description: Update comments on plugin interface.

0 comments on commit af279cb

Please sign in to comment.