From cdd291b4bc99cf74723e3448cf929914423d08ff Mon Sep 17 00:00:00 2001 From: Paul Abel Date: Wed, 8 Jan 2025 15:51:05 +0000 Subject: [PATCH] update APIKey suppliedIn docs --- site/content/configuration/policy-resource.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/site/content/configuration/policy-resource.md b/site/content/configuration/policy-resource.md index 21e2e3393d..72fcece970 100644 --- a/site/content/configuration/policy-resource.md +++ b/site/content/configuration/policy-resource.md @@ -192,11 +192,14 @@ data: {{% table %}} |Field | Description | Type | Required | | ---| ---| ---| --- | +|``suppliedIn`` | `header` or `query`. | | Yes | |``suppliedIn.header`` | An array of headers that the API Key may appear in. | ``string[]`` | No | |``suppliedIn.query`` | An array of query params that the API Key may appear in. | ``string[]`` | No | |``clientSecret`` | The name of the Kubernetes secret that stores the API Key(s). It must be in the same namespace as the Policy resource. The secret must be of the type ``nginx.org/apikey``, and the API Key(s) must be stored in a key: val format where each key is a unique clientID and each value is a unique base64 encoded API Key | ``string`` | Yes | {{% /table %}} +{{}}An APIKey Policy must include a minimum of one of the `suppliedIn.header` or `suppliedIn.query` parameters. Both can also be supplied.{{}} + #### APIKey Merging Behavior A VirtualServer or VirtualServerRoute can be associated with only one API Key policy per route or subroute. However, it is possible to replace an API Key policy from a higher-level with a different policy defined on a more specific route.