bullet_train-api 1.7.11 → 1.7.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aef8c20ab58036263c4aedee16b5957f9794f6db67388b88f308ad2de6eddcd2
-  data.tar.gz: c97837332c5bf099547093477248223dd5efecc9dfe6327b10e27173bff8b981
+  metadata.gz: 814023b96db3c4fcc1a581825dd6c0a02858553162a36f3aa40851418ee305d6
+  data.tar.gz: 138b17de8d7900426fa5bdc94d78ec61c2376a2fa93b64321bd9f816ee4feb56
 SHA512:
-  metadata.gz: f7b9c1c254e7425b2a5a48b1badf2a6b22667b4724e761291ee4a577bd048b3bfe3663864eb0a34bf653d54a4c741f044f1d6ac7a44e8b8d581e6303f082f6dc
-  data.tar.gz: 81ff21bf84669a24a2972fcc6b6441661c18e3074b31f1c94945572b4e34dfe4923ef21985b3adaa5e1c5bdc70353d82567853e1da03f49da8c22a2053eeda55
+  metadata.gz: 6abf9d886f960bd4c5176b28a4de09865a54d016389854418a578ae2769fae463fe22700038818776bedfdb8a41a799c09b015f88446ccfc08c879fc18eacc67
+  data.tar.gz: caf5cc34915ad55ccc79c7d8fe48946c402d3dfdb5bb3339fd2eb01d196115013ba6b3911b54bd1a1652f66ed0a78b32c3264701ec7eff9554af52c9b5a8142e

data/README.md

@@ -208,6 +208,10 @@ If the methods defined in the `automatic_paths_for` for the endpoints support
 a write action (i.e. create or update), then doc generation uses the `strong_parameters`
 defined in the corresponding controller to generate the Parameters section in the schema.
 
+If your endpoint accepts different parameters for the create and update actions, if you define `<model>_update_params` in the
+corresponding controller to define the update parameters, these will be used to generate the Parameter for the
+update method in the schema.
+
 Automatic paths are generated for basic REST actions. You can customize those paths or add your own by creating a
 file at `app/views/api/<version>/open_api/<Model.underscore.plural>/_paths.yaml.erb`. For REST paths there's no need to
 duplicate all the schema, you can specify only what differs from auto-generated code.

data/app/helpers/api/open_api_helper.rb

@@ -65,8 +65,10 @@ module Api
 
       factory_path = "test/factories/#{model.model_name.collection}.rb"
       cache_key = [:example, model.model_name.param_key, File.ctime(factory_path)]
-      example = Rails.cache.fetch(cache_key) do
+      example = if model.name.constantize.singleton_methods.any?
         FactoryBot.example(model.model_name.param_key.to_sym)
+      else
+        Rails.cache.fetch(cache_key) { FactoryBot.example(model.model_name.param_key.to_sym) }
       end
 
       schema_json = jbuilder.json(
@@ -101,10 +103,11 @@ module Api
 
       if has_strong_parameters?("Api::#{@version.upcase}::#{model.name.pluralize}Controller".constantize)
         strong_parameter_keys = strong_parameter_keys_for(model.name, @version)
+        strong_parameter_keys_for_update = strong_parameter_keys_for(model.name, @version, "update")
 
         # Create separate parameter schema for create and update methods
         create_parameters_output = process_strong_parameters(model, strong_parameter_keys, schema_json, "create", **options)
-        update_parameters_output = process_strong_parameters(model, strong_parameter_keys, schema_json, "update", **options)
+        update_parameters_output = process_strong_parameters(model, strong_parameter_keys_for_update, schema_json, "update", **options)
 
         # We need to skip TeamParameters, UserParameters & InvitationParametersUpdate as they are not present in
         # the bullet train api schema
@@ -144,10 +147,10 @@ module Api
       parameters_output
     end
 
-    def strong_parameter_keys_for(model_name, version)
+    def strong_parameter_keys_for(model_name, version, method_type = "create")
       strong_params_module = "::Api::#{version.upcase}::#{model_name.pluralize}Controller::StrongParameters".constantize
       strong_params_reporter = BulletTrain::Api::StrongParametersReporter.new(model_name.constantize, strong_params_module)
-      strong_parameter_keys = strong_params_reporter.report
+      strong_parameter_keys = strong_params_reporter.report(method_type)
 
       if strong_parameter_keys.last.is_a?(Hash)
         strong_parameter_keys += strong_parameter_keys.pop.keys

data/lib/bullet_train/api/example_bot.rb

@@ -66,13 +66,23 @@ module FactoryBot
       model_name = ActiveRecord::Base.descendants.find { |klass| klass.model_name.param_key == model.to_s }&.model_name
       factory_path = "test/factories/#{model_name.collection}.rb"
 
+      model_class = model_name.name.constantize
+
       if count > 1
         cache_key = [:example_list, model_name.param_key, File.ctime(factory_path)]
-        values = Rails.cache.fetch(cache_key) { FactoryBot.example_list(model, count) }
+        values = if model_class.singleton_methods.any?
+          FactoryBot.example_list(model, count)
+        else
+          Rails.cache.fetch(cache_key) { FactoryBot.example_list(model, count) }
+        end
         var_name = model_name.element.pluralize
       else
         cache_key = [:example, model_name.param_key, File.ctime(factory_path)]
-        values = Rails.cache.fetch(cache_key) { FactoryBot.example(model) }
+        values = if model_class.singleton_methods.any?
+          FactoryBot.example(model)
+        else
+          Rails.cache.fetch(cache_key) { FactoryBot.example(model) }
+        end
         var_name = model_name.element
       end
 

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.7.11"
+    VERSION = "1.7.12"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.7.11
+  version: 1.7.12
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-05 00:00:00.000000000 Z
+date: 2024-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard