swagger_yard 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83e1c4a1e03bfda00de8186e1c4ff6295cd80cc48d1053cd50f7f334ffe328fb
-  data.tar.gz: f0c8fd6215987665d201f921ccc4421a4f623c4c527867b01328f3279147b123
+  metadata.gz: 503b5e749f9f3e40431798185264f5d830923d1117eaf19e53ffa4069b4db54e
+  data.tar.gz: 748debe18cb7958200d2e690ab7b6e0b36ef153bfcdb48c5283bb0687ba57246
 SHA512:
-  metadata.gz: 8589dd0a10c513d877c27efcae067cebc61fcc7855c2a12c0a85c84db42007e63860f284afce8b63e7afb3f3372a1c035c806eb98d004a3ac9284c32b07324ff
-  data.tar.gz: 3d9d1203cea5812416f6838207e3f114f009653d8e1f787baea890260180652d5f337ce2cf6dcadb213a58e0503a674098fad98c841b41ecf366db08b5bfb8eb
+  metadata.gz: ace4ee34ecfa50bb06376789fed0770f52c7c58367452db1f701a69a29564c2a609c5d07b51d571c796f5820a80453f0382b81821bcb525bfa48cdf707195599
+  data.tar.gz: e7aa50665d8d8ef371414e885bce55986819be74fe782e4576b8d1c129539f7638c6c3767f85d56ec3ff8919c4d45d42d8162ae162514723b02de60d46e39614

data/README.md

@@ -1,4 +1,4 @@
-# SwaggerYard [![Build Status](https://travis-ci.org/livingsocial/swagger_yard.svg?branch=master)](https://travis-ci.org/livingsocial/swagger_yard) #
+# SwaggerYard [![Build Status](https://github.com/livingsocial/swagger_yard/actions/workflows/rspec.yml/badge.svg)](https://github.com/livingsocial/swagger_yard/actions/workflows/rspec.yml)
 
 SwaggerYard is a gem to convert custom YARD tags in comments into Swagger 2.0 or OpenAPI 3.0.0 specs.
 
@@ -32,6 +32,11 @@ Place configuration in a Rails initializer or suitable configuration file:
 
       # Where to find models (can be an array)
       config.model_path = ::Rails.root + 'app/decorators/**/*'
+
+      # Whether to include controller methods marked as private
+	  # (either with ruby `private` or YARD `# @visibility private`
+	  # Default: true
+	  config.include_private = true
     end
 
 Then start to annotate controllers and models as described below.
@@ -41,6 +46,9 @@ Then start to annotate controllers and models as described below.
 To generate a Swagger or OpenAPI specification, use one of the `SwaggerYard::Swagger` or `SwaggerYard::OpenAPI` classes as follows in a script or Rake task (or use [swagger_yard-rails](/livingsocial/swagger_yard-rails)):
 
 ```
+# Register the yard tags
+SwaggerYard.register_custom_yard_tags!
+
 spec = SwaggerYard::OpenAPI.new
 # Generate YAML
 File.open("openapi.yml", "w") { |f| f << YAML.dump(spec.to_h) }
@@ -105,9 +113,21 @@ class Accounts::OwnershipsController < ActionController::Base
 end
 ```
 
+#### Private controllers/actions
+
+When you set `include_private = false` in the SwaggerYard configuration, you can mark action methods as private, so that they won't be documented, using `@visibility private` in comments.
+
+```ruby
+  ##
+  # @visibility private
+  def show
+  end
+```
+
+
 ### Model ###
 
-Each model to be exposed in the specification must have a `@model` tag. Model properties are specified with `@property` tags.
+Each model to be exposed in the specification must have a `@model` tag. Model properties are specified with `@property` tags. JSON Schema `additionalProperties` can be specified with `@additional_properties <type>` where `<type>` is any type defined elsewhere, or simply `false` to denote a closed model (`additionalProperties: false`).
 
 ```ruby
 #
@@ -117,6 +137,7 @@ Each model to be exposed in the specification must have a `@model` tag. Model pr
 # @property name  [Array<string>]    the names for the pet
 # @property age   [integer]   the age of the pet
 # @property relatives(required) [Array<Pet>] other Pets in its family
+# @additional_properties string
 #
 class Pet
 end
@@ -172,10 +193,13 @@ Types of things (parameters or responses of an operation, properties of a model)
 - Basic types (integer, boolean, string, object, number, date, time, date-time, uuid, etc.) should be lowercased.
 - An array of models or basic types is specified with `[array<...>]`.
 - An enum of allowed string values is specified with `[enum<one,two,three>]`.
+- An enum of allowed values that are defined in the application `[enum<{CURRENCIES}>]`.
 - An object definition can include the property definitions of its fields, and / or of an additional property for any remaining allowed fields. E.g., `[object<name: string, age: integer,  string >]`
 - Structured data like objects, arrays, pairs, etc., definitions can also be nested; E.g., `[object<pairs:array<object<right:integer,left:integer>>>]`
 - JSON-Schema `format` attributes can be specified for basic types using `<...>`. For example, `[integer<int64>]` produces JSON `{ "type": "integer", "format": "int64" }`.
 - Regex pattern constraints can be specified for strings using `[regex<PATTERN>]`. For example, `[regex<^.{3}$>]` produces JSON `{ "type": "string", "pattern": "^.{3}$" }`.
+- A union of two or more sub-types is expressed as `(A | B)` (parentheses required). This translates to `oneOf:` in JSON Schema.
+- An intersection of two or more sub-types is expressed as `(A & B)` (parentheses required). This translates to `allOf:` in JSON Schema.
 
 ### Options ###
 
@@ -258,6 +282,24 @@ class Person
 end
 ```
 
+### Standalone Model ###
+
+Types can be specified without being associated to an existing model with the `@!model` directive. It is useful when documenting a create and an update of the same class:
+
+```ruby
+# @!model CreatePet
+# @property id(required)    [integer]
+# @property name(required)  [string]
+#
+# @!model UpdatePet
+# @property id(required)    [integer]
+# @property name            [string]
+```
+
+It can also be needed when the body parameter of a path is not totally matching a model.
+
+Note that a model name must be given to the directive.
+
 
 ### External Schema ###
 

data/lib/swagger_yard/api_group.rb

@@ -49,6 +49,8 @@ module SwaggerYard
     end
 
     def add_yard_object(yard_object)
+      return self if yard_object.visibility == :private && !SwaggerYard.config.include_private
+
       case yard_object.type
       when :class # controller
         add_info(yard_object)

data/lib/swagger_yard/configuration.rb

@@ -6,6 +6,7 @@ module SwaggerYard
     attr_accessor :controller_path, :model_path
     attr_accessor :path_discovery_function
     attr_accessor :security_definitions
+    attr_accessor :include_private
 
     # openapi-compatible names
     alias openapi_version swagger_version
@@ -20,6 +21,7 @@ module SwaggerYard
       @description = "Configure description with SwaggerYard.config.description"
       @security_definitions = {}
       @external_schema = {}
+      @include_private = true
     end
 
     def external_schema(mappings = nil)

data/lib/swagger_yard/directives.rb

@@ -0,0 +1,32 @@
+module SwaggerYard::Directives
+  
+  # A directive used to create a model tag with a dummy class.
+  # based on https://github.com/lsegal/yard/blob/master/lib/yard/tags/directives.rb#L361
+  class ParamClassDirective < YARD::Tags::Directive
+
+    def call; end
+
+    def after_parse
+      return unless handler
+
+      create_object
+    end
+
+    def create_object
+      name = tag.name
+      obj = YARD::CodeObjects::ClassObject.new(handler.namespace, tag.name)
+      handler.register_file_info(obj)
+      handler.register_source(obj)
+      handler.register_group(obj)
+      obj.docstring = YARD::Docstring.new!(parser.text,
+                                           parser.tags,
+                                           obj,
+                                           nil,
+                                           parser.reference)
+      obj.add_tag(YARD::Tags::Tag.new(:model, name))
+      parser.object = obj
+      parser.post_process
+      obj
+    end
+  end
+end

data/lib/swagger_yard/model.rb

@@ -5,7 +5,8 @@ module SwaggerYard
   #
   class Model
     include Example
-    attr_reader :id, :discriminator, :inherits, :description, :properties
+    attr_reader :id, :discriminator, :inherits,
+      :description, :properties, :additional_properties
 
     def self.from_yard_object(yard_object)
       new.tap do |model|
@@ -41,7 +42,7 @@ module SwaggerYard
       properties.detect {|prop| prop.name == key }
     end
 
-    TAG_ORDER = %w(model inherits discriminator property example)
+    TAG_ORDER = %w(model inherits discriminator property example additional_properties)
 
     def parse_tags(tags)
       sorted_tags = tags.each_with_index.sort_by { |t,i|
@@ -72,6 +73,8 @@ module SwaggerYard
           else
             self.example = tag.text
           end
+        when "additional_properties"
+          @additional_properties = Type.new(tag.text).schema
         end
       end
 

data/lib/swagger_yard/swagger.rb

@@ -158,6 +158,7 @@ module SwaggerYard
 
       h["example"] = mod.example if mod.example
 
+      h["additionalProperties"] = mod.additional_properties if !mod.additional_properties.nil?
       h
     end
 

data/lib/swagger_yard/type_parser.rb

@@ -24,12 +24,16 @@ module SwaggerYard
 
       rule(:identifier) { name >> (str('::') >> name).repeat }
 
+      rule(:constant)   { spaced('{') >> identifier.as(:constant) >> spaced('}') }
+
       rule(:external_identifier) { name.as(:namespace) >> str('#') >> identifier.as(:identifier) }
 
+      rule(:_false)      { str('false').as(:false) }
+
       rule(:regexp)     { stri('regex') >> match['Pp'].maybe >> space >>
                           str('<') >> (str('\\\\') | str('\\>') | match['[^>]']).repeat.as(:regexp) >> str('>') }
 
-      rule(:enum_list)  { name.as(:value) >> (spaced(',') >> name.as(:value)).repeat }
+      rule(:enum_list)  { (name.as(:value) | constant) >> (spaced(',') >> (name.as(:value) | constant)).repeat }
 
       rule(:enum)       { stri('enum') >> spaced('<') >> enum_list >> spaced('>') }
 
@@ -43,10 +47,17 @@ module SwaggerYard
 
       rule(:formatted)  { name.as(:name) >> spaced('<') >> name.as(:format) >> spaced('>') }
 
+      rule(:union)      { spaced('(') >> type >> (spaced('|') >> type).repeat >> spaced(')') }
+
+      rule(:intersect)  { spaced('(') >> type >> (spaced('&') >> type).repeat >> spaced(')') }
+
       rule(:type)       { enum.as(:enum) |
                           array.as(:array) |
                           object.as(:object) |
                           formatted.as(:formatted) |
+                          union.as(:union) |
+                          intersect.as(:intersect) |
+                          _false |
                           external_identifier.as(:external_identifier) |
                           identifier.as(:identifier) |
                           regexp }
@@ -76,17 +87,16 @@ module SwaggerYard
         end
       end
 
+      rule(constant: simple(:constant)) do
+        constant.to_s.constantize
+      rescue NameError => e
+        raise UnknownConstant, e.message
+      end
+
       rule(external_identifier: { namespace: simple(:namespace), identifier: simple(:identifier) }) do
-        prefix, name = namespace.to_s, identifier.to_s
-        unless url = SwaggerYard.config.external_schema[prefix]
-          raise UndefinedSchemaError, "unknown prefix #{prefix} for #{name}"
-        end
-        uri = URI(url)
-        fragment = uri.fragment ? "##{uri.fragment}" : model_path
-        uri.fragment = nil
-        fragment += '/' unless fragment.end_with?('/')
-        url = uri.to_s
-        { '$ref' => "#{url}#{fragment}#{Model.mangle(name)}"}
+        prefix, name  = namespace.to_s, identifier.to_s
+        url, fragment = resolve_uri.call(name, prefix)
+        { '$ref' => "#{url}#{fragment}#{Model.mangle(name)}" }
       end
 
       rule(formatted: { name: simple(:name), format: simple(:format) }) do
@@ -99,8 +109,10 @@ module SwaggerYard
 
       rule(value: simple(:value)) { value.to_s }
 
+      rule(false: simple(:false)) { false }
+
       rule(enum: subtree(:values)) do
-        { 'type' => 'string', 'enum' => Array(values) }
+        { 'type' => 'string', 'enum' => Array(values).flatten }
       end
 
       rule(array: subtree(:type)) do
@@ -125,6 +137,14 @@ module SwaggerYard
           result.update additional.first unless additional.empty?
         end
       end
+
+      rule(union: subtree(:types)) do
+        { 'oneOf' => Array(types) }
+      end
+
+      rule(intersect: subtree(:types)) do
+        { 'allOf' => Array(types) }
+      end
     end
 
     def initialize(model_path = Type::MODEL_PATH)
@@ -138,9 +158,21 @@ module SwaggerYard
     end
 
     def json_schema(str)
-      @xform.apply(parse(str), model_path: @model_path)
+      @xform.apply(parse(str),
+                   model_path: @model_path,
+                   resolve_uri: ->(name, prefix) { resolve_uri(name, prefix) })
     rescue Parslet::ParseFailed => e
       raise InvalidTypeError, "'#{str}': #{e.message}"
     end
+
+    def resolve_uri(name, prefix)
+      unless url = SwaggerYard.config.external_schema[prefix]
+        raise UndefinedSchemaError, "unknown prefix #{prefix} for #{name}"
+      end
+      uri, fragment = url.split '#'
+      fragment = fragment ? "##{fragment}" : @model_path
+      fragment += '/' unless fragment.end_with?('/')
+      [uri, fragment]
+    end
   end
 end

data/lib/swagger_yard/type_parser.rb.~15b1c21e39906b88fcc3b6ec11649ad1a159adbf~

@@ -0,0 +1,146 @@
+require 'parslet'
+
+module SwaggerYard
+  class TypeParser
+    class Parser < Parslet::Parser
+      # Allow for whitespace surrounding a string value
+      def spaced(arg)
+        space >> str(arg) >> space
+      end
+
+      def stri(str)
+        key_chars = str.split(//)
+        key_chars.collect! { |char| match["#{char.upcase}#{char.downcase}"] }.
+          reduce(:>>)
+      end
+
+      rule(:space)      { match[" \n"].repeat }
+
+      rule(:id_char)    { match['-a-zA-Z0-9_'].repeat }
+
+      rule(:id_start)   { match('[a-zA-Z_]') }
+
+      rule(:name)       { id_start >> id_char }
+
+      rule(:identifier) { name >> (str('::') >> name).repeat }
+
+      rule(:external_identifier) { name.as(:namespace) >> str('#') >> identifier.as(:identifier) }
+
+      rule(:regexp)     { stri('regex') >> match['Pp'].maybe >> space >>
+                          str('<') >> (str('\\\\') | str('\\>') | match['[^>]']).repeat.as(:regexp) >> str('>') }
+
+      rule(:enum_list)  { name.as(:value) >> (spaced(',') >> name.as(:value)).repeat }
+
+      rule(:enum)       { stri('enum') >> spaced('<') >> enum_list >> spaced('>') }
+
+      rule(:array)      { stri('array') >> spaced('<') >> type >> spaced('>') }
+
+      rule(:pair)       { (name.as(:property) >> spaced(':') >> type.as(:type)).as(:pair) }
+
+      rule(:pairs)      { pair >> (spaced(',') >> pair).repeat >> (spaced(',') >> type.as(:additional)).maybe }
+
+      rule(:object)     { stri('object') >> spaced('<') >> (pairs | type.as(:additional)) >> spaced('>') }
+
+      rule(:formatted)  { name.as(:name) >> spaced('<') >> name.as(:format) >> spaced('>') }
+
+      rule(:type)       { enum.as(:enum) |
+                          array.as(:array) |
+                          object.as(:object) |
+                          formatted.as(:formatted) |
+                          external_identifier.as(:external_identifier) |
+                          identifier.as(:identifier) |
+                          regexp }
+
+      root :type
+    end
+
+    class Transform < Parslet::Transform
+      rule(identifier: simple(:id)) do
+        v = id.to_s
+        case v
+        when /^array$/i
+          { 'type' => 'array', 'items' => { 'type' => 'string' } }
+        when /^object$/i
+          { 'type' => 'object' }
+        when "float", "double"
+          { 'type' => 'number', 'format' => v }
+        when "date-time", "date", "time", "uuid"
+          { 'type' => 'string', 'format' => v }
+        else
+          name = Model.mangle(v)
+          if /[[:upper:]]/.match(name)
+            { '$ref' => "#{model_path}#{name}" }
+          else
+            { 'type' => name }
+          end
+        end
+      end
+
+      rule(external_identifier: { namespace: simple(:namespace), identifier: simple(:identifier) }) do
+        prefix, name = namespace.to_s, identifier.to_s
+        unless url = SwaggerYard.config.external_schema[prefix]
+          raise UndefinedSchemaError, "unknown prefix #{prefix} for #{name}"
+        end
+        uri = URI(url)
+        fragment = uri.fragment ? "##{uri.fragment}" : model_path
+        uri.fragment = nil
+        fragment += '/' unless fragment.end_with?('/')
+        url = uri.to_s
+        { '$ref' => "#{url}#{fragment}#{Model.mangle(name)}"}
+      end
+
+      rule(formatted: { name: simple(:name), format: simple(:format) }) do
+        { 'type' => name.to_s, 'format' => format.to_s }
+      end
+
+      rule(regexp: simple(:pattern)) do
+        { 'type' => 'string', 'pattern' => pattern.to_s.gsub('\\\\', '\\').gsub('\>', '>') }
+      end
+
+      rule(value: simple(:value)) { value.to_s }
+
+      rule(enum: subtree(:values)) do
+        { 'type' => 'string', 'enum' => Array(values) }
+      end
+
+      rule(array: subtree(:type)) do
+        { 'type' => 'array', 'items' => type }
+      end
+
+      rule(pair: { property: simple(:prop), type: subtree(:type) }) do
+        { 'properties' => { prop.to_s => type } }
+      end
+
+      rule(additional: subtree(:type)) do
+        { 'additionalProperties' => type }
+      end
+
+      rule(object: subtree(:properties)) do
+        { 'type' => 'object' }.tap do |result|
+          all_props = Array === properties ? properties : [properties]
+          props, additional = all_props.partition {|pr| pr['properties'] }
+          props.each do |pr|
+            result['properties'] = (result['properties'] || {}).merge(pr['properties'])
+          end
+          result.update additional.first unless additional.empty?
+        end
+      end
+    end
+
+    def initialize(model_path = Type::MODEL_PATH)
+      @parser = Parser.new
+      @xform  = Transform.new
+      @model_path = model_path
+    end
+
+    def parse(str)
+      @parser.parse(str)
+    end
+
+    def json_schema(str)
+      @xform.apply(parse(str), model_path: @model_path)
+    rescue Parslet::ParseFailed => e
+      raise InvalidTypeError, "'#{str}': #{e.message}"
+    end
+  end
+end

data/lib/swagger_yard/type_parser.rb.~5b9ef33~

@@ -0,0 +1,151 @@
+require 'parslet'
+
+module SwaggerYard
+  class TypeParser
+    class Parser < Parslet::Parser
+      # Allow for whitespace surrounding a string value
+      def spaced(arg)
+        space >> str(arg) >> space
+      end
+
+      def stri(str)
+        key_chars = str.split(//)
+        key_chars.collect! { |char| match["#{char.upcase}#{char.downcase}"] }.
+          reduce(:>>)
+      end
+
+      rule(:space)      { match[" \n"].repeat }
+
+      rule(:id_char)    { match['-a-zA-Z0-9_'].repeat }
+
+      rule(:id_start)   { match('[a-zA-Z_]') }
+
+      rule(:name)       { id_start >> id_char }
+
+      rule(:identifier) { name >> (str('::') >> name).repeat }
+
+      rule(:external_identifier) { name.as(:namespace) >> str('#') >> identifier.as(:identifier) }
+
+      rule(:regexp)     { stri('regex') >> match['Pp'].maybe >> space >>
+                          str('<') >> (str('\\\\') | str('\\>') | match['[^>]']).repeat.as(:regexp) >> str('>') }
+
+      rule(:enum_list)  { name.as(:value) >> (spaced(',') >> name.as(:value)).repeat }
+
+      rule(:enum)       { stri('enum') >> spaced('<') >> enum_list >> spaced('>') }
+
+      rule(:array)      { stri('array') >> spaced('<') >> type >> spaced('>') }
+
+      rule(:pair)       { (name.as(:property) >> spaced(':') >> type.as(:type)).as(:pair) }
+
+      rule(:pairs)      { pair >> (spaced(',') >> pair).repeat >> (spaced(',') >> type.as(:additional)).maybe }
+
+      rule(:object)     { stri('object') >> spaced('<') >> (pairs | type.as(:additional)) >> spaced('>') }
+
+      rule(:formatted)  { name.as(:name) >> spaced('<') >> name.as(:format) >> spaced('>') }
+
+      rule(:type)       { enum.as(:enum) |
+                          array.as(:array) |
+                          object.as(:object) |
+                          formatted.as(:formatted) |
+                          external_identifier.as(:external_identifier) |
+                          identifier.as(:identifier) |
+                          regexp }
+
+      root :type
+    end
+
+    class Transform < Parslet::Transform
+      rule(identifier: simple(:id)) do
+        v = id.to_s
+        case v
+        when /^array$/i
+          { 'type' => 'array', 'items' => { 'type' => 'string' } }
+        when /^object$/i
+          { 'type' => 'object' }
+        when "float", "double"
+          { 'type' => 'number', 'format' => v }
+        when "date-time", "date", "time", "uuid"
+          { 'type' => 'string', 'format' => v }
+        else
+          name = Model.mangle(v)
+          if /[[:upper:]]/.match(name)
+            { '$ref' => "#{model_path}#{name}" }
+          else
+            { 'type' => name }
+          end
+        end
+      end
+
+      rule(external_identifier: { namespace: simple(:namespace), identifier: simple(:identifier) }) do
+        prefix, name  = namespace.to_s, identifier.to_s
+        url, fragment = resolve_uri.call(name, prefix)
+        { '$ref' => "#{url}#{fragment}#{Model.mangle(name)}" }
+      end
+
+      rule(formatted: { name: simple(:name), format: simple(:format) }) do
+        { 'type' => name.to_s, 'format' => format.to_s }
+      end
+
+      rule(regexp: simple(:pattern)) do
+        { 'type' => 'string', 'pattern' => pattern.to_s.gsub('\\\\', '\\').gsub('\>', '>') }
+      end
+
+      rule(value: simple(:value)) { value.to_s }
+
+      rule(enum: subtree(:values)) do
+        { 'type' => 'string', 'enum' => Array(values) }
+      end
+
+      rule(array: subtree(:type)) do
+        { 'type' => 'array', 'items' => type }
+      end
+
+      rule(pair: { property: simple(:prop), type: subtree(:type) }) do
+        { 'properties' => { prop.to_s => type } }
+      end
+
+      rule(additional: subtree(:type)) do
+        { 'additionalProperties' => type }
+      end
+
+      rule(object: subtree(:properties)) do
+        { 'type' => 'object' }.tap do |result|
+          all_props = Array === properties ? properties : [properties]
+          props, additional = all_props.partition {|pr| pr['properties'] }
+          props.each do |pr|
+            result['properties'] = (result['properties'] || {}).merge(pr['properties'])
+          end
+          result.update additional.first unless additional.empty?
+        end
+      end
+    end
+
+    def initialize(model_path = Type::MODEL_PATH)
+      @parser = Parser.new
+      @xform  = Transform.new
+      @model_path = model_path
+    end
+
+    def parse(str)
+      @parser.parse(str)
+    end
+
+    def json_schema(str)
+      @xform.apply(parse(str),
+                   model_path: @model_path,
+                   resolve_uri: ->(name, prefix) { resolve_uri(name, prefix) })
+    rescue Parslet::ParseFailed => e
+      raise InvalidTypeError, "'#{str}': #{e.message}"
+    end
+
+    def resolve_uri(name, prefix)
+      unless url = SwaggerYard.config.external_schema[prefix]
+        raise UndefinedSchemaError, "unknown prefix #{prefix} for #{name}"
+      end
+      uri, fragment = url.split '#'
+      fragment = fragment ? "##{fragment}" : @model_path
+      fragment += '/' unless fragment.end_with?('/')
+      [uri, fragment]
+    end
+  end
+end

data/lib/swagger_yard/version.rb

@@ -1,3 +1,3 @@
 module SwaggerYard
-  VERSION = "1.0.2"
+  VERSION = "1.1.1"
 end

data/lib/swagger_yard.rb

@@ -15,9 +15,11 @@ require "swagger_yard/path_item"
 require "swagger_yard/swagger"
 require "swagger_yard/openapi"
 require "swagger_yard/handlers"
+require "swagger_yard/directives"
 
 module SwaggerYard
   class Error < StandardError; end
+  class UnknownConstant < Error; end
   class InvalidTypeError < Error; end
   class UndefinedSchemaError < Error; end
 
@@ -111,10 +113,12 @@ module SwaggerYard
       ::YARD::Tags::Library.define_tag("Model superclass", :inherits)
       ::YARD::Tags::Library.define_tag("Model property", :property, :with_types_name_and_default)
       ::YARD::Tags::Library.define_tag("Model discriminator", :discriminator, :with_types_name_and_default)
+      ::YARD::Tags::Library.define_tag("Additional properties", :additional_properties)
       ::YARD::Tags::Library.define_tag("Authorization", :authorization, :with_types_and_name)
       ::YARD::Tags::Library.define_tag("Authorization Use", :authorize_with)
       # @example is a core YARD tag, let's use it
       # ::YARD::Tags::Library.define_tag("Example", :example, :with_title_and_text)
+      ::YARD::Tags::Library.define_directive(:model, :with_title_and_text, Directives::ParamClassDirective)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_yard
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.1
 platform: ruby
 authors:
 - chtrinh (Chris Trinh)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-04 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,44 +84,44 @@ dependencies:
   name: apivore
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -193,6 +193,7 @@ files:
 - lib/swagger_yard/api_group.rb
 - lib/swagger_yard/authorization.rb
 - lib/swagger_yard/configuration.rb
+- lib/swagger_yard/directives.rb
 - lib/swagger_yard/example.rb
 - lib/swagger_yard/handlers.rb
 - lib/swagger_yard/model.rb
@@ -207,12 +208,14 @@ files:
 - lib/swagger_yard/type.rb
 - lib/swagger_yard/type.rb.~master~
 - lib/swagger_yard/type_parser.rb
+- lib/swagger_yard/type_parser.rb.~15b1c21e39906b88fcc3b6ec11649ad1a159adbf~
+- lib/swagger_yard/type_parser.rb.~5b9ef33~
 - lib/swagger_yard/version.rb
 homepage: http://www.synctv.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -220,16 +223,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: SwaggerYard API doc through YARD
 test_files: []