From 4dc3d451d56327e5caedc993b129c714993f0dbd Mon Sep 17 00:00:00 2001 From: TharmiganK Date: Fri, 27 Sep 2024 10:02:53 +0530 Subject: [PATCH] Update API docs for HTTP method names --- ballerina/caching_http_caching_client.bal | 3 ++- ballerina/cookie_http_client.bal | 3 ++- ballerina/http_client.bal | 3 ++- ballerina/http_client_endpoint.bal | 3 ++- ballerina/http_client_object.bal | 3 ++- ballerina/http_secure_client.bal | 3 ++- ballerina/http_status_code_client.bal | 3 ++- ballerina/http_status_code_client_object.bal | 3 ++- ballerina/redirect_http_client.bal | 6 ++++-- ballerina/resiliency_failover_client.bal | 3 ++- ballerina/resiliency_http_circuit_breaker.bal | 3 ++- ballerina/resiliency_http_retry_client.bal | 6 ++++-- ballerina/resiliency_load_balance_client.bal | 3 ++- 13 files changed, 30 insertions(+), 15 deletions(-) diff --git a/ballerina/caching_http_caching_client.bal b/ballerina/caching_http_caching_client.bal index 52b83743ef..50bafa8ba9 100644 --- a/ballerina/caching_http_caching_client.bal +++ b/ballerina/caching_http_caching_client.bal @@ -201,7 +201,8 @@ client isolated class HttpCachingClient { # Submits an HTTP request to a service with the specified HTTP verb. # - # + httpVerb - The HTTP verb value + # + httpVerb - The HTTP verb value. The HTTP verb is case-sensitive. Use the `http:Method` type to specify the + # the standard HTTP methods. # + path - The resource path # + message - An HTTP outbound request or any allowed payload # + return - An `HttpFuture` that represents an asynchronous service invocation, or an error if the submission fails diff --git a/ballerina/cookie_http_client.bal b/ballerina/cookie_http_client.bal index 44db5353c8..fb86a2b911 100644 --- a/ballerina/cookie_http_client.bal +++ b/ballerina/cookie_http_client.bal @@ -177,7 +177,8 @@ client isolated class CookieClient { # The `CookieClient.submit()` function does not produce a `Response` as the result. # Rather, it returns an `HttpFuture`, which can be used to do further interactions with the endpoint. # - # + httpVerb - The HTTP verb value + # + httpVerb - The HTTP verb value. The HTTP verb is case-sensitive. Use the `http:Method` type to specify the + # the standard HTTP methods. # + path - The resource path # + message - An HTTP outbound request or any allowed payload # + return - An `HttpFuture`, which represents an asynchronous service invocation or else an `http:ClientError` if the submission fails diff --git a/ballerina/http_client.bal b/ballerina/http_client.bal index e906c6cdb7..c709872d7b 100644 --- a/ballerina/http_client.bal +++ b/ballerina/http_client.bal @@ -118,7 +118,8 @@ client isolated class HttpClient { # The `HttpClient->submit()` function does not give out an `http:Response` as the result. # Rather, it returns an `http:HttpFuture` which can be used to do further interactions with the endpoint. # - # + httpVerb - The HTTP verb value + # + httpVerb - The HTTP verb value. The HTTP verb is case-sensitive. Use the `http:Method` type to specify the + # the standard HTTP methods. # + path - The resource path # + message - An HTTP outbound request or any allowed payload # + return - An `http:HttpFuture` that represents an asynchronous service invocation, or else an `http:ClientError` if the submission fails diff --git a/ballerina/http_client_endpoint.bal b/ballerina/http_client_endpoint.bal index 2923b62d60..8b74380b5f 100644 --- a/ballerina/http_client_endpoint.bal +++ b/ballerina/http_client_endpoint.bal @@ -375,7 +375,8 @@ public client isolated class Client { # The `Client->submit()` function does not give out a `http:Response` as the result. # Rather it returns an `http:HttpFuture` which can be used to do further interactions with the endpoint. # - # + httpVerb - The HTTP verb value + # + httpVerb - The HTTP verb value. The HTTP verb is case-sensitive. Use the `http:Method` type to specify the + # the standard HTTP methods. # + path - The resource path # + message - An HTTP outbound request or any allowed payload # + return - An `http:HttpFuture` that represents an asynchronous service invocation or else an `http:ClientError` if the submission fails diff --git a/ballerina/http_client_object.bal b/ballerina/http_client_object.bal index 6a469ed299..9701387405 100644 --- a/ballerina/http_client_object.bal +++ b/ballerina/http_client_object.bal @@ -207,7 +207,8 @@ public type ClientObject client object { # The `Client->submit()` function does not give out a `http:Response` as the result. # Rather it returns an `http:HttpFuture` which can be used to do further interactions with the endpoint. # - # + httpVerb - The HTTP verb value + # + httpVerb - The HTTP verb value. The HTTP verb is case-sensitive. Use the `http:Method` type to specify the + # the standard HTTP methods. # + path - The resource path # + message - An HTTP outbound request message or any payload of type `string`, `xml`, `json`, `byte[]` # or `mime:Entity[]` diff --git a/ballerina/http_secure_client.bal b/ballerina/http_secure_client.bal index 33f8e50282..2f94d38e03 100644 --- a/ballerina/http_secure_client.bal +++ b/ballerina/http_secure_client.bal @@ -142,7 +142,8 @@ client isolated class HttpSecureClient { # This wraps the `HttpSecureClient.submit()` function of the underlying HTTP remote functions provider. Add relevant authentication # headers to the request and send the request to actual network call. # - # + httpVerb - The HTTP verb value + # + httpVerb - The HTTP verb value. The HTTP verb is case-sensitive. Use the `http:Method` type to specify the + # the standard HTTP methods. # + path - The resource path # + message - An HTTP outbound request or any allowed payload # + return - An `http:HttpFuture` that represents an asynchronous service invocation, or else an `http:ClientError` if the submission fails diff --git a/ballerina/http_status_code_client.bal b/ballerina/http_status_code_client.bal index 09574f7c95..f79e6371ef 100644 --- a/ballerina/http_status_code_client.bal +++ b/ballerina/http_status_code_client.bal @@ -373,7 +373,8 @@ public client isolated class StatusCodeClient { # The `Client->submit()` function does not give out a `http:Response` as the result. # Rather it returns an `http:HttpFuture` which can be used to do further interactions with the endpoint. # - # + httpVerb - The HTTP verb value + # + httpVerb - The HTTP verb value. The HTTP verb is case-sensitive. Use the `http:Method` type to specify the + # the standard HTTP methods. # + path - The resource path # + message - An HTTP outbound request or any allowed payload # + return - An `http:HttpFuture` that represents an asynchronous service invocation or else an `http:ClientError` if the submission fails diff --git a/ballerina/http_status_code_client_object.bal b/ballerina/http_status_code_client_object.bal index 72ceaa92e6..1dcac48c2a 100644 --- a/ballerina/http_status_code_client_object.bal +++ b/ballerina/http_status_code_client_object.bal @@ -207,7 +207,8 @@ public type StatusCodeClientObject client object { # The `Client->submit()` function does not give out a `http:Response` as the result. # Rather it returns an `http:HttpFuture` which can be used to do further interactions with the endpoint. # - # + httpVerb - The HTTP verb value + # + httpVerb - The HTTP verb value. The HTTP verb is case-sensitive. Use the `http:Method` type to specify the + # the standard HTTP methods. # + path - The resource path # + message - An HTTP outbound request message or any payload of type `string`, `xml`, `json`, `byte[]` # or `mime:Entity[]` diff --git a/ballerina/redirect_http_client.bal b/ballerina/redirect_http_client.bal index e892e9e977..45b0c1eaac 100644 --- a/ballerina/redirect_http_client.bal +++ b/ballerina/redirect_http_client.bal @@ -170,7 +170,8 @@ client isolated class RedirectClient { # The `RedirectClient.execute()` sends an HTTP request to a service with the specified HTTP verb. Redirect will be # performed only for HTTP methods. # - # + httpVerb - The HTTP verb value + # + httpVerb - The HTTP verb value. The HTTP verb is case-sensitive. Use the `http:Method` type to specify the + # the standard HTTP methods. # + path - Resource path # + message - An HTTP outbound request or any allowed payload # + return - The response or an `http:ClientError` if failed to establish the communication with the upstream server @@ -246,7 +247,8 @@ client isolated class RedirectClient { # The `RedirectClient.submit()` function does not give out a `Response` as the result, # rather it returns an `HttpFuture` which can be used to do further interactions with the endpoint. # - # + httpVerb - The HTTP verb value + # + httpVerb - The HTTP verb value. The HTTP verb is case-sensitive. Use the `http:Method` type to specify the + # the standard HTTP methods. # + path - The resource path # + message - An HTTP outbound request or any allowed payload # + return - An `http:HttpFuture` that represents an asynchronous service invocation or else an `http:ClientError` if the submission fails diff --git a/ballerina/resiliency_failover_client.bal b/ballerina/resiliency_failover_client.bal index e1be447527..fe3aaaa4d1 100644 --- a/ballerina/resiliency_failover_client.bal +++ b/ballerina/resiliency_failover_client.bal @@ -413,7 +413,8 @@ public client isolated class FailoverClient { # return an `http:Response` as the result. Rather it returns an `http:HttpFuture` which can be used for subsequent interactions # with the HTTP endpoint. # - # + httpVerb - The HTTP verb value + # + httpVerb - The HTTP verb value. The HTTP verb is case-sensitive. Use the `http:Method` type to specify the + # the standard HTTP methods. # + path - The resource path # + message - An HTTP outbound request or any allowed payload # + return - An `http:HttpFuture` that represents an asynchronous service invocation or else an `http:ClientError` if the submission diff --git a/ballerina/resiliency_http_circuit_breaker.bal b/ballerina/resiliency_http_circuit_breaker.bal index b1c89bb449..f7147155f6 100644 --- a/ballerina/resiliency_http_circuit_breaker.bal +++ b/ballerina/resiliency_http_circuit_breaker.bal @@ -306,7 +306,8 @@ client isolated class CircuitBreakerClient { # The `CircuitBreakerClient.submit()` function does not give out a `Response` as the result. # Rather it returns an `http:HttpFuture` which can be used to do further interactions with the endpoint. # - # + httpVerb - The HTTP verb value + # + httpVerb - The HTTP verb value. The HTTP verb is case-sensitive. Use the `http:Method` type to specify the + # the standard HTTP methods. # + path - The resource path # + message - An HTTP outbound request or any allowed payload # + return - An `http:HttpFuture` that represents an asynchronous service invocation or else an `http:ClientError` if the submission diff --git a/ballerina/resiliency_http_retry_client.bal b/ballerina/resiliency_http_retry_client.bal index fe1c19d6b6..8fc5bbe65b 100644 --- a/ballerina/resiliency_http_retry_client.bal +++ b/ballerina/resiliency_http_retry_client.bal @@ -130,7 +130,8 @@ client isolated class RetryClient { # the underlying HTTP remote function in a way to provide retrying functionality for a given endpoint to recover # from network level failures. # - # + httpVerb - The HTTP verb value + # + httpVerb - The HTTP verb value. The HTTP verb is case-sensitive. Use the `http:Method` type to specify the + # the standard HTTP methods. # + path - Resource path # + message - An HTTP outbound request or any allowed payload # + return - The response or an `http:ClientError` if failed to establish the communication with the upstream server @@ -217,7 +218,8 @@ client isolated class RetryClient { # The `RetryClient.submit()` function does not give out a `http:Response` as the result. # Rather it returns an `http:HttpFuture`, which can be used to do further interactions with the endpoint. # - # + httpVerb - The HTTP verb value + # + httpVerb - The HTTP verb value. The HTTP verb is case-sensitive. Use the `http:Method` type to specify the + # the standard HTTP methods. # + path - The resource path # + message - An HTTP outbound request or any allowed payload # + return - An `http:HttpFuture` that represents an asynchronous service invocation or else an `http:ClientError` if the submission fails diff --git a/ballerina/resiliency_load_balance_client.bal b/ballerina/resiliency_load_balance_client.bal index 535a3cd618..4e1612b1a0 100644 --- a/ballerina/resiliency_load_balance_client.bal +++ b/ballerina/resiliency_load_balance_client.bal @@ -349,7 +349,8 @@ public client isolated class LoadBalanceClient { # The submit implementation of the LoadBalancer Connector. # - # + httpVerb - The HTTP verb value + # + httpVerb - The HTTP verb value. The HTTP verb is case-sensitive. Use the `http:Method` type to specify the + # the standard HTTP methods. # + path - The resource path # + message - An HTTP outbound request or any allowed payload # + return - An `http:HttpFuture` that represents an asynchronous service invocation or else an `http:ClientError` if the submission