context.dev 2.17.0 → 2.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ef06287736220b8406602722c6d4bff1c2301a6224c88308a687b5fe3a0c43b
-  data.tar.gz: dea8f15506d185c74514659325d1c30d7860b81a0d771b821429502b132096b9
+  metadata.gz: 18b47383d0fc922af7bc818a48819c4d702950b89c51f28b6e373b3b6468108b
+  data.tar.gz: e0f57cfa02d05a6b3d6b24956798e52fe21841280ac164b7c53d8980b246ec37
 SHA512:
-  metadata.gz: 7a1f4701bf53c53328c5271646e57e81cbd93e0f4f7d909a6d4a7cbc3d21087ebe8b77f2dcfe83b2b8186cf3cce5990cf944aa54b28f44392a6dc32fec078049
-  data.tar.gz: 7a6ff355e62a1cf5f37f70edc73d86f22d430253e82a0668f82c7162a48d804f20ed4d15e78b21d534e6f9523b1040f4a5135f56991b1bf82c8e74121b2734e2
+  metadata.gz: 50a79881ad62bece93534a540bd06b18e3618687b81c8f817d95929339769766d7260da3bdb7409be4d42957c5d57818dceafc07fa3495b510d8dfde70af014a
+  data.tar.gz: 6a22ac07b5bebf800443f990c556f1864a41872f5ca08381716702b1cd61a470d22da90a4350dc745e357a1c21959f13bc156d585984ae0b4d7d98124d34cc06

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [2.17.1](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.17.0...v2.17.1) (2026-09-15)
+
+
+### Bug Fixes
+
+* **api:** guarantee search descriptions and align response types ([#1089](https://github.com/context-dot-dev/context-ruby-sdk/issues/1089)) ([7ee03fc](https://github.com/context-dot-dev/context-ruby-sdk/commit/7ee03fc233d3e975f01fd3d290defb48a6e6ad56))
+
 ## [2.17.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.16.0...v2.17.0) (2026-09-15)
 
 

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "context.dev", "~> 2.17.0"
+gem "context.dev", "~> 2.17.1"
 ```
 
 <!-- x-release-please-end -->

data/lib/context_dev/models/brand_retrieve_response.rb

@@ -4,6 +4,12 @@ module ContextDev
   module Models
     # @see ContextDev::Resources::Brand#retrieve
     class BrandRetrieveResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute brand
+      #   Detailed brand information
+      #
+      #   @return [ContextDev::Models::BrandRetrieveResponse::Brand]
+      required :brand, -> { ContextDev::Models::BrandRetrieveResponse::Brand }
+
       # @!attribute cache_metadata
       #   Cache outcome for this response. Composite responses are hits only when every
       #   cache-controlled fetch contributing to the output was a hit; age_ms is the
@@ -12,6 +18,12 @@ module ContextDev
       #   @return [ContextDev::Models::BrandRetrieveResponse::CacheMetadata]
       required :cache_metadata, -> { ContextDev::Models::BrandRetrieveResponse::CacheMetadata }
 
+      # @!attribute code
+      #   HTTP status code
+      #
+      #   @return [Integer]
+      required :code, Integer
+
       # @!attribute request_id
       #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
       #   it when contacting support about a failed request.
@@ -19,17 +31,11 @@ module ContextDev
       #   @return [String]
       required :request_id, String
 
-      # @!attribute brand
-      #   Detailed brand information
-      #
-      #   @return [ContextDev::Models::BrandRetrieveResponse::Brand, nil]
-      optional :brand, -> { ContextDev::Models::BrandRetrieveResponse::Brand }
-
-      # @!attribute code
-      #   HTTP status code
+      # @!attribute status
+      #   Status of the response, e.g., 'ok'
       #
-      #   @return [Integer, nil]
-      optional :code, Integer
+      #   @return [String]
+      required :status, String
 
       # @!attribute key_metadata
       #   Credit usage, included whenever a valid API key is provided.
@@ -44,72 +50,23 @@ module ContextDev
       #   @return [Boolean, nil]
       optional :partial, ContextDev::Internal::Type::Boolean
 
-      # @!attribute status
-      #   Status of the response, e.g., 'ok'
-      #
-      #   @return [String, nil]
-      optional :status, String
-
-      # @!method initialize(cache_metadata:, request_id:, brand: nil, code: nil, key_metadata: nil, partial: nil, status: nil)
+      # @!method initialize(brand:, cache_metadata:, code:, request_id:, status:, key_metadata: nil, partial: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandRetrieveResponse} for more details.
       #
+      #   @param brand [ContextDev::Models::BrandRetrieveResponse::Brand] Detailed brand information
+      #
       #   @param cache_metadata [ContextDev::Models::BrandRetrieveResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
       #
-      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   @param code [Integer] HTTP status code
       #
-      #   @param brand [ContextDev::Models::BrandRetrieveResponse::Brand] Detailed brand information
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
       #
-      #   @param code [Integer] HTTP status code
+      #   @param status [String] Status of the response, e.g., 'ok'
       #
       #   @param key_metadata [ContextDev::Models::BrandRetrieveResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
       #   @param partial [Boolean] True when the timeout ended processing and this response contains the usable dat
-      #
-      #   @param status [String] Status of the response, e.g., 'ok'
-
-      # @see ContextDev::Models::BrandRetrieveResponse#cache_metadata
-      class CacheMetadata < ContextDev::Internal::Type::BaseModel
-        # @!attribute age_ms
-        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        #
-        #   @return [Integer]
-        required :age_ms, Integer
-
-        # @!attribute status
-        #   Whether the response was served from cache, required fresh work, or honored
-        #   zero-data-retention cache bypass.
-        #
-        #   @return [Symbol, ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status]
-        required :status, enum: -> { ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status }
-
-        # @!method initialize(age_ms:, status:)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::BrandRetrieveResponse::CacheMetadata} for more details.
-        #
-        #   Cache outcome for this response. Composite responses are hits only when every
-        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
-        #   oldest contributing hit.
-        #
-        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        #
-        #   @param status [Symbol, ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
-
-        # Whether the response was served from cache, required fresh work, or honored
-        # zero-data-retention cache bypass.
-        #
-        # @see ContextDev::Models::BrandRetrieveResponse::CacheMetadata#status
-        module Status
-          extend ContextDev::Internal::Type::Enum
-
-          HIT = :hit
-          MISS = :miss
-          ZDR = :zdr
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
 
       # @see ContextDev::Models::BrandRetrieveResponse#brand
       class Brand < ContextDev::Internal::Type::BaseModel
@@ -1190,6 +1147,49 @@ module ContextDev
         end
       end
 
+      # @see ContextDev::Models::BrandRetrieveResponse#cache_metadata
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute age_ms
+        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @return [Integer]
+        required :age_ms, Integer
+
+        # @!attribute status
+        #   Whether the response was served from cache, required fresh work, or honored
+        #   zero-data-retention cache bypass.
+        #
+        #   @return [Symbol, ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status]
+        required :status, enum: -> { ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status }
+
+        # @!method initialize(age_ms:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::BrandRetrieveResponse::CacheMetadata} for more details.
+        #
+        #   Cache outcome for this response. Composite responses are hits only when every
+        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+        #   oldest contributing hit.
+        #
+        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @param status [Symbol, ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        #
+        # @see ContextDev::Models::BrandRetrieveResponse::CacheMetadata#status
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          HIT = :hit
+          MISS = :miss
+          ZDR = :zdr
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # @see ContextDev::Models::BrandRetrieveResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed

data/lib/context_dev/models/brand_retrieve_simplified_response.rb

@@ -4,6 +4,12 @@ module ContextDev
   module Models
     # @see ContextDev::Resources::Brand#retrieve_simplified
     class BrandRetrieveSimplifiedResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute brand
+      #   Simplified brand information
+      #
+      #   @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand]
+      required :brand, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand }
+
       # @!attribute cache_metadata
       #   Cache outcome for this response. Composite responses are hits only when every
       #   cache-controlled fetch contributing to the output was a hit; age_ms is the
@@ -12,6 +18,12 @@ module ContextDev
       #   @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata]
       required :cache_metadata, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata }
 
+      # @!attribute code
+      #   HTTP status code of the response
+      #
+      #   @return [Integer]
+      required :code, Integer
+
       # @!attribute request_id
       #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
       #   it when contacting support about a failed request.
@@ -19,17 +31,11 @@ module ContextDev
       #   @return [String]
       required :request_id, String
 
-      # @!attribute brand
-      #   Simplified brand information
-      #
-      #   @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand, nil]
-      optional :brand, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand }
-
-      # @!attribute code
-      #   HTTP status code of the response
+      # @!attribute status
+      #   Status of the response, e.g., 'ok'
       #
-      #   @return [Integer, nil]
-      optional :code, Integer
+      #   @return [String]
+      required :status, String
 
       # @!attribute key_metadata
       #   Credit usage, included whenever a valid API key is provided.
@@ -44,73 +50,23 @@ module ContextDev
       #   @return [Boolean, nil]
       optional :partial, ContextDev::Internal::Type::Boolean
 
-      # @!attribute status
-      #   Status of the response, e.g., 'ok'
-      #
-      #   @return [String, nil]
-      optional :status, String
-
-      # @!method initialize(cache_metadata:, request_id:, brand: nil, code: nil, key_metadata: nil, partial: nil, status: nil)
+      # @!method initialize(brand:, cache_metadata:, code:, request_id:, status:, key_metadata: nil, partial: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandRetrieveSimplifiedResponse} for more details.
       #
+      #   @param brand [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand] Simplified brand information
+      #
       #   @param cache_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
       #
-      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   @param code [Integer] HTTP status code of the response
       #
-      #   @param brand [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand] Simplified brand information
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
       #
-      #   @param code [Integer] HTTP status code of the response
+      #   @param status [String] Status of the response, e.g., 'ok'
       #
       #   @param key_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
       #   @param partial [Boolean] True when the timeout ended processing and only completed brand data is returned
-      #
-      #   @param status [String] Status of the response, e.g., 'ok'
-
-      # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#cache_metadata
-      class CacheMetadata < ContextDev::Internal::Type::BaseModel
-        # @!attribute age_ms
-        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        #
-        #   @return [Integer]
-        required :age_ms, Integer
-
-        # @!attribute status
-        #   Whether the response was served from cache, required fresh work, or honored
-        #   zero-data-retention cache bypass.
-        #
-        #   @return [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status]
-        required :status, enum: -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status }
-
-        # @!method initialize(age_ms:, status:)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata} for more
-        #   details.
-        #
-        #   Cache outcome for this response. Composite responses are hits only when every
-        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
-        #   oldest contributing hit.
-        #
-        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        #
-        #   @param status [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
-
-        # Whether the response was served from cache, required fresh work, or honored
-        # zero-data-retention cache bypass.
-        #
-        # @see ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata#status
-        module Status
-          extend ContextDev::Internal::Type::Enum
-
-          HIT = :hit
-          MISS = :miss
-          ZDR = :zdr
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
 
       # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#brand
       class Brand < ContextDev::Internal::Type::BaseModel
@@ -415,6 +371,50 @@ module ContextDev
         end
       end
 
+      # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#cache_metadata
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute age_ms
+        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @return [Integer]
+        required :age_ms, Integer
+
+        # @!attribute status
+        #   Whether the response was served from cache, required fresh work, or honored
+        #   zero-data-retention cache bypass.
+        #
+        #   @return [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status]
+        required :status, enum: -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status }
+
+        # @!method initialize(age_ms:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata} for more
+        #   details.
+        #
+        #   Cache outcome for this response. Composite responses are hits only when every
+        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+        #   oldest contributing hit.
+        #
+        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @param status [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        #
+        # @see ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata#status
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          HIT = :hit
+          MISS = :miss
+          ZDR = :zdr
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed

data/lib/context_dev/models/web_search_response.rb

@@ -106,7 +106,8 @@ module ContextDev
 
       class Result < ContextDev::Internal::Type::BaseModel
         # @!attribute description
-        #   Snippet excerpt from the page.
+        #   Snippet excerpt from the page. Empty string when the search provider does not
+        #   supply a snippet.
         #
         #   @return [String]
         required :description, String
@@ -136,7 +137,10 @@ module ContextDev
         required :url, String
 
         # @!method initialize(description:, markdown:, relevance:, title:, url:)
-        #   @param description [String] Snippet excerpt from the page.
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebSearchResponse::Result} for more details.
+        #
+        #   @param description [String] Snippet excerpt from the page. Empty string when the search provider does not su
         #
         #   @param markdown [ContextDev::Models::WebSearchResponse::Result::Markdown] Markdown scrape status and content for this result.
         #

data/lib/context_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ContextDev
-  VERSION = "2.17.0"
+  VERSION = "2.17.1"
 end