bullet_train-api 1.6.25 → 1.6.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b74d7978ed040fb1ff9fb993a9ef20681be77615016c9e206b0d553ccfd3328f
-  data.tar.gz: e69b03ab081484af08ff01de050836a048255118404500bf7bbc60fe81a43215
+  metadata.gz: e8773d252b03c1ebb3342c9ee21e302f2b7bd2e6732da748c407f7e0796002c1
+  data.tar.gz: f7581ce2bc65fd5cd1f49324ddddb8b5936e1ee88bd431063cc82c253acc1c1f
 SHA512:
-  metadata.gz: 71c42eac7d429cc9092d29fec72c778d790dcc8e66aa8b83af68fa4e601ced8b0ffd22a2265d376a5cde37fb200c0a0178ec29ecb31f59c5b54884cb7afd1a55
-  data.tar.gz: f5163efb4b5e5652882c3f92d26a565703b6cfabfd638bb47a2d50e31abd645264b60e1714780ece604f9d0a912777817272fbf7c9827442c42d8c69017a7637
+  metadata.gz: b64ba34512b1443e2a4d314c63aa691d700d20f398f6eb3fafbe397dba225f8c4415564d5a57f990ed9146183ff7c1814104b78b14fdb862da8469216d4e2322
+  data.tar.gz: 037ed5525018b8f23bc94cc737f1142991dbf3697c1501100e4361113a0db619b73550a5415db2845fb01b884af58ae4a688fbcc8d4c4e91008edda69237d1e7

data/app/helpers/api/open_api_helper.rb

@@ -24,7 +24,7 @@ module Api
     end
 
     def automatic_paths_for(model, parent, except: [])
-      output = render("api/#{@version}/open_api/shared/paths", except: except)
+      output = render("api/#{@version}/open_api/shared/paths", model_name: model.model_name.collection, except: except)
       output = Scaffolding::Transformer.new(model.name, [parent&.name]).transform_string(output).html_safe
 
       custom_actions_file_path = "api/#{@version}/open_api/#{model.model_name.collection}/paths"
@@ -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/app/views/api/v1/open_api/invitations/_paths.yaml.erb

@@ -3,6 +3,7 @@
     tags:
       - Invitation
     summary: "Resend Invitation"
+    description: "Resend an Invitation"
     operationId: resendInvitation
     parameters:
       - $ref: "#/components/parameters/id"

data/app/views/api/v1/open_api/shared/_paths.yaml.erb

@@ -5,7 +5,8 @@
   get:
     tags:
       - Scaffolding::CompletelyConcrete::TangibleThing
-    summary: "List Tangible Things"
+    summary: <%= I18n.t("#{model_name}.api.paths.index.summary", default: "List Tangible Things") %>
+    description: <%= I18n.t("#{model_name}.api.paths.index.description", default: "List Tangible Things") %>
     operationId: listScaffoldingCompletelyConcreteTangibleThings
     parameters:
       - name: absolutely_abstract_creative_concept_id
@@ -37,7 +38,8 @@
   post:
     tags:
       - Scaffolding::CompletelyConcrete::TangibleThing
-    summary: "Create Tangible Thing"
+    summary: <%= I18n.t("#{model_name}.api.paths.create.summary", default: "Create Tangible Thing") %>
+    description: <%= I18n.t("#{model_name}.api.paths.create.description", default: "Create Tangible Thing") %>
     operationId: createScaffoldingCompletelyConcreteTangibleThings
     parameters:
       - name: absolutely_abstract_creative_concept_id
@@ -77,7 +79,8 @@
   get:
     tags:
       - Scaffolding::CompletelyConcrete::TangibleThing
-    summary: "Fetch Tangible Thing"
+    summary: <%= I18n.t("#{model_name}.api.paths.show.summary", default: "Fetch Tangible Thing") %>
+    description: <%= I18n.t("#{model_name}.api.paths.show.description", default: "Fetch Tangible Thing") %>
     operationId: getScaffoldingCompletelyConcreteTangibleThings
     parameters:
       - $ref: "#/components/parameters/id"
@@ -97,7 +100,8 @@
   put:
     tags:
       - Scaffolding::CompletelyConcrete::TangibleThing
-    summary: "Update Tangible Thing"
+    summary: <%= I18n.t("#{model_name}.api.paths.update.summary", default: "Update Tangible Thing") %>
+    description: <%= I18n.t("#{model_name}.api.paths.update.description", default: "Update Tangible Thing") %>
     operationId: updateScaffoldingCompletelyConcreteTangibleThings
     parameters:
       - $ref: "#/components/parameters/id"
@@ -130,7 +134,8 @@
   delete:
     tags:
       - Scaffolding::CompletelyConcrete::TangibleThing
-    summary: "Remove Tangible Thing"
+    summary: <%= I18n.t("#{model_name}.api.paths.index.summary", default: "List Tangible Things") %>
+    description: <%= I18n.t("#{model_name}.api.paths.index.description", default: "List Tangible Things") %>
     operationId: removeScaffoldingCompletelyConcreteTangibleThings
     parameters:
       - $ref: "#/components/parameters/id"

data/app/views/api/v1/open_api/teams/_paths.yaml.erb

@@ -3,6 +3,7 @@
     tags:
       - Team
     summary: "List Teams"
+    description: "List all Teams"
     operationId: listTeams
     parameters:
       - $ref: "#/components/parameters/after"
@@ -30,6 +31,7 @@
     tags:
       - Team
     summary: "Fetch Team"
+    description: "Fetch a single Team"
     operationId: fetchTeam
     parameters:
       - $ref: "#/components/parameters/id"
@@ -48,6 +50,7 @@
     tags:
       - Team
     summary: "Update Team"
+    description: "Update a single Team"
     operationId: updateTeam
     parameters:
       - $ref: "#/components/parameters/id"

data/app/views/api/v1/open_api/users/_paths.yaml.erb

@@ -3,6 +3,7 @@
     tags:
       - User
     summary: "List Users"
+    description: "List all Users"
     operationId: listUsers
     parameters:
       - $ref: "#/components/parameters/after"
@@ -29,6 +30,7 @@
     tags:
       - User
     summary: "Fetch User"
+    description: "Fetch a single User"
     operationId: fetchUser
     parameters:
       - $ref: "#/components/parameters/id"
@@ -47,6 +49,7 @@
     tags:
       - User
     summary: "Update User"
+    description: "Update a single User"
     operationId: updateUser
     parameters:
       - $ref: "#/components/parameters/id"

data/lib/bullet_train/api/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Api
-    VERSION = "1.6.25"
+    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.25
+  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