Skip to content

Commit 29d0885

Browse files
author
stlc-bot
committed
fix(openapi): document request_id and key_metadata on every response in one place (#2042)
Stainless-Generated-From: 01e8ecebff3112099ec2739f5387f088deb7c752
1 parent 08263c9 commit 29d0885

7 files changed

Lines changed: 19 additions & 19 deletions

File tree

‎Gemfile.lock‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ GIT
1111
PATH
1212
remote: .
1313
specs:
14-
context.dev (2.34.0)
14+
context.dev (2.34.1)
1515
cgi
1616
connection_pool
1717

‎lib/context_dev/models/batch_cancel_response.rb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ class BatchCancelResponse < ContextDev::Internal::Type::BaseModel
7979
required :timing, -> { ContextDev::Models::BatchCancelResponse::Timing }
8080

8181
# @!attribute key_metadata
82-
# API key usage for this request.
82+
# Credits this request used and your remaining balance.
8383
#
8484
# @return [ContextDev::Models::BatchCancelResponse::KeyMetadata, nil]
8585
optional :key_metadata, -> { ContextDev::Models::BatchCancelResponse::KeyMetadata }
@@ -112,7 +112,7 @@ class BatchCancelResponse < ContextDev::Internal::Type::BaseModel
112112
#
113113
# @param timing [ContextDev::Models::BatchCancelResponse::Timing] Batch timestamps.
114114
#
115-
# @param key_metadata [ContextDev::Models::BatchCancelResponse::KeyMetadata] API key usage for this request.
115+
# @param key_metadata [ContextDev::Models::BatchCancelResponse::KeyMetadata] Credits this request used and your remaining balance.
116116

117117
# @see ContextDev::Models::BatchCancelResponse#credits
118118
class Credits < ContextDev::Internal::Type::BaseModel
@@ -299,7 +299,7 @@ class KeyMetadata < ContextDev::Internal::Type::BaseModel
299299
required :credits_remaining, Integer
300300

301301
# @!method initialize(credits_consumed:, credits_remaining:)
302-
# API key usage for this request.
302+
# Credits this request used and your remaining balance.
303303
#
304304
# @param credits_consumed [Integer] Credits charged for this request.
305305
#

‎lib/context_dev/models/batch_retrieve_response.rb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ class BatchRetrieveResponse < ContextDev::Internal::Type::BaseModel
9999
required :timing, -> { ContextDev::Models::BatchRetrieveResponse::Timing }
100100

101101
# @!attribute key_metadata
102-
# API key usage for this request.
102+
# Credits this request used and your remaining balance.
103103
#
104104
# @return [ContextDev::Models::BatchRetrieveResponse::KeyMetadata, nil]
105105
optional :key_metadata, -> { ContextDev::Models::BatchRetrieveResponse::KeyMetadata }
@@ -145,7 +145,7 @@ class BatchRetrieveResponse < ContextDev::Internal::Type::BaseModel
145145
#
146146
# @param timing [ContextDev::Models::BatchRetrieveResponse::Timing]
147147
#
148-
# @param key_metadata [ContextDev::Models::BatchRetrieveResponse::KeyMetadata] API key usage for this request.
148+
# @param key_metadata [ContextDev::Models::BatchRetrieveResponse::KeyMetadata] Credits this request used and your remaining balance.
149149
#
150150
# @param webhook_delivery_id [String] Batch completion delivery ID, when available.
151151

@@ -442,7 +442,7 @@ class KeyMetadata < ContextDev::Internal::Type::BaseModel
442442
required :credits_remaining, Integer
443443

444444
# @!method initialize(credits_consumed:, credits_remaining:)
445-
# API key usage for this request.
445+
# Credits this request used and your remaining balance.
446446
#
447447
# @param credits_consumed [Integer] Credits charged for this request.
448448
#

‎lib/context_dev/models/batch_submit_response.rb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ class BatchSubmitResponse < ContextDev::Internal::Type::BaseModel
7979
required :tags, ContextDev::Internal::Type::ArrayOf[String]
8080

8181
# @!attribute key_metadata
82-
# API key usage for this request.
82+
# Credits this request used and your remaining balance.
8383
#
8484
# @return [ContextDev::Models::BatchSubmitResponse::KeyMetadata, nil]
8585
optional :key_metadata, -> { ContextDev::Models::BatchSubmitResponse::KeyMetadata }
@@ -118,7 +118,7 @@ class BatchSubmitResponse < ContextDev::Internal::Type::BaseModel
118118
#
119119
# @param tags [Array<String>] Tags stored on the batch.
120120
#
121-
# @param key_metadata [ContextDev::Models::BatchSubmitResponse::KeyMetadata] API key usage for this request.
121+
# @param key_metadata [ContextDev::Models::BatchSubmitResponse::KeyMetadata] Credits this request used and your remaining balance.
122122
#
123123
# @param webhook_secret [String] Secret for verifying `X-Context-Signature`. Only submit returns it, so store it.
124124

@@ -314,7 +314,7 @@ class KeyMetadata < ContextDev::Internal::Type::BaseModel
314314
required :credits_remaining, Integer
315315

316316
# @!method initialize(credits_consumed:, credits_remaining:)
317-
# API key usage for this request.
317+
# Credits this request used and your remaining balance.
318318
#
319319
# @param credits_consumed [Integer] Credits charged for this request.
320320
#

‎rbi/context_dev/models/batch_cancel_response.rbi‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ module ContextDev
9999
end
100100
attr_writer :timing
101101

102-
# API key usage for this request.
102+
# Credits this request used and your remaining balance.
103103
sig do
104104
returns(T.nilable(ContextDev::Models::BatchCancelResponse::KeyMetadata))
105105
end
@@ -158,7 +158,7 @@ module ContextDev
158158
tags:,
159159
# Batch timestamps.
160160
timing:,
161-
# API key usage for this request.
161+
# Credits this request used and your remaining balance.
162162
key_metadata: nil
163163
)
164164
end
@@ -502,7 +502,7 @@ module ContextDev
502502
sig { returns(Integer) }
503503
attr_accessor :credits_remaining
504504

