Skip to content

Commit 0682128

Browse files
feat(api): manual updates
1 parent f9bee87 commit 0682128

File tree

3 files changed

+25
-23
lines changed

3 files changed

+25
-23
lines changed

.stats.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 42
22
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d1a3e6dfc45ae832b6b14a0aef25878985c679fa9f48c1470df188b1578ba648.yml
33
openapi_spec_hash: 1d382866fce3284f26d341f112988d9d
4-
config_hash: 29a2351fe2be89392b15719be8bc964f
4+
config_hash: c9c7bed2a4341f915a2dc85958ce7f0e

lib/imagekit/client.rb

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ class Client < Imagekit::Internal::Transport::BaseClient
1515
# Default max retry delay in seconds.
1616
DEFAULT_MAX_RETRY_DELAY = 8.0
1717

18-
# Your ImageKit private API key (it starts with `private_`). You can view and
19-
# manage API keys in the
20-
# [dashboard](https://imagekit.io/dashboard/developer/api-keys).
18+
# Your ImageKit private API key (starts with `private_`). You can find this in the
19+
# [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys).
2120
# @return [String]
2221
attr_reader :private_key
2322

24-
# ImageKit Basic Auth only uses the `private_key` as username and ignores the
25-
# password.
23+
# Leave this field unset. ImageKit uses Basic Authentication scheme that requires
24+
# the `private_key` as the username and empty string as the password. The password
25+
# field is automatically managed by the SDK and should not be set.
2626
# @return [String, nil]
2727
attr_reader :password
2828

@@ -67,13 +67,14 @@ def base_url_overridden? = @base_url_overridden
6767

6868
# Creates and returns a new client for interacting with the API.
6969
#
70-
# @param private_key [String, nil] Your ImageKit private API key (it starts with `private_`). You can view and
71-
# manage API keys in the
72-
# [dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults to
73-
# `ENV["IMAGEKIT_PRIVATE_API_KEY"]`
70+
# @param private_key [String, nil] Your ImageKit private API key (starts with `private_`). You can find this in the
71+
# [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults
72+
# to `ENV["IMAGEKIT_PRIVATE_API_KEY"]`
7473
#
75-
# @param password [String, nil] ImageKit Basic Auth only uses the `private_key` as username and ignores the
76-
# password. Defaults to `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]`
74+
# @param password [String, nil] Leave this field unset. ImageKit uses Basic Authentication scheme that requires
75+
# the `private_key` as the username and empty string as the password. The password
76+
# field is automatically managed by the SDK and should not be set. Defaults to
77+
# `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]`
7778
#
7879
# @param base_url [String, nil] Override the default base URL for the API, e.g.,
7980
# `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]`

rbi/imagekit/client.rbi

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ module Imagekit
1010

1111
DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
1212

13-
# Your ImageKit private API key (it starts with `private_`). You can view and
14-
# manage API keys in the
15-
# [dashboard](https://imagekit.io/dashboard/developer/api-keys).
13+
# Your ImageKit private API key (starts with `private_`). You can find this in the
14+
# [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys).
1615
sig { returns(String) }
1716
attr_reader :private_key
1817

19-
# ImageKit Basic Auth only uses the `private_key` as username and ignores the
20-
# password.
18+
# Leave this field unset. ImageKit uses Basic Authentication scheme that requires
19+
# the `private_key` as the username and empty string as the password. The password
20+
# field is automatically managed by the SDK and should not be set.
2121
sig { returns(T.nilable(String)) }
2222
attr_reader :password
2323

@@ -68,13 +68,14 @@ module Imagekit
6868
).returns(T.attached_class)
6969
end
7070
def self.new(
71-
# Your ImageKit private API key (it starts with `private_`). You can view and
72-
# manage API keys in the
73-
# [dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults to
74-
# `ENV["IMAGEKIT_PRIVATE_API_KEY"]`
71+
# Your ImageKit private API key (starts with `private_`). You can find this in the
72+
# [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults
73+
# to `ENV["IMAGEKIT_PRIVATE_API_KEY"]`
7574
private_key: ENV["IMAGEKIT_PRIVATE_API_KEY"],
76-
# ImageKit Basic Auth only uses the `private_key` as username and ignores the
77-
# password. Defaults to `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]`
75+
# Leave this field unset. ImageKit uses Basic Authentication scheme that requires
76+
# the `private_key` as the username and empty string as the password. The password
77+
# field is automatically managed by the SDK and should not be set. Defaults to
78+
# `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]`
7879
password: ENV.fetch("OPTIONAL_IMAGEKIT_IGNORES_THIS", "do_not_set"),
7980
# Override the default base URL for the API, e.g.,
8081
# `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]`

0 commit comments

Comments
 (0)