From d98ebf2bdf9ca8599d785ad614f9d018fb318158 Mon Sep 17 00:00:00 2001 From: Marko Malenic Date: Wed, 21 Sep 2022 19:15:54 +1000 Subject: [PATCH] Update Cors function documentation to match behaviour (#289) Co-authored-by: Rob Ede --- actix-cors/src/builder.rs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/actix-cors/src/builder.rs b/actix-cors/src/builder.rs index 804a0b253..7ffba714f 100644 --- a/actix-cors/src/builder.rs +++ b/actix-cors/src/builder.rs @@ -123,10 +123,10 @@ impl Cors { /// Add an origin that is allowed to make requests. /// - /// By default, requests from all origins are accepted by CORS logic. This method allows to - /// specify a finite set of origins to verify the value of the `Origin` request header. + /// This method allows specifying a finite set of origins to verify the value of the `Origin` + /// request header. These are `origin-or-null` types in the [Fetch Standard]. /// - /// These are `origin-or-null` types in the [Fetch Standard]. + /// By default, no origins are accepted. /// /// When this list is set, the client's `Origin` request header will be checked in a /// case-sensitive manner. @@ -211,7 +211,7 @@ impl Cors { /// These will be sent in the `Access-Control-Allow-Methods` response header as specified in /// the [Fetch Standard CORS protocol]. /// - /// Defaults to `[GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE]` + /// This defaults to an empty set. /// /// [Fetch Standard CORS protocol]: https://fetch.spec.whatwg.org/#http-cors-protocol pub fn allowed_methods(mut self, methods: U) -> Cors @@ -283,7 +283,7 @@ impl Cors { /// will be echoed back in the `Access-Control-Allow-Headers` header as specified in /// the [Fetch Standard CORS protocol]. /// - /// Defaults to `All`. + /// This defaults to an empty set. /// /// [Fetch Standard CORS protocol]: https://fetch.spec.whatwg.org/#http-cors-protocol pub fn allowed_headers(mut self, headers: U) -> Cors