Skip to content

Commit

Permalink
Update request authority documentation
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
lann committed Jul 25, 2024
1 parent b8fdd99 commit ccd79e2
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions wit/types.wit
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ interface types {
@since(version = 0.2.0)
scheme: func() -> option<scheme>;

/// 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<string>;

Expand Down Expand Up @@ -344,15 +344,15 @@ interface types {
@since(version = 0.2.0)
set-scheme: func(scheme: option<scheme>) -> 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<string>;
/// 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<string>) -> result;

Expand Down

0 comments on commit ccd79e2

Please sign in to comment.