apia-open_api 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f046cce05d4154ba36e9f52227306129ef092e75061db7a522b44ade60b252c0
-  data.tar.gz: 2c56c6cedf8281819ca4c6382159183cdcc0c550d27375410f7f39cfe4bb842a
+  metadata.gz: d7c3d54619c699cf9edca73ebc76e68819c2656f0259adbd6d5e411d4e415ca6
+  data.tar.gz: f31e758e511dd57af96896cd9ca956e6455c29747fc8389d5bda59a6c5938f3d
 SHA512:
-  metadata.gz: 9c60e070b4a683379b689fff7c95ba8a7aa6ea9f2902e13b68474190b2aac234feec2428c73871591b467af2ba17be21c2dcb6d8b2297014a88e1ec783311472
-  data.tar.gz: afce3695675df681249591575c3704161caa3dd66b91a67e89bc67e58b07d45d8d6445e0080f7264c2a0fb234f1a03f87eec97aeeba22e39bf873f991b38452b
+  metadata.gz: 1f96b6eca24cc4d97d4e248892adf62bce141c4d4cce4697c8141cd1b844465d7ce9ef33036daddee81bf908dd41b4cc1bcad2b4436bc2cd1aef431e8fba8602
+  data.tar.gz: 1754bd390af23a0c88658c9a58b7c367f1743df4021a2f47c186720b3b3ff8235be743adaf62d0a3613502ae22267264f6aea71ae44ab716ba5ca8b86257345d

data/lib/apia/open_api/objects/schema.rb

@@ -40,7 +40,7 @@ module Apia
           @definition = definition
           @schema = schema
           @id = id
-          @endpoint = endpoint
+          @endpoint = endpoint # endpoint gets specified when we are dealing with a partial response
           @path = path
           @children = []
         end
@@ -130,6 +130,10 @@ module Apia
             schema[:properties][child.name.to_s] = generate_scalar_schema(child)
           end
 
+          if child.try(:null?)
+            schema[:properties][child.name.to_s][:nullable] = true
+          end
+
           if child.try(:required?)
             schema[:required] ||= []
             schema[:required] << child.name.to_s
@@ -141,7 +145,7 @@ module Apia
           schema[:type] = "object"
           schema[:properties] ||= {}
           if all_properties_included
-            schema[:properties][child.name.to_s] = generate_schema_ref(child)
+            ref = generate_schema_ref(child)
           else
             child_path = @path.nil? ? nil : @path + [child]
 
@@ -149,13 +153,16 @@ module Apia
             # very long IDs, so we truncate them to avoid hitting the 100 character
             # filename limit imposed by the rubygems gem builder.
             truncated_id = @id.match(/^(.*?)\d*?(Response|Part).*$/)[1]
-            schema[:properties][child.name.to_s] = generate_schema_ref(
+            ref = generate_schema_ref(
               child,
               id: "#{truncated_id}Part_#{child.name}".camelize,
               endpoint: @endpoint,
               path: child_path
             )
           end
+
+          # Using allOf is a workaround to allow us to set a ref as `nullable` in OpenAPI 3.0
+          schema[:properties][child.name.to_s] = { allOf: [ref] }
         end
 
       end

data/lib/apia/open_api/version.rb

@@ -3,7 +3,7 @@
 module Apia
   module OpenApi
 
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apia-open_api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Paul Sturgess
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-14 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Apia OpenAPI spec generator