505-
# API key usage for this request.
505+
# Credits this request used and your remaining balance.
506506
sig do
507507
params(credits_consumed: Integer, credits_remaining: Integer).returns(
508508
T.attached_class

‎rbi/context_dev/models/batch_retrieve_response.rbi‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ module ContextDev
129129
end
130130
attr_writer :timing
131131

132-
# API key usage for this request.
132+
# Credits this request used and your remaining balance.
133133
sig do
134134
returns(
135135
T.nilable(ContextDev::Models::BatchRetrieveResponse::KeyMetadata)
@@ -214,7 +214,7 @@ module ContextDev
214214
# Tags stored on the batch at submission.
215215
tags:,
216216
timing:,
217-
# API key usage for this request.
217+
# Credits this request used and your remaining balance.
218218
key_metadata: nil,
219219
# Batch completion delivery ID, when available.
220220
webhook_delivery_id: nil
@@ -767,7 +767,7 @@ module ContextDev
767767
sig { returns(Integer) }
768768
attr_accessor :credits_remaining
769769

770-
# API key usage for this request.
770+
# Credits this request used and your remaining balance.
771771
sig do
772772
params(credits_consumed: Integer, credits_remaining: Integer).returns(
773773
T.attached_class

‎rbi/context_dev/models/batch_submit_response.rbi‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ module ContextDev
9494
sig { returns(T::Array[String]) }
9595
attr_accessor :tags
9696

97-
# API key usage for this request.
97+
# Credits this request used and your remaining balance.
9898
sig do
9999
returns(T.nilable(ContextDev::Models::BatchSubmitResponse::KeyMetadata))
100100
end
@@ -164,7 +164,7 @@ module ContextDev
164164
status:,
165165
# Tags stored on the batch.
166166
tags:,
167-
# API key usage for this request.
167+
# Credits this request used and your remaining balance.
168168
key_metadata: nil,
169169
# Secret for verifying `X-Context-Signature`. Only submit returns it, so store it.
170170
webhook_secret: nil
@@ -550,7 +550,7 @@ module ContextDev
550550
sig { returns(Integer) }
551551
attr_accessor :credits_remaining
552552

553-
# API key usage for this request.
553+
# Credits this request used and your remaining balance.
554554
sig do
555555
params(credits_consumed: Integer, credits_remaining: Integer).returns(
556556
T.attached_class

0 commit comments

Comments
 (0)