mirror of
https://github.com/openfaas/faas.git
synced 2025-06-20 04:56:38 +00:00
35f0e9e657
**What** - Add a description for the secret key to the api swagger spec. - Remove optional examples from the secret management guide. - Update the ApiKeyProtected README to point at the new guide. - Refactor the `makeSpec` function to accept the already assembled secrets array because this should be easier to unit test. Signed-off-by: Lucas Roesler <lucas.roesler@gmail.com>
7 lines
328 B
Markdown
7 lines
328 B
Markdown
### Api-Key-Protected sample
|
|
|
|
See the [secure secret management guide](../guide/secure_secret_management.md) for instructions on how to use this function.
|
|
|
|
When calling via the gateway pass the additional header "X-Api-Key", if it matches the `secret_api_key` value then the function will give access, otherwise access denied.
|
|
|