Add ref support to Swagger::Property

MathiusD · Dec 19, 2022 · 8bc78a8 · 8bc78a8
1 parent c94b4cd
commit 8bc78a8
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 5 deletions.
diff --git a/src/swagger/builder.cr b/src/swagger/builder.cr
@@ -129,7 +129,9 @@ module Swagger
     end
 
     private def build_property(property : Property) : Objects::Property
-      if property.type == "array"
+      if ref = property.ref
+        Objects::Property.use_reference(ref)
+      elsif property.type == "array"
         if items = property.items
           if items.is_a?(String)
             prop_items = Objects::Schema.use_reference(items)

diff --git a/src/swagger/objects/property.cr b/src/swagger/objects/property.cr
@@ -2,17 +2,24 @@ module Swagger::Objects
   struct Property
     include JSON::Serializable
 
-    getter type : String
+    def self.use_reference(name : String)
+      new(ref: "#/components/schemas/#{name}")
+    end
+
+    getter type : String? = nil
     getter items : Schema? = nil
     getter description : String? = nil
     getter default : (String | Int32 | Int64 | Float64 | Bool)? = nil
     getter example : (String | Int32 | Int64 | Float64 | Bool)? = nil
     getter required : Bool? = nil
 
-    def initialize(@type : String, @description : String? = nil, @items : Schema? = nil,
+    @[JSON::Field(key: "$ref")]
+    getter ref : String? = nil
+
+    def initialize(@type : String? = nil, @description : String? = nil, @items : Schema? = nil,
                    @default : (String | Int32 | Int64 | Float64 | Bool)? = nil,
                    @example : (String | Int32 | Int64 | Float64 | Bool)? = nil,
-                   @required : Bool? = nil)
+                   @required : Bool? = nil, @ref : String? = nil,)
     end
   end
 end
diff --git a/src/swagger/property.cr b/src/swagger/property.cr
@@ -8,12 +8,13 @@ module Swagger
     property default_value
     property example
     property required
+    property ref
 
     def initialize(@name : String, @type : String = "string", @format : String? = nil,
                    @items : (Object | String)? = nil, @description : String? = nil,
                    @default_value : (String | Int32 | Int64 | Float64 | Bool)? = nil,
                    @example : (String | Int32 | Int64 | Float64 | Bool)? = nil,
-                   @required : Bool? = nil)
+                   @required : Bool? = nil, @ref : String? = nil)
     end
   end
 end