lib/swagger_yard.rb in swagger_yard-0.4.4 vs lib/swagger_yard.rb in swagger_yard-1.0.0

- old
+ new

@@ -1,19 +1,21 @@ require "yard" require "json" require "swagger_yard/configuration" require "swagger_yard/type" require "swagger_yard/type_parser" +require "swagger_yard/example" require "swagger_yard/parameter" require "swagger_yard/property" require "swagger_yard/operation" require "swagger_yard/authorization" -require "swagger_yard/resource_listing" -require "swagger_yard/api_declaration" +require "swagger_yard/specification" +require "swagger_yard/api_group" require "swagger_yard/model" -require "swagger_yard/api" +require "swagger_yard/path_item" require "swagger_yard/swagger" +require "swagger_yard/openapi" module SwaggerYard class Error < StandardError; end class InvalidTypeError < Error; end class UndefinedSchemaError < Error; end @@ -96,20 +98,22 @@ ## # Register some custom yard tags used by swagger-ui def register_custom_yard_tags! ::YARD::Tags::Library.define_tag("Api resource", :resource) - ::YARD::Tags::Library.define_tag("Resource path", :resource_path) # TODO: remove deprecated tag ::YARD::Tags::Library.define_tag("Api path", :path, :with_types) ::YARD::Tags::Library.define_tag("Parameter", :parameter, :with_types_name_and_default) ::YARD::Tags::Library.define_tag("Response type", :response_type, :with_types) ::YARD::Tags::Library.define_tag("Error response message", :error_message, :with_types_and_name) + ::YARD::Tags::Library.define_tag("Response", :response, :with_types_and_name) ::YARD::Tags::Library.define_tag("Api Summary", :summary) ::YARD::Tags::Library.define_tag("Model resource", :model) ::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("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) end end end