Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Java doc typo fixes #1763

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -1384,7 +1384,7 @@ public void logsMultiPartParamsOnLogAll() throws Exception {
then().
statusCode(200);

assertThat(writer.toString(), equalTo(String.format("Request URI:\thttp://localhost:8080/greet?firstName=John#&lastName=Doe%n")));
assertThat(writer.toString(), equalTo(String.format("Request URI:\thttp://localhost:8080/greet?firstName=John#?&lastName=Doe%n")));
ArunGahlawat marked this conversation as resolved.
Show resolved Hide resolved
}

// This was previously a bug (https://github.com/rest-assured/rest-assured/issues/684)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ public LogDetail logDetailOfRequestAndResponseIfValidationFails() {
}

/**
* Specify a whether or not to enable pretty printing by default.
* Specify whether or not to enable pretty printing by default.
*
* @param shouldEnable <code>true</code> if pretty-printing should be enabled, <code>false</code> otherwise.
* @return A new LogConfig instance
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
public interface FilterContext {

/**
* Add a value that may be used be subsequent filters.
* Add a value that may be used by subsequent filters.
*
* @param name The name of the value
* @param value The value itself
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ public interface AuthenticationSpecification {
RequestSpecification certificate(String certURL, String password, CertificateAuthSettings certificateAuthSettings);

/**
* OAuth2 sign the request. Note that this currently does not wait for a WWW-Authenticate challenge before sending the the OAuth header
* OAuth2 sign the request. Note that this currently does not wait for a WWW-Authenticate challenge before sending the OAuth header
* (so currently it's the same as preemptive oauth2 authentication. The reason why it's located here is to be backward compatible).
* This assumes you've already generated an accessToken for the site you're targeting. The access token will be put in a header.
*
Expand All @@ -109,7 +109,7 @@ public interface AuthenticationSpecification {
RequestSpecification oauth2(String accessToken);

/**
* OAuth2 sign the request. Note that this currently does not wait for a WWW-Authenticate challenge before sending the the OAuth header.
* OAuth2 sign the request. Note that this currently does not wait for a WWW-Authenticate challenge before sending the OAuth header.
* This assumes you've already generated an accessToken for the site you're targeting.
*
* @param accessToken The access token
Expand All @@ -120,7 +120,7 @@ public interface AuthenticationSpecification {

/**
* Excerpt from the HttpBuilder docs:<br>
* OAuth sign the request. Note that this currently does not wait for a WWW-Authenticate challenge before sending the the OAuth header.
* OAuth sign the request. Note that this currently does not wait for a WWW-Authenticate challenge before sending the OAuth header.
* All requests to all domains will be signed for this instance.
* This assumes you've already generated an accessToken and secretToken for the site you're targeting.
* For more information on how to achieve this, see the <a href='https://github.com/fernandezpablo85/scribe-java/wiki/Getting-Started'>Scribe documentation</a>.</p>
Expand All @@ -135,7 +135,7 @@ public interface AuthenticationSpecification {

/**
* Excerpt from the HttpBuilder docs:<br>
* OAuth sign the request. Note that this currently does not wait for a WWW-Authenticate challenge before sending the the OAuth header.
* OAuth sign the request. Note that this currently does not wait for a WWW-Authenticate challenge before sending the OAuth header.
* All requests to all domains will be signed for this instance.
* This assumes you've already generated an accessToken and secretToken for the site you're targeting.
* For more information on how to achieve this, see the <a href='https://github.com/fernandezpablo85/scribe-java/wiki/Getting-Started'>Scribe documentation</a>.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ public interface FilterableRequestSpecification extends QueryableRequestSpecific
FilterableRequestSpecification removePathParam(String parameterName);

/**
* Remove a named path parameter from the request. It will remove both named and unnamed path parameters.
* Remove a named path parameter from the request.
*
* @param parameterName The parameter key
* @return The {@link FilterableRequestSpecification} without the parameter
Expand Down Expand Up @@ -124,7 +124,7 @@ public interface FilterableRequestSpecification extends QueryableRequestSpecific
FilterableRequestSpecification removeCookie(Cookie cookie);

/**
* Replace a header with the new value. If the headerName doesn't exist the will be added.
* Replace a header with the new value. If the headerName doesn't exist it will be added.
*
* @param headerName The header name to replace
* @return The {@link FilterableRequestSpecification} with the replaced header
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1102,8 +1102,8 @@ public interface RequestSpecification extends RequestSender {
* <pre>
* given().
* csrf("/users").
* formParm("firstName", "John")
* formParm("lastName", "Doe")
* formParm("firstName", "John").
* formParm("lastName", "Doe").
* when().
* post("/users").
* then().
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@ default ResponseSpecification root(String rootPath) {
* body("w.something2", is(..)).
* </pre>
* <p/>
* This is the same as calling <code>rootPath("")</code> but less verbose and the it communicates intent better.
* This is the same as calling <code>rootPath("")</code> but less verbose and it communicates intent better.
*
* @see #rootPath(String)
*/
Expand Down Expand Up @@ -658,7 +658,7 @@ default ResponseSpecification appendRoot(String pathToAppend) {
* body("lastName", is(..)).
* </pre>
* <p/>
* you can use a append root and do:
* you can use a detach root and do:
* <pre>
* when().
* get(..);
Expand Down