Skip to content

Commit

Permalink
docs: mention http.send in inter-query cache config docs (open-poli…
Browse files Browse the repository at this point in the history
…cy-agent#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 <anders@styra.com>
  • Loading branch information
anderseknert authored and brettmc committed Aug 22, 2024
1 parent ad7a605 commit 21bdc61
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions docs/content/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -843,7 +843,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 |
| --- | --- | --- | --- |
Expand Down Expand Up @@ -1112,4 +1114,4 @@ _or_

`--set services.opa\\.example\\.com.url=https://opa.example.com`

Where the end result passed into OPA still has the `\.` preserved.
Where the end result passed into OPA still has the `\.` preserved.
2 changes: 1 addition & 1 deletion docs/content/policy-language.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit 21bdc61

Please sign in to comment.