Skip to content

Commit bc53c1a

Browse files
feat(api): manual updates
1 parent 5f9a2af commit bc53c1a

File tree

6 files changed

+21
-30
lines changed

6 files changed

+21
-30
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 42
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml
3-
openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-eab9713fd85da68b41e881dfd9cd71f654e8620132da2023bab7dd01e5f7852e.yml
3+
openapi_spec_hash: b5037b26fbe7360c6bfaf9947a65bb85
44
config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,8 @@ The full API of this library can be found in [api.md](api.md).
4141
package main
4242

4343
import (
44-
"bytes"
4544
"context"
4645
"fmt"
47-
"io"
4846

4947
"github.com/imagekit-developer/imagekit-go"
5048
"github.com/imagekit-developer/imagekit-go/option"
@@ -56,7 +54,7 @@ func main() {
5654
option.WithPassword("My Password"), // defaults to os.LookupEnv("OPTIONAL_IMAGEKIT_IGNORES_THIS")
5755
)
5856
response, err := client.Files.Upload(context.TODO(), imagekit.FileUploadParams{
59-
File: io.Reader(bytes.NewBuffer([]byte("https://www.example.com/public-url.jpg"))),
57+
File: "https://www.example.com/public-url.jpg",
6058
FileName: "file-name.jpg",
6159
})
6260
if err != nil {
@@ -300,7 +298,7 @@ To handle errors, we recommend that you use the `errors.As` pattern:
300298

301299
```go
302300
_, err := client.Files.Upload(context.TODO(), imagekit.FileUploadParams{
303-
File: io.Reader(bytes.NewBuffer([]byte("https://www.example.com/public-url.jpg"))),
301+
File: "https://www.example.com/public-url.jpg",
304302
FileName: "file-name.jpg",
305303
})
306304
if err != nil {
@@ -330,7 +328,7 @@ defer cancel()
330328
client.Files.Upload(
331329
ctx,
332330
imagekit.FileUploadParams{
333-
File: io.Reader(bytes.NewBuffer([]byte("https://www.example.com/public-url.jpg"))),
331+
File: "https://www.example.com/public-url.jpg",
334332
FileName: "file-name.jpg",
335333
},
336334
// This sets the per-retry timeout
@@ -354,19 +352,19 @@ which can be used to wrap any `io.Reader` with the appropriate file name and con
354352
```go
355353
// A file from the file system
356354
file, err := os.Open("/path/to/file")
357-
imagekit.FileUploadParams{
355+
imagekit.BetaV2FileUploadParams{
358356
File: file,
359357
FileName: "fileName",
360358
}
361359

362360
// A file from a string
363-
imagekit.FileUploadParams{
361+
imagekit.BetaV2FileUploadParams{
364362
File: strings.NewReader("my file contents"),
365363
FileName: "fileName",
366364
}
367365

368366
// With a custom filename and contentType
369-
imagekit.FileUploadParams{
367+
imagekit.BetaV2FileUploadParams{
370368
File: imagekit.NewFile(strings.NewReader(`{"hello": "foo"}`), "file.go", "application/json"),
371369
FileName: "fileName",
372370
}
@@ -390,7 +388,7 @@ client := imagekit.NewClient(
390388
client.Files.Upload(
391389
context.TODO(),
392390
imagekit.FileUploadParams{
393-
File: io.Reader(bytes.NewBuffer([]byte("https://www.example.com/public-url.jpg"))),
391+
File: "https://www.example.com/public-url.jpg",
394392
FileName: "file-name.jpg",
395393
},
396394
option.WithMaxRetries(5),
@@ -408,7 +406,7 @@ var response *http.Response
408406
response, err := client.Files.Upload(
409407
context.TODO(),
410408
imagekit.FileUploadParams{
411-
File: io.Reader(bytes.NewBuffer([]byte("https://www.example.com/public-url.jpg"))),
409+
File: "https://www.example.com/public-url.jpg",
412410
FileName: "file-name.jpg",
413411
},
414412
option.WithResponseInto(&response),

client_test.go

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@
33
package imagekit_test
44

55
import (
6-
"bytes"
76
"context"
87
"fmt"
9-
"io"
108
"net/http"
119
"reflect"
1210
"testing"
@@ -42,7 +40,7 @@ func TestUserAgentHeader(t *testing.T) {
4240
}),
4341
)
4442
client.Files.Upload(context.Background(), imagekit.FileUploadParams{
45-
File: io.Reader(bytes.NewBuffer([]byte("https://www.example.com/public-url.jpg"))),
43+
File: "https://www.example.com/public-url.jpg",
4644
FileName: "file-name.jpg",
4745
})
4846
if userAgent != fmt.Sprintf("ImageKit/Go %s", internal.PackageVersion) {
@@ -70,7 +68,7 @@ func TestRetryAfter(t *testing.T) {
7068
}),
7169
)
7270
_, err := client.Files.Upload(context.Background(), imagekit.FileUploadParams{
73-
File: io.Reader(bytes.NewBuffer([]byte("https://www.example.com/public-url.jpg"))),
71+
File: "https://www.example.com/public-url.jpg",
7472
FileName: "file-name.jpg",
7573
})
7674
if err == nil {
@@ -109,7 +107,7 @@ func TestDeleteRetryCountHeader(t *testing.T) {
109107
option.WithHeaderDel("X-Stainless-Retry-Count"),
110108
)
111109
_, err := client.Files.Upload(context.Background(), imagekit.FileUploadParams{
112-
File: io.Reader(bytes.NewBuffer([]byte("https://www.example.com/public-url.jpg"))),
110+
File: "https://www.example.com/public-url.jpg",
113111
FileName: "file-name.jpg",
114112
})
115113
if err == nil {
@@ -143,7 +141,7 @@ func TestOverwriteRetryCountHeader(t *testing.T) {
143141
option.WithHeader("X-Stainless-Retry-Count", "42"),
144142
)
145143
_, err := client.Files.Upload(context.Background(), imagekit.FileUploadParams{
146-
File: io.Reader(bytes.NewBuffer([]byte("https://www.example.com/public-url.jpg"))),
144+
File: "https://www.example.com/public-url.jpg",
147145
FileName: "file-name.jpg",
148146
})
149147
if err == nil {
@@ -176,7 +174,7 @@ func TestRetryAfterMs(t *testing.T) {
176174
}),
177175
)
178176
_, err := client.Files.Upload(context.Background(), imagekit.FileUploadParams{
179-
File: io.Reader(bytes.NewBuffer([]byte("https://www.example.com/public-url.jpg"))),
177+
File: "https://www.example.com/public-url.jpg",
180178
FileName: "file-name.jpg",
181179
})
182180
if err == nil {
@@ -203,7 +201,7 @@ func TestContextCancel(t *testing.T) {
203201
cancelCtx, cancel := context.WithCancel(context.Background())
204202
cancel()
205203
_, err := client.Files.Upload(cancelCtx, imagekit.FileUploadParams{
206-
File: io.Reader(bytes.NewBuffer([]byte("https://www.example.com/public-url.jpg"))),
204+
File: "https://www.example.com/public-url.jpg",
207205
FileName: "file-name.jpg",
208206
})
209207
if err == nil {
@@ -227,7 +225,7 @@ func TestContextCancelDelay(t *testing.T) {
227225
cancelCtx, cancel := context.WithTimeout(context.Background(), 2*time.Millisecond)
228226
defer cancel()
229227
_, err := client.Files.Upload(cancelCtx, imagekit.FileUploadParams{
230-
File: io.Reader(bytes.NewBuffer([]byte("https://www.example.com/public-url.jpg"))),
228+
File: "https://www.example.com/public-url.jpg",
231229
FileName: "file-name.jpg",
232230
})
233231
if err == nil {
@@ -257,7 +255,7 @@ func TestContextDeadline(t *testing.T) {
257255
}),
258256
)
259257
_, err := client.Files.Upload(deadlineCtx, imagekit.FileUploadParams{
260-
File: io.Reader(bytes.NewBuffer([]byte("https://www.example.com/public-url.jpg"))),
258+
File: "https://www.example.com/public-url.jpg",
261259
FileName: "file-name.jpg",
262260
})
263261
if err == nil {

file.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ import (
77
"context"
88
"errors"
99
"fmt"
10-
"io"
1110
"mime/multipart"
1211
"net/http"
1312
"time"
@@ -1261,7 +1260,7 @@ type FileUploadParams struct {
12611260
//
12621261
// When supplying a URL, the server must receive the response headers within 8
12631262
// seconds; otherwise the request fails with 400 Bad Request.
1264-
File io.Reader `json:"file,omitzero,required" format:"binary"`
1263+
File string `json:"file,required"`
12651264
// The name with which the file has to be uploaded. The file name can contain:
12661265
//
12671266
// - Alphanumeric Characters: `a-z`, `A-Z`, `0-9`.

file_test.go

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@
33
package imagekit_test
44

55
import (
6-
"bytes"
76
"context"
87
"errors"
9-
"io"
108
"os"
119
"testing"
1210

@@ -227,7 +225,7 @@ func TestFileUploadWithOptionalParams(t *testing.T) {
227225
option.WithPassword("My Password"),
228226
)
229227
_, err := client.Files.Upload(context.TODO(), imagekit.FileUploadParams{
230-
File: io.Reader(bytes.NewBuffer([]byte("some file contents"))),
228+
File: "https://www.example.com/path/to-image.jpg",
231229
FileName: "fileName",
232230
Token: imagekit.String("token"),
233231
Checks: imagekit.String("\"request.folder\" : \"marketing/\"\n"),

usage_test.go

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33
package imagekit_test
44

55
import (
6-
"bytes"
76
"context"
8-
"io"
97
"os"
108
"testing"
119

@@ -28,7 +26,7 @@ func TestUsage(t *testing.T) {
2826
option.WithPassword("My Password"),
2927
)
3028
response, err := client.Files.Upload(context.TODO(), imagekit.FileUploadParams{
31-
File: io.Reader(bytes.NewBuffer([]byte("https://www.example.com/public-url.jpg"))),
29+
File: "https://www.example.com/public-url.jpg",
3230
FileName: "file-name.jpg",
3331
})
3432
if err != nil {

0 commit comments

Comments
 (0)