From ccd79e28629a3106c7e453b1253e6b12427ac59b Mon Sep 17 00:00:00 2001 From: Lann Date: Thu, 25 Jul 2024 10:15:57 -0400 Subject: [PATCH] Update request authority documentation The existing wording refers to a "request's authority", which is not well-defined. This rewords it to refer to the "request's target URI authority" - the "authority" part of the "target URI" of the request, which is well-defined. --- wit/types.wit | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/wit/types.wit b/wit/types.wit index 981c110..f2ce846 100644 --- a/wit/types.wit +++ b/wit/types.wit @@ -267,7 +267,7 @@ interface types { @since(version = 0.2.0) scheme: func() -> option; - /// Returns the authority from the request, if it was present. + /// Returns the authority of the Request's target URI, if present. @since(version = 0.2.0) authority: func() -> option; @@ -344,15 +344,15 @@ interface types { @since(version = 0.2.0) set-scheme: func(scheme: option) -> result; - /// Get the HTTP Authority for the Request. A value of `none` may be used - /// with Related Schemes which do not require an Authority. The HTTP and + /// Get the authority of the Request's target URI. A value of `none` may be used + /// with Related Schemes which do not require an authority. The HTTP and /// HTTPS schemes always require an authority. @since(version = 0.2.0) authority: func() -> option; - /// Set the HTTP Authority for the Request. A value of `none` may be used - /// with Related Schemes which do not require an Authority. The HTTP and + /// Set the authority of the Request's target URI. A value of `none` may be used + /// with Related Schemes which do not require an authority. The HTTP and /// HTTPS schemes always require an authority. Fails if the string given is - /// not a syntactically valid uri authority. + /// not a syntactically valid URI authority. @since(version = 0.2.0) set-authority: func(authority: option) -> result;