From 7fe5f43d74b7a89cba2bb2cc79760e72dfa40c6b Mon Sep 17 00:00:00 2001 From: darkweak Date: Fri, 15 Nov 2024 21:59:50 +0100 Subject: [PATCH] fix(typo): allowed_additional_status_codes --- README.md | 10 +++++----- configuration/configuration.sample.yml | 2 +- docs/website/content/docs/configuration.md | 2 +- plugins/caddy/README.md | 2 +- plugins/caddy/httpcache.go | 2 +- plugins/kratos/configuration_test.go | 2 +- plugins/roadrunner/README.md | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 94ea18527..fec0eecf5 100644 --- a/README.md +++ b/README.md @@ -106,7 +106,7 @@ default_cache: - GET - POST - HEAD - allowed_addional_status_code: # Allowed additional HTTP status code to cache. + allowed_additional_status_codes: # Allowed additional HTTP status code to cache. - 202 - 400 cache_name: Souin # Override the cache name to use in the Cache-Status header @@ -199,7 +199,7 @@ surrogate_keys: | `cdn.service_id` | The service id if required, depending the provider | `123456_id` | | `cdn.zone_id` | The zone id if required, depending the provider | `anywhere_zone` | | `default_cache.allowed_http_verbs` | The HTTP verbs to support cache | `- GET`

`- POST`

`(default: GET, HEAD)` | -| `default_cache.allowed_addional_status_code` | The additional HTTP status code to support cache | `- 200`

`- 404` | +| `default_cache.allowed_additional_status_codes` | The additional HTTP status code to support cache | `- 200`

`- 404` | | `default_cache.badger` | Configure the Badger cache storage | | | `default_cache.badger.path` | Configure Badger with a file | `/anywhere/badger_configuration.json` | | `default_cache.badger.configuration` | Configure Badger directly in the Caddyfile or your JSON caddy configuration | [See the Badger configuration for the options](https://dgraph.io/docs/badger/get-started/) | @@ -429,7 +429,7 @@ There is the fully configuration below } cache { allowed_http_verbs GET POST PATCH - allowed_addional_status_code 202 + allowed_additional_status_codes 202 api { basepath /some-basepath prometheus { @@ -887,7 +887,7 @@ http: - GET - POST - HEAD - allowed_addional_status_code: + allowed_additional_status_codes: - 202 - 400 cdn: @@ -987,7 +987,7 @@ http: - GET - HEAD - POST - allowed_addional_status_code: + allowed_additional_status_codes: - 202 - 400 default_cache_control: no-store diff --git a/configuration/configuration.sample.yml b/configuration/configuration.sample.yml index e98f90fa1..b67a1e1a5 100644 --- a/configuration/configuration.sample.yml +++ b/configuration/configuration.sample.yml @@ -18,7 +18,7 @@ default_cache: # Required part - GET - POST - HEAD - allowed_addional_status_code: # Allowed additional HTTP status code to cache. + allowed_additional_status_codes: # Allowed additional HTTP status code to cache. - 202 - 400 cache_name: Souin # Override the Cache-Status name diff --git a/docs/website/content/docs/configuration.md b/docs/website/content/docs/configuration.md index 17c1a989d..23b707b7a 100644 --- a/docs/website/content/docs/configuration.md +++ b/docs/website/content/docs/configuration.md @@ -123,7 +123,7 @@ The allowed_http_verbs prefix configure the HTTP verbs allowed to get cached. (e default: `[GET, HEAD]` #### Allowed additional status code -The allowed_addional_status_code prefix configure the additional HTTP status codes allowed to get cached. (e.g. `default_cache.allowed_addional_status_code`). +The allowed_additional_status_codes prefix configure the additional HTTP status codes allowed to get cached. (e.g. `default_cache.allowed_additional_status_codes`). default: `[]` #### Badger diff --git a/plugins/caddy/README.md b/plugins/caddy/README.md index 2a5a80509..8c3434b2d 100644 --- a/plugins/caddy/README.md +++ b/plugins/caddy/README.md @@ -354,7 +354,7 @@ What does these directives mean? | Key | Description | Value example | |:------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------| | `allowed_http_verbs` | The HTTP verbs allowed to be cached | `GET POST PATCH`

`(default: GET HEAD)` | -| `allowed_addional_status_code` | The additional HTTP status codes allowed to be cached | `202 400` | +| `allowed_additional_status_codes` | The additional HTTP status codes allowed to be cached | `202 400` | | `api` | The cache-handler API cache management | | | `api.basepath` | BasePath for all APIs to avoid conflicts | `/your-non-conflict-route`

`(default: /souin-api)` | | `api.prometheus` | Enable the Prometheus metrics | | diff --git a/plugins/caddy/httpcache.go b/plugins/caddy/httpcache.go index 488650ec0..56135d80c 100644 --- a/plugins/caddy/httpcache.go +++ b/plugins/caddy/httpcache.go @@ -41,7 +41,7 @@ type SouinCaddyMiddleware struct { // Allowed HTTP verbs to be cached by the system. AllowedHTTPVerbs []string `json:"allowed_http_verbs,omitempty"` // Allowed HTTP verbs to be cached by the system. - AllowedAdditionalStatusCodes []string `json:"allowed_addional_status_code,omitempty"` + AllowedAdditionalStatusCodes []string `json:"allowed_additional_status_codes,omitempty"` // Headers to add to the cache key if they are present. Headers []string `json:"headers,omitempty"` // Configure the Badger cache storage. diff --git a/plugins/kratos/configuration_test.go b/plugins/kratos/configuration_test.go index 11219ea93..35e6ed6d5 100644 --- a/plugins/kratos/configuration_test.go +++ b/plugins/kratos/configuration_test.go @@ -28,7 +28,7 @@ httpcache: - GET - POST - HEAD - allowed_addional_status_code: + allowed_additional_status_codes: - 202 - 400 badger: diff --git a/plugins/roadrunner/README.md b/plugins/roadrunner/README.md index e5b558221..c4eb5528b 100644 --- a/plugins/roadrunner/README.md +++ b/plugins/roadrunner/README.md @@ -67,7 +67,7 @@ http: - GET - POST - HEAD - allowed_addional_status_code: # Allowed additional HTTP status codes to cache. + allowed_additional_status_codes: # Allowed additional HTTP status codes to cache. - 202 - 400 cache_name: Souin # Override the cache name to use in the Cache-Status header