From 47c1e2ea2f91675fed734435cd74575f3f733614 Mon Sep 17 00:00:00 2001 From: Anders Eknert Date: Thu, 22 Aug 2024 15:27:11 +0200 Subject: [PATCH] docs: mention `http.send` in inter-query cache config docs (#6953) It wasn't obvious when configuring the inter-query cache might be needed, as it wasn't mentioned which built-in made use of it. Also fixed the docs on annotations where it said `scope` only applies to `schemas`. Signed-off-by: Anders Eknert --- docs/content/configuration.md | 6 ++++-- docs/content/policy-language.md | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/content/configuration.md b/docs/content/configuration.md index b7186c7a1a..133aae785f 100644 --- a/docs/content/configuration.md +++ b/docs/content/configuration.md @@ -840,7 +840,9 @@ The following signing algorithms are supported: ## Caching -Caching represents the configuration of the inter-query cache that built-in functions can utilize. +Caching represents the configuration of the inter-query cache that built-in functions can utilize. Of the built-in +functions provided by OPA, `http.send` is currently the only one to utilize the inter-query cache. See the documentation +on the [http.send built-in function](../policy-reference/#http) for information about the available caching options. | Field | Type | Required | Description | | --- | --- | --- | --- | @@ -1108,4 +1110,4 @@ _or_ `--set services.opa\\.example\\.com.url=https://opa.example.com` -Where the end result passed into OPA still has the `\.` preserved. \ No newline at end of file +Where the end result passed into OPA still has the `\.` preserved. diff --git a/docs/content/policy-language.md b/docs/content/policy-language.md index 7c8168331d..dd4d25dc2e 100644 --- a/docs/content/policy-language.md +++ b/docs/content/policy-language.md @@ -2660,7 +2660,7 @@ comment block containing the YAML document is finished Name | Type | Description --- | --- | --- -scope | string; one of `package`, `rule`, `document`, `subpackages` | The scope on which the `schemas` annotation is applied. Read more [here](./#scope). +scope | string; one of `package`, `rule`, `document`, `subpackages` | The scope for which the metadata applies. Read more [here](./#scope). title | string | A human-readable name for the annotation target. Read more [here](#title). description | string | A description of the annotation target. Read more [here](#description). related_resources | list of URLs | A list of URLs pointing to related resources/documentation. Read more [here](#related-resources).