apiculture 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d78cc86595f72f0ec4ea08adaa5b545798eb54653aafedb47d3e6923351b3b76
-  data.tar.gz: 532aa3794d65dfd962d4d5984a29678e026b5da43efd1f5ad5dbaea4d4ee6ff1
+  metadata.gz: bd3d6da6eca1e6a1c63d824bfbed2d43d2a74032f966dc6f17df09c6458548c8
+  data.tar.gz: 53581729f4b81574b5bc400786509cfa6f9364fde56486611ae8eab8c3370f8e
 SHA512:
-  metadata.gz: b351b52e4a10c1c7ee2b7d4f7b5c8f63d4ed8b28f65348ebf63ec0f064ccb55b9bfd6cad6f21d49c34867436dfc50036e67f4d8fdb206f3525581346ee7db3a8
-  data.tar.gz: 9a0d97711023461335d4237f44e077daf2b1669c9509bb53dcd79571fb8a157188fb06b9d93db28ab9df69f170d152c50746ce8c27f73eb2af7781963d8e26bf
+  metadata.gz: c2f325148ce9a454206d278f665b583fbd896b442d5f07eecfef481a43143299001c3097eceaf37e2d61866f8f06e5523677ffcad031a9a5811419ce7f84ee9e
+  data.tar.gz: 97159d92a46fef3e7c093c87ce4b80e783a4610c073857f80c74205ddfcabc7d6b019d3d29b1b2a66d5fd2a6fff92a2fef9f2d3c910dc62478613d42e692dabe

data/CHANGELOG.md

@@ -1,3 +1,7 @@
 ## 0.2.0
 * Add ruby 3 support
 * Bump `mustermann` dependency to '~> 3'
+
+
+## 0.2.1
+* Add support for nested fields

data/lib/apiculture/openapi_documentation.rb

@@ -8,9 +8,9 @@ module OpenApiDocumentation
       @paths = chunks.select { |chunk| chunk.respond_to?(:http_verb) }
       @data = {
         openapi: '3.0.0',
-        info: { 
-          title: @app.to_s, 
-          version: '0.0.1', 
+        info: {
+          title: @app.to_s,
+          version: '0.0.1',
           description: @app.to_s + " " + chunks.select { |chunk| chunk.respond_to?(:to_markdown) }.map(&:to_markdown).join("\n")
         },
         tags: []
@@ -27,7 +27,7 @@ module OpenApiDocumentation
     end
 
     def spec
-      @data      
+      @data
     end
 
     private
@@ -137,7 +137,7 @@ module OpenApiDocumentation
 
     def build_request_body
       return nil if VERBS_WITHOUT_BODY.include?(@path.http_verb)
-      
+
       body_params = Hash[ @path.parameters.collect do |parameter|
         [parameter.name, {
           type: Util.map_type(parameter.matchable),
@@ -171,7 +171,7 @@ module OpenApiDocumentation
         unless response.jsonable_object_example.nil? || response.jsonable_object_example.empty?
           _response[:content] = {
             'application/json': {
-                schema: 
+                schema:
                   { type: 'object',
                   properties: Util.response_to_schema(response.jsonable_object_example) }
             }
@@ -198,15 +198,27 @@ module OpenApiDocumentation
     }.freeze
 
     def self.response_to_schema(response)
-      schema = {}
-      return nil if response.nil? || response.empty? || response.class == String
-      response.each do |key, value|
-        schema[key] = {
-          type: 'string',
-          example: value.to_s
-        }
+      case response
+      when NilClass
+      when String
+        { type: 'string', example: response }
+      when Integer
+        { type: 'integer', example: response }
+      when Float
+        { type: 'float', example: response }
+      when Array
+        if response.empty?
+          { type: 'array', items: {} }
+        else
+          { type: 'array', items: response.map { |elem| response_to_schema(elem) } }
+        end
+      when Hash
+        response.each_with_object({}) do |(key, val), schema_hash|
+          schema_hash[key] = response_to_schema(val)
+        end
+      else
+        { type: response.class.name.downcase, example: response.to_s }
       end
-      schema
     end
 
     def self.map_type(type)

data/lib/apiculture/version.rb

@@ -1,3 +1,3 @@
 module Apiculture
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apiculture
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-08 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -216,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Sweet API sauce on top of Rack