Merge pull request #9 from go-resty/docs-part8

Docs part8

Author: jeevatkm

content/docs/allow-payload-on.md

@@ -9,7 +9,7 @@ However, the methods GET and DELETE have been the subject of debate or interpret
 
 So Resty, by default, disallows the request payload on GET and DELETE HTTP verbs.
 
-Some systems, in real-world use, request payloads on GET and DELETE. Resty provides explicit methods to enable payloads for these verbs.
+Some systems, in real-world use, request payloads on GET and DELETE. Resty provides explicit methods to enable payload for these verbs.
 
 ## Methods
 

content/docs/authentication.md

@@ -108,3 +108,4 @@ client.AddRequestMiddleware(func(c *resty.Client, req *resty.Request) error {
 * [Request.SetBasicAuth]({{% godoc v3 %}}Request.SetBasicAuth)
 * [Request.SetAuthToken]({{% godoc v3 %}}Request.SetAuthToken)
 * [Request.SetAuthScheme]({{% godoc v3 %}}Request.SetAuthScheme)
+* [Request.SetHeaderAuthorizationKey]({{% godoc v3 %}}Request.SetHeaderAuthorizationKey)

content/docs/client-certificates.md

@@ -1,5 +1,5 @@
 ---
-weight: 6
+weight: 7
 ---
 
 # Client Certificates

content/docs/client-root-certificates.md

@@ -1,5 +1,5 @@
 ---
-weight: 5
+weight: 6
 ---
 
 # Client Root Certificates

content/docs/content-type-encoder-and-decoder.md

@@ -1,6 +1,6 @@
 ---
 title: Content-Type {Encoder, Decoder}
-weight: 6
+weight: 7
 ---
 
 # Content-Type {Encoder, Decoder}

content/docs/example/delete-request.md

@@ -0,0 +1,52 @@
+---
+title: DELETE Request
+weight: 2
+---
+
+# DELETE Request
+
+This page discusses simple DELETE requests. Users can utilize Resty features across nearly all HTTP methods.
+
+{{% hint info %}}
+* Explore the documentation to fulfill all use cases.
+* Examples use request-level methods; however, Resty also includes client-level methods to configure settings for all requests.
+{{% /hint %}}
+
+## Examples
+
+See [Request Body Types]({{% relref "request-body-types" %}}), [Allow Payload On]({{% relref "allow-payload-on" %}})
+
+```go
+// create a Resty client
+client := resty.New()
+defer client.Close()
+```
+
+### Simple
+
+```go
+res, err := client.R().
+ SetAuthToken("bc594900518b4f7eac75bd37f019e08fbc594900518b4f7eac75bd37f019e08f").
+ SetError(&Error{}). // or SetError(Error{}).
+ Delete("https://myapp.com/articles/123456")
+
+fmt.Println(err, res)
+fmt.Println(res.Error().(*Error))
+```
+
+### With Payload
+
+See [Allow Payload On]({{% relref "allow-payload-on" %}})
+
+```go
+res, err := client.R().
+ SetAuthToken("bc594900518b4f7eac75bd37f019e08fbc594900518b4f7eac75bd37f019e08f").
+ SetBody(map[string]any{
+ "article_ids": []int{1002, 1006, 1007, 87683, 45432},
+ }). // default request content type is JSON
+ SetError(&Error{}). // or SetError(Error{}).
+ Delete("https://myapp.com/articles")
+
+fmt.Println(err, res)
+fmt.Println(res.Error().(*Error))
+```

content/docs/example/get-request.md

@@ -0,0 +1,91 @@
+---
+title: GET Request
+weight: 1
+---
+
+# GET Request
+
+This page discusses simple GET requests. Users can utilize Resty features across nearly all HTTP methods.
+
+{{% hint info %}}
+* Explore the documentation to fulfill all use cases.
+* Examples use request-level methods; however, Resty also includes client-level methods to configure settings for all requests.
+{{% /hint %}}
+
+## Examples
+
+See [Request Body Types]({{% relref "request-body-types" %}}), [Allow Payload On]({{% relref "allow-payload-on" %}})
+
+```go
+// create a Resty client
+client := resty.New()
+defer client.Close()
+```
+
+### Simple
+
+```go
+res, err := client.R().
+ Get("https://httpbin.org/get")
+
+fmt.Println(err, res)
+```
+
+### With Query Params
+
+See [Request Query Params]({{% relref "request-query-params" %}})
+
+```go
+res, err := client.R().
+ SetQueryParams(map[string]string{
+ "page_no": "1",
+ "limit": "20",
+ "sort": "name",
+ "order": "asc",
+ "random": strconv.FormatInt(time.Now().Unix(), 10),
+ }).
+ SetHeader("Accept", "application/json").
+ SetAuthToken("bc594900518b4f7eac75bd37f019e08fbc594900518b4f7eac75bd37f019e08f").
+ Get("/search_result")
+
+fmt.Println(err, res)
+```
+
+### With Path Params
+
+See [Request Path Params]({{% relref "request-path-params" %}})
+
+```go
+res, err := client.R().
+ SetPathParams(map[string]string{
+"userId": "sample@sample.com",
+"subAccountId": "100002",
+}).
+ SetAuthToken("bc594900518b4f7eac75bd37f019e08fbc594900518b4f7eac75bd37f019e08f").
+ Get("/v1/users/{userId}/{subAccountId}/details")
+
+fmt.Println(err, res)
+```
+
+### With Payload
+
+See [Allow Payload On]({{% relref "allow-payload-on" %}})
+
+```go
+res, err := client.R().
+ SetAllowMethodGetPayload(true). // client level options is available
+ SetContentType("application/json").
+ SetBody(`{
+ "query": {
+ "simple_query_string" : {
+ "query": "\"fried eggs\" +(eggplant | potato) -frittata",
+ "fields": ["title^5", "body"],
+ "default_operator": "and"
+ }
+ }
+ }`). // this is string value as request body
+ SetAuthToken("bc594900518b4f7eac75bd37f019e08fbc594900518b4f7eac75bd37f019e08f").
+ Get("/_search")
+
+fmt.Println(err, res)
+```

content/docs/example/oauth2-client-credentials.md

@@ -7,7 +7,7 @@ title: OAuth2 Client Credentials
 [![Go Reference](https://pkg.go.dev/badge/golang.org/x/oauth2/clientcredentials.svg)](https://pkg.go.dev/golang.org/x/oauth2/clientcredentials)
 
 
-## Without Modifying TLSClientConfig
+## Without Modifying
 
 {{% hint info %}}
 As per the GoDoc of [clientcredentials#Config.Client](https://pkg.go.dev/golang.org/x/oauth2/clientcredentials#Config.Client)
@@ -30,14 +30,14 @@ defer c.Close()
 ```
 
 
-## Modifying TLSClientConfig
+## Modifying
 
-This scenario is applicable for adding Root CA, Client Root CA, Client SSL certs, transport timeouts, etc.
+This scenario applies to any client and transport-related configurations, such as adding Root CA, Client Root CA, Client SSL certificates, transport timeouts, and so on.
 
 {{% hint info %}}
 * As per the GoDoc of [clientcredentials#Config.Client](https://pkg.go.dev/golang.org/x/oauth2/clientcredentials#Config.Client)
  * The returned `Client` and its `Transport` should not be modified.
-* To modify TLSClientConfig and use the oauth2 client credentials package together, a slight tweak is required.
+* To use the oauth2 client credentials package and make modifications to it, a minor adjustment is necessary.
 {{% /hint %}}
 
 ```go
@@ -50,9 +50,9 @@ c := resty.New()
 defer c.Close()
 
 // configure required Root CA, Client Root CA, or Client SSL certs
-c.SetRootCertificates("/path/to/root/pemFile.pem")
-c.SetClientRootCertificates("/path/to/client-root/pemFile.pem")
-c.SetCertificateFromFile("/path/to/certs/client.pem", "/path/to/certs/client.key")
+// c.SetRootCertificates("/path/to/root/pemFile.pem")
+// c.SetClientRootCertificates("/path/to/client-root/pemFile.pem")
+// c.SetCertificateFromFile("/path/to/certs/client.pem", "/path/to/certs/client.key")
 
 // add custom auth request middleware
 c.AddRequestMiddleware(func(c *resty.Client, req *resty.Request) error {

content/docs/example/oauth2-clientcredentials-package.md

@@ -0,0 +1,55 @@
+---
+title: OPTIONS, HEAD, TRACE Request
+weight: 2
+---
+
+# OPTIONS, HEAD, TRACE Request
+
+This page discusses simple OPTIONS, HEAD, and TRACE requests. Users can utilize Resty features across nearly all HTTP methods.
+
+{{% hint info %}}
+* Explore the documentation to fulfill all use cases.
+* Examples use request-level methods; however, Resty also includes client-level methods to configure settings for all requests.
+{{% /hint %}}
+
+## Examples
+
+```go
+// create a Resty client
+client := resty.New()
+defer client.Close()
+```
+
+### OPTIONS
+
+Commonly used to determine permitted HTTP methods or CORS preflight requests.
+
+```go
+res, err := client.R().
+ SetAuthToken("bc594900518b4f7eac75bd37f019e08fbc594900518b4f7eac75bd37f019e08f").
+ Options("https://myapp.com/servers/nyc-dc-01")
+
+fmt.Println(err, res)
+fmt.Println(res.Header())
+```
+
+### HEAD
+
+```go
+res, err = client.R().
+ SetAuthToken("bc594900518b4f7eac75bd37f019e08fbc594900518b4f7eac75bd37f019e08f").
+ Head("https://myapp.com/videos/hi-res-video")
+
+fmt.Println(err, res)
+fmt.Println(res.Header())
+```
+
+### TRACE
+
+```go
+res, err = client.R().
+ SetAuthToken("bc594900518b4f7eac75bd37f019e08fbc594900518b4f7eac75bd37f019e08f").
+ Trace("https://myapp.com/test")
+
+fmt.Println(err, res)
+```