Skip to content

Commit

Permalink
Merge pull request #2165 from ballerina-platform/execute-doc-update
Browse files Browse the repository at this point in the history
Update API docs for HTTP method names
  • Loading branch information
NipunaRanasinghe authored Sep 30, 2024
2 parents 7e41f9a + cb35021 commit 7945b76
Show file tree
Hide file tree
Showing 13 changed files with 30 additions and 15 deletions.
3 changes: 2 additions & 1 deletion ballerina/caching_http_caching_client.bal
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion ballerina/cookie_http_client.bal
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion ballerina/http_client.bal
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion ballerina/http_client_endpoint.bal
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion ballerina/http_client_object.bal
Original file line number Diff line number Diff line change
Expand Up @@ -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[]`
Expand Down
3 changes: 2 additions & 1 deletion ballerina/http_secure_client.bal
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion ballerina/http_status_code_client.bal
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion ballerina/http_status_code_client_object.bal
Original file line number Diff line number Diff line change
Expand Up @@ -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[]`
Expand Down
6 changes: 4 additions & 2 deletions ballerina/redirect_http_client.bal
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion ballerina/resiliency_failover_client.bal
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion ballerina/resiliency_http_circuit_breaker.bal
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 4 additions & 2 deletions ballerina/resiliency_http_retry_client.bal
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion ballerina/resiliency_load_balance_client.bal
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 7945b76

Please sign in to comment.