bullet_train-api 1.6.26 → 1.6.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80f53bd14ce32fe54b5dde95fa14aa33fadbc9849f786a72b4ab714ad06a4c59
-  data.tar.gz: 40c98339cd1c7823b81d730101cc136e4cc2886857671ce3754732bb376bc566
+  metadata.gz: e8773d252b03c1ebb3342c9ee21e302f2b7bd2e6732da748c407f7e0796002c1
+  data.tar.gz: f7581ce2bc65fd5cd1f49324ddddb8b5936e1ee88bd431063cc82c253acc1c1f
 SHA512:
-  metadata.gz: 4d7aa0e7721fabfcd492edcbaf4ea00455038ddd55d2bb4117404e90129a447c2f14cc137760d11d7bfb78103bc242bed5d2ac161babc8a94772a9e3045e7c62
-  data.tar.gz: a3c4a43aff5bdaf0b6d07f7c7575394b47113dbe14dac87564d47da0f2cda2d16a07b0a13369820d618005f649d048c76420f988734351d14523ea81c1104327
+  metadata.gz: b64ba34512b1443e2a4d314c63aa691d700d20f398f6eb3fafbe397dba225f8c4415564d5a57f990ed9146183ff7c1814104b78b14fdb862da8469216d4e2322
+  data.tar.gz: 037ed5525018b8f23bc94cc737f1142991dbf3697c1501100e4361113a0db619b73550a5415db2845fb01b884af58ae4a688fbcc8d4c4e91008edda69237d1e7

data/app/helpers/api/open_api_helper.rb

@@ -47,7 +47,9 @@ module Api
       indent(output, 1)
     end
 
-    def automatic_components_for(model, locals: {})
+    def automatic_components_for(model, **options)
+      locals = options.delete(:locals) || {}
+
       path = "app/views/api/#{@version}"
       paths = [path, "app/views"] + gem_paths.product(%W[/#{path} /app/views]).map(&:join)
 
@@ -76,6 +78,9 @@ module Api
 
       attributes_output = JSON.parse(schema_json)
 
+      # Allow customization of Attributes
+      customize_component!(attributes_output, options[:attributes]) if options[:attributes]
+
       # Add "Attributes" part to $ref's
       update_ref_values!(attributes_output)
 
@@ -106,6 +111,9 @@ module Api
         parameters_output["properties"].select! { |key| strong_parameter_keys.include?(key.to_sym) }
         parameters_output["example"]&.select! { |key, value| strong_parameter_keys.include?(key.to_sym) && value.present? }
 
+        # Allow customization of Parameters
+        customize_component!(parameters_output, options[:parameters]) if options[:parameters]
+
         (
           indent(attributes_output.to_yaml.gsub("---", "#{model.name.gsub("::", "")}Attributes:"), 3) +
             indent("    " + parameters_output.to_yaml.gsub("---", "#{model.name.gsub("::", "")}Parameters:"), 3)
@@ -164,5 +172,41 @@ module Api
         end
       end
     end
+
+    def customize_component!(original, custom)
+      custom = custom.deep_stringify_keys.deep_transform_values { |v| v.is_a?(Symbol) ? v.to_s : v }
+
+      if custom.key?("add")
+        custom["add"].each do |property, details|
+          if details["required"]
+            original["required"] << property
+            details.delete("required")
+          end
+          original["properties"][property] = details
+          if details["example"]
+            original["example"][property] = details["example"]
+            details.delete("example")
+          end
+        end
+      end
+
+      if custom.key?("remove")
+        Array(custom["remove"]).each do |property|
+          original["required"].delete(property)
+          original["properties"].delete(property)
+          original["example"].delete(property)
+        end
+      end
+
+      if custom.key?("only")
+        original["properties"].keys.each do |property|
+          unless Array(custom["only"]).include?(property)
+            original["properties"].delete(property)
+            original["required"].delete(property)
+            original["example"].delete(property)
+          end
+        end
+      end
+    end
   end
 end

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.6.26"
+    VERSION = "1.6.27"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-api
 version: !ruby/object:Gem::Version
-  version: 1.6.26
+  version: 1.6.27
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-18 00:00:00.000000000 Z
+date: 2024-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -261,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Bullet Train API