Renamed, document and tested static_config_path / static_object_directory

This commit is contained in:
lukas committed 2026-10-18 17:17:41 +00:00
1 parent 55419acb09
commit c4f5504fdf
4 files changed
+94 -6

No files matched your search

+1 -1
View File
@@ -7,7 +7,7 @@ The `ObjectRetriever` constructor accepts an associative array of options. All o
| `cache_storage` | External cache storage; must implement `Kevinrob\GuzzleCache\Storage\CacheStorageInterface`, `Psr\Cache\CacheItemPoolInterface` or `Psr\SimpleCache\CacheInterface`. See [caching](caching.md). | `null` |
| `cache_prefix` | Prefix for all keys written to the external cache. | `'clobj:'` |
| `cache_ttl` | Number of seconds that object descriptions are cached, both in memory and in the external cache. | `60` |
| `static_config_path` | Path to a directory with static object descriptions, which are used instead of the API. Objects are read from `<path>/<namespace>/<path of COID>/object.jsonld`. | `null` |
| `static_object_directory` | Directory with static object descriptions, which are used instead of the API; mostly useful for testing. Objects are read from `<directory>/<namespace>/<path of COID>/object.jsonld`. Replaces the deprecated `static_config_path`. See [caching](caching.md#static-objects). | `null` |
| `auth_ns` | Hostname of the namespace to authenticate as, e.g. `example.com`. | `null` |
| `auth_secret` | Shared secret between the authenticating namespace and CloudObjects. | `null` |
| `api_base_url` | Base URL of the CloudObjects Core Object API. If not set, `https://od.coid.link/` is used. | `null` |