docs(overrides-synonyms): add yardoc for legacy collection-scoped override and synonym methods

Author: tharropoulos

lib/typesense/override.rb

@@ -8,10 +8,22 @@ def initialize(collection_name, override_id, api_call)
       @api_call        = api_call
     end
 
+    # Retrieve an override (curation rule) by ID on this collection.
+    #
+    # @example
+    #   client.collections['products'].overrides['promote-hat'].retrieve
+    #
+    # @see https://typesense.org/docs/latest/api/curation.html
     def retrieve
       @api_call.get(endpoint_path)
     end
 
+    # Delete an override (curation rule) by ID on this collection.
+    #
+    # @example
+    #   client.collections['products'].overrides['promote-hat'].delete
+    #
+    # @see https://typesense.org/docs/latest/api/curation.html
     def delete
       @api_call.delete(endpoint_path)
     end

lib/typesense/overrides.rb

@@ -10,14 +10,34 @@ def initialize(collection_name, api_call)
       @overrides       = {}
     end
 
+    # Create or update an override (curation rule) on this collection.
+    #
+    # @example
+    #   client.collections['products'].overrides.upsert('promote-hat', 'rule' => { 'query' => 'hat', 'match' => 'exact' }, 'includes' => [])
+    #
+    # @see https://typesense.org/docs/latest/api/curation.html
     def upsert(override_id, params)
       @api_call.put(endpoint_path(override_id), params)
     end
 
+    # Retrieve all overrides (curation rules) on this collection.
+    #
+    # @example
+    #   client.collections['products'].overrides.retrieve
+    #
+    # @see https://typesense.org/docs/latest/api/curation.html
     def retrieve
       @api_call.get(endpoint_path)
     end
 
+    # Access an individual override by ID within this collection.
+    #
+    # @example
+    #   client.collections['products'].overrides['promote-hat'].retrieve
+    #
+    # @see https://typesense.org/docs/latest/api/curation.html
+    #
+    # @return [Override]
     def [](override_id)
       @overrides[override_id] ||= Override.new(@collection_name, override_id, @api_call)
     end

lib/typesense/synonym.rb

@@ -1,17 +1,30 @@
 # frozen_string_literal: true
 
 module Typesense
+  # @deprecated Deprecated starting with Typesense Server v30. Please migrate to `client.synonym_sets` (new Synonym Sets APIs).
   class Synonym
     def initialize(collection_name, synonym_id, api_call)
       @collection_name = collection_name
       @synonym_id = synonym_id
       @api_call = api_call
     end
 
+    # Retrieve a synonym (legacy v1) by ID on this collection.
+    #
+    # @example
+    #   client.collections['products'].synonyms['syn-1'].retrieve
+    #
+    # @see https://typesense.org/docs/29.0/api/synonyms.html
     def retrieve
       @api_call.get(endpoint_path)
     end
 
+    # Delete a synonym (legacy v1) by ID on this collection.
+    #
+    # @example
+    #   client.collections['products'].synonyms['syn-1'].delete
+    #
+    # @see https://typesense.org/docs/29.0/api/synonyms.html
     def delete
       @api_call.delete(endpoint_path)
     end

lib/typesense/synonyms.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Typesense
+  # @deprecated Deprecated starting with Typesense Server v30. Please migrate to `client.synonym_sets` (new Synonym Sets APIs).
   class Synonyms
     RESOURCE_PATH = '/synonyms'
 
@@ -10,14 +11,34 @@ def initialize(collection_name, api_call)
       @synonyms = {}
     end
 
+    # Create or update a synonym (legacy v1) on this collection.
+    #
+    # @example
+    #   client.collections['products'].synonyms.upsert('syn-1', 'synonyms' => ['nyc', 'new york'])
+    #
+    # @see https://typesense.org/docs/29.0/api/synonyms.html
     def upsert(synonym_id, params)
       @api_call.put(endpoint_path(synonym_id), params)
     end
 
+    # Retrieve all synonyms (legacy v1) on this collection.
+    #
+    # @example
+    #   client.collections['products'].synonyms.retrieve
+    #
+    # @see https://typesense.org/docs/29.0/api/synonyms.html
     def retrieve
       @api_call.get(endpoint_path)
     end
 
+    # Access an individual synonym by ID within this collection.
+    #
+    # @example
+    #   client.collections['products'].synonyms['syn-1'].retrieve
+    #
+    # @see https://typesense.org/docs/29.0/api/synonyms.html
+    #
+    # @return [Synonym]
     def [](synonym_id)
       @synonyms[synonym_id] ||= Synonym.new(@collection_name, synonym_id, @api_call)
     end