grape_openapi3 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0f1cd37cbd82e6e03da9a91253742ef3ce87db8796312f1e54e3da6d6681cd7
-  data.tar.gz: 1875b127d847677e442a39031137c1aff3302f1ca3c1f5308346f90c07f8790c
+  metadata.gz: 3808df464b57163b3cf5adffec3a2b2bda782648d1ee9ad1731b5fbdf0a64fc5
+  data.tar.gz: a7687ffba660a3093fa22f318b0c586957532fe376c82fafc213e0cd1f947a11
 SHA512:
-  metadata.gz: 520dce2913d16f0b748c2cb6be734adf73dae6c0981f7639a9d3a2be4ae38355d18f4ffaaae040777a4f0cb37334dfe4d4c03476b7829e8d4744d2d61c9a267b
-  data.tar.gz: 8a043d71e49e6e40fb58e8da45378932e8a5c73bbf165c136ca03221464ceaca4e89d777538d1f5c407cc89a7f62b50096ed2c063d624db47273e2fef48ea73d
+  metadata.gz: b123656dde3a8542bad0647080a74c80d6e1a3a80efa73cfb850298ced9436776e016abcb6a94a7e67901f5b70620840171d9d54b73ae87227acbe45949d5a73
+  data.tar.gz: 4b31be25b8a836a6fbd740f66b8e74826bf6f9511e79783d5bc15cc6bbd818a8e83ae853bc88ee6bc574f208972ca6b0d120a91860ba2f9b375bc632bcadf737

data/lib/grape_openapi3/builders/operation_builder.rb

@@ -81,8 +81,13 @@ module GrapeOpenapi3
         entity = @route[:success_entity]
         return { "description" => "Success" } unless entity
 
-        # Unpack hash form: { code: 201, message: "Created", model: ProductEntity }
-        description, entity_class = unpack_success(entity)
+        # Unpack hash form: { code: 201, message: "Created", model: ProductEntity, schema: {...} }
+        description, entity_class, inline_schema = unpack_success(entity)
+
+        if inline_schema
+          media = @route[:produces].first || "application/json"
+          return { "description" => description, "content" => { media => { "schema" => inline_schema } } }
+        end
 
         unless entity_class
           return { "description" => description }
@@ -98,19 +103,20 @@ module GrapeOpenapi3
         { "description" => description, "content" => { media => { "schema" => schema } } }
       end
 
-      # Returns [description_string, entity_class_or_nil].
-      # Accepts both the bare-class form and the hash form.
+      # Returns [description_string, entity_class_or_nil, inline_schema_or_nil].
+      # Accepts the bare-class form, the hash form with :model, and the hash form with :schema.
       def unpack_success(entity)
         if entity.is_a?(Class)
-          return ["Success", entity]
+          return ["Success", entity, nil]
         end
 
-        return ["Success", nil] unless entity.is_a?(Hash)
+        return ["Success", nil, nil] unless entity.is_a?(Hash)
 
-        message = entity[:message] || entity["message"] || "Success"
-        model   = entity[:model]   || entity["model"]
-        klass   = model.is_a?(Class) ? model : nil
-        [message, klass]
+        message       = entity[:message] || entity["message"] || "Success"
+        model         = entity[:model]   || entity["model"]
+        inline_schema = entity[:schema]  || entity["schema"]
+        klass         = model.is_a?(Class) ? model : nil
+        [message, klass, inline_schema]
       end
     end
   end

data/lib/grape_openapi3/builders/parameter_builder.rb

@@ -57,6 +57,9 @@ module GrapeOpenapi3
       private
 
       def location(name, defn)
+        # Path segments are structural — they always win over any explicit hint.
+        return :path if @path_names.include?(name)
+
         explicit = defn.dig(:documentation, :param_type)&.to_s ||
                    defn.dig(:documentation, :in)&.to_s
 
@@ -68,8 +71,7 @@ module GrapeOpenapi3
         when "formData"  then return :form
         end
 
-        return :path  if @path_names.include?(name)
-        return :form  if file_type?(defn[:type])
+        return :form if file_type?(defn[:type])
         BODY_METHODS.include?(@method) ? :body : :query
       end
 
@@ -116,8 +118,9 @@ module GrapeOpenapi3
 
         params.each do |name, defn|
           schema = TypeMapper.call(defn[:type] || String)
-          schema["enum"]    = Array(defn[:values]) if defn[:values]
-          schema["default"] = defn[:default]       unless defn[:default].nil?
+          schema["enum"]     = Array(defn[:values]) if defn[:values]
+          schema["default"]  = defn[:default]       unless defn[:default].nil?
+          schema["nullable"] = true                 unless defn[:required]
 
           desc = defn[:desc] || defn[:description]
           schema["description"] = desc.to_s if desc

data/lib/grape_openapi3/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrapeOpenapi3
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape_openapi3
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - rodrigonbarreto