V109 (#2010)

* Fixes some documentation
Adds more Parameter Tests

* Makes the new tests more readable and understandable

* Fixes Documentation per request

Author: EdLichtman

src/RestSharp/Enum.cs

@@ -11,6 +11,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+using System.Net;
 
 namespace RestSharp;
 
@@ -19,9 +20,44 @@ namespace RestSharp;
 /// </summary>
 public enum ParameterType {
     /// <summary>
-    /// Cookie parameter
+    /// A <see cref="Parameter"/> that will added to the QueryString for GET, DELETE, OPTIONS and HEAD requests; and form for POST and PUT requests.
     /// </summary>
-    GetOrPost, UrlSegment, HttpHeader, RequestBody, QueryString
+    /// <remarks>
+    /// See <see cref="GetOrPostParameter"/>.
+    /// </remarks>
+    GetOrPost,
+
+    /// <summary>
+    /// A <see cref="Parameter"/> that will be added to part of the url by replacing a <c>{placeholder}</c> within the absolute path.
+    /// </summary>
+    /// <remarks>
+    /// See <see cref="UrlSegmentParameter"/>.
+    /// </remarks>
+    UrlSegment,
+
+    /// <summary>
+    /// A <see cref="Parameter"/> that will be added as a request header
+    /// </summary>
+    /// <remarks>
+    /// See <see cref="HeaderParameter"/>.
+    /// </remarks>
+    HttpHeader,
+
+    /// <summary>
+    /// A <see cref="Parameter"/> that will be added to the request body
+    /// </summary>
+    /// <remarks>
+    /// See <see cref="BodyParameter"/>.
+    /// </remarks>
+    RequestBody,
+
+    /// <summary>
+    /// A <see cref="Parameter"/> that will be added to the query string
+    /// </summary>
+    /// <remarks>
+    /// See <see cref="QueryParameter"/>.
+    /// </remarks>
+    QueryString
 }
 
 /// <summary>
@@ -55,4 +91,29 @@ public struct DateFormat {
 /// <summary>
 /// Status for responses (surprised?)
 /// </summary>
-public enum ResponseStatus { None, Completed, Error, TimedOut, Aborted }
+public enum ResponseStatus { 
+    /// <summary>
+    /// Not Applicable, for when the Request has not yet been made
+    /// </summary>
+    None,
+
+    /// <summary>
+    /// <see cref="ResponseStatus"/> for when the request is passes as a result of <see cref="HttpResponseMessage.IsSuccessStatusCode"/> being true, or when the response is <see cref="HttpStatusCode.NotFound"/>
+    /// </summary>
+    Completed,
+
+    /// <summary>
+    /// <see cref="ResponseStatus"/> for when the request fails due as a result of <see cref="HttpResponseMessage.IsSuccessStatusCode"/> being false except for the case when the response is <see cref="HttpStatusCode.NotFound"/>
+    /// </summary>
+    Error, 
+    
+    /// <summary>
+    /// <see cref="ResponseStatus"/> for when the Operation is cancelled due to the request taking longer than the length of time prescribed by <see cref="RestRequest.Timeout"/> or due to the <see cref="HttpClient"/> timing out.
+    /// </summary>
+    TimedOut,
+
+    /// <summary>
+    /// <see cref="ResponseStatus"/> for when the Operation is cancelled, due to reasons other than <see cref="TimedOut"/>
+    /// </summary>
+    Aborted
+}

src/RestSharp/Parameters/UrlSegmentParameter.cs

@@ -16,7 +16,7 @@ namespace RestSharp;
 
 public record UrlSegmentParameter : NamedParameter {
     /// <summary>
-    /// Instantiates a new query parameter instance that will be added to the request URL part of the query string.
+    /// Instantiates a new query parameter instance that will be added to the request URL by replacing part of the absolute path.
     /// The request resource should have a placeholder {name} that will be replaced with the parameter value when the request is made.
     /// </summary>
     /// <param name="name">Parameter name</param>

test/RestSharp.Tests/ParametersTests.cs

@@ -1,4 +1,5 @@
 using System.Collections;
+using System.IO;
 
 namespace RestSharp.Tests;
 
@@ -26,10 +27,49 @@ public void AddDefaultHeadersUsingDictionary() {
     public void AddUrlSegmentWithInt() {
         const string name = "foo";
 
+
         var request  = new RestRequest().AddUrlSegment(name, 1);
         var actual   = request.Parameters.FirstOrDefault(x => x.Name == name);
         var expected = new UrlSegmentParameter(name, "1");
 
         expected.Should().BeEquivalentTo(actual);
     }
+
+    [Fact]
+    public void AddUrlSegmentModifiesUrlSegmentWithInt() {
+        const string name = "foo";
+        var pathTemplate = "/{0}/resource";
+        var path = String.Format(pathTemplate, "{" + name + "}");
+        var urlSegmentValue = 1;
+
+        var request = new RestRequest(path).AddUrlSegment(name, urlSegmentValue);
+
+        var expected = String.Format(pathTemplate, urlSegmentValue);
+
+        var client = new RestClient(BaseUrl);
+
+        var actual = client.BuildUri(request).AbsolutePath;
+        
+
+        expected.Should().BeEquivalentTo(actual);
+    }
+
+    [Fact]
+    public void AddUrlSegmentModifiesUrlSegmentWithString() {
+        const string name = "foo";
+        var pathTemplate = "/{0}/resource";
+        var path = String.Format(pathTemplate, "{" + name + "}");
+        var urlSegmentValue = "bar";
+
+        var request = new RestRequest(path).AddUrlSegment(name, urlSegmentValue);
+
+        var expected = String.Format(pathTemplate, urlSegmentValue);
+
+        var client = new RestClient(BaseUrl);
+
+        var actual = client.BuildUri(request).AbsolutePath;
+
+        expected.Should().BeEquivalentTo(actual);
+
+    }
 }