Skip to content

Commit 0d59a83

Browse files
committed
v3 beta release docs updates
1 parent 5dc45ff commit 0d59a83

File tree

5 files changed

+22
-5
lines changed

5 files changed

+22
-5
lines changed

assets/_custom.scss

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,12 @@ a .r-icon {
9595
background-color: #282a36;
9696
}
9797

98+
.resty-go-min {
99+
margin-top: .3rem;
100+
text-align: center;
101+
font-size: 0.8em;
102+
}
103+
98104
.global-msg {
99105
margin: 0 0 2rem;
100106
padding: .5rem 1rem .5rem .75rem;

content/_index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ type: docs
3131
<code>require resty.dev/v3 {{% param Resty.V3.Version %}}</code>
3232
</pre>
3333
</div>
34+
<div class="resty-go-min">Minimum required Go version is {{% param Resty.V3.GoMinVersion %}}</div>
3435

3536
{{% columns %}}
3637
```go
@@ -49,8 +50,8 @@ fmt.Println(res.Request.TraceInfo())
4950
// Server-Sent Events Client
5051
es := NewEventSource().
5152
SetURL("https://sse.dev/test").
52-
OnMessage(func(a any) {
53-
fmt.Println(a.(*resty.Event))
53+
OnMessage(func(e any) {
54+
fmt.Println(e.(*resty.Event))
5455
}, nil)
5556

5657
err := es.Get()
@@ -88,7 +89,7 @@ This website represents Resty v3 and above. For previous v2 documentation, refer
8889
* Download to file
8990
* Redirect Policies
9091
* Circuit Breaker Policy
91-
* Debug mode with human-readable log
92+
* Debug mode with human-readable, JSON log
9293
* Load Balancer and Service Discovery
9394
* Response body limit & Unlimited reads
9495
* Bazel support
@@ -112,5 +113,6 @@ Resty provides various ways to enhance its functionality by implementing its int
112113
* Request Functions
113114
* Redirect Policy
114115
* Transport RoundTripper
116+
* Debug Log Formatter
115117
* Logger
116118

content/docs/upgrading-to-v3.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ bookHidden: true
66

77
Resty v3 release brings many new features, enhancements, and breaking changes. This page outlines upgrading Resty to v3.
88

9+
{{% hint info %}}
10+
Minimum required go version is `{{% param Resty.V3.GoMinVersion %}}`
11+
{{% /hint %}}
12+
913
## Update go.mod
1014

1115
Resty v3 provides a Go vanity URL.
@@ -87,6 +91,10 @@ I made necessary breaking changes to improve Resty and open up future growth pos
8791
* `Request.GenerateCurlCommand` => [Request.CurlCmd]({{% godoc v3 %}}Request.CurlCmd)
8892
* `Request.AddRetryCondition` => [Request.AddRetryConditions]({{% godoc v3 %}}Request.AddRetryConditions)
8993

94+
#### Response
95+
96+
* `Response.Time` => [Response.Duration]({{% godoc v3 %}}Response.Duration)
97+
9098
#### Multipart
9199

92100
* `MultipartField.Param` => [MultipartField.Name]({{% godoc v3 %}}MultipartField)

hugo.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ params:
4949
GitHubRepo: https://github.com/go-resty/resty
5050
GitHubSlug: go-resty/resty
5151
V3:
52-
Version: v3.0.0-alpha.10
52+
Version: v3.0.0-beta.1
53+
GoMinVersion: go1.21
5354
Vanity: resty.dev/v3
5455
GoDocLinkPrefix: https://pkg.go.dev/resty.dev/v3#
5556

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<div class="global-msg global-msg-warning" align="center">
2-
<p><strong>NOTE: Currently, Resty v3 is in alpha release, and documentation is in-progress ...</strong></p>
2+
<p><strong>NOTE: Currently, Resty v3 is in beta release</strong></p>
33
</div>

0 commit comments

Comments
 (0)