Skip to content

Commit

Permalink
docs: improve gate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
error418 committed Mar 11, 2020
1 parent 01c0c25 commit 0b9c93a
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/_docs/components/gate.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,9 @@ Gate provides API endpoints of Swingletree.
* Provides metadata information to Swingletree plugins
* Registers and manages plugin endpoints
* Authenticates API calls (if auth token is configured)

## Plugin routing

Gate is the entrance for communicating with the running Swingletree plugins. Plugin endpoints are published under the path `/report/[plugin name]` (removing the `plugin-` prefix).

Gate will check authentication (if configured) and initially prepare the request for consumption by the plugin.

0 comments on commit 0b9c93a

Please sign in to comment.