swagger-dsl 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cc961ef3920695d4d5ceb821614d851813f17d1260f770159114eccab257fb7
-  data.tar.gz: 0bc99296d8a9855b7be3d3e2a6df2600b0ec923cbde9ce07d21a55bcaccac43d
+  metadata.gz: df246a1f449c1cb5be1e6d1353bd3a5f04863471ebc6e742d1474bb8f320729d
+  data.tar.gz: e7b9841234c25d9c0c44171cadfcdc2768cae499c1969e74569d7b8f25fd5369
 SHA512:
-  metadata.gz: 2100a4b87f0274ec94a99bff02f358dac6248e6069afa3539a3925cdad8fdce40f3cc8f32d56a22c3323172ad8cfbfa87500e4b0a6cd7969172d9ebd47bcae49
-  data.tar.gz: a4f54a4143025e57de805e945c1166de0bdd8b137ec1c1482c6be566f9fce550c0eeea2917791b6a411bc2f4ab20de5743116ff3f4e86affa03552074ee72604
+  metadata.gz: 33920f490f0899e4ec4a2fd1b5d25a53ead73b1e20712b7cbaf3ed9998d2af84abb9c77fa89f669ae858a0b9487a0c8335bdd81556f6edabb7f9b113704a9b01
+  data.tar.gz: 71319ffb954af6404a9eac5618f89a81d3d00c5d7b7c45959891bfa3560aa7d0b8d505fcdf96937d19f9cf10c0eeeb186b1c6cd908a359e69d8ce8cf877c6f15

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# CHANGELOG
+
+## 1.1.0
+
+- add: multiple format accept in params
+- add: form shortcut in params format
+
+## 1.0.0
+
+- released

data/README.md

@@ -20,6 +20,8 @@ Or install it yourself as:
 
 ## Usage
 
+see also [swagger-serializer](https://github.com/Narazaka/swagger-serializer)
+
 ```ruby
 class BaseSerializer
   extend Swagger::DSL::Serializer
@@ -78,7 +80,7 @@ Swagger::DSL.current["info"] = {
   "version" => "0.1.0",
 }
 
-JSON.dump(Swagger::DSL.current.as_json(except: "config"))
+JSON.dump(Swagger::DSL.current)
 ```
 
 ## Development

data/lib/swagger/dsl/operation.rb

@@ -5,7 +5,12 @@ module Swagger
   class DSL
     class Operation < Hash
       FORMAT_TYPE = {
-        json: "application/json", xml: "application/xml", plain: "text/plain", html: "text/html", csv: "text/csv"
+        json: "application/json",
+        xml: "application/xml",
+        plain: "text/plain",
+        html: "text/html",
+        csv: "text/csv",
+        form: "application/x-www-form-urlencoded",
       }.freeze
 
       def initialize(operation_id, format: :json, &block)
@@ -22,9 +27,11 @@ module Swagger
       end
 
       def body(format: @format, dsl: nil, &block)
-        self["requestBody"]["content"][FORMAT_TYPE[format]] = {
-          "schema" => Swagger::DSL::JsonSchema.by(dsl).dsl(&block)
-        }
+        formats(format).each do |f|
+          self["requestBody"]["content"][f] = {
+            "schema" => Swagger::DSL::JsonSchema.by(dsl).dsl(&block)
+          }
+        end
       end
 
       def body_description(body_description = nil)
@@ -37,9 +44,17 @@ module Swagger
 
       def render(code = 200, format: @format, dsl: nil, &block)
         self["responses"][code] ||= { "content" => {} }
-        self["responses"][code]["content"][FORMAT_TYPE[format]] = {
-          "schema" => Swagger::DSL::JsonSchema.by(dsl).dsl(&block)
-        }
+        formats(format).each do |f|
+          self["responses"][code]["content"][f] = {
+            "schema" => Swagger::DSL::JsonSchema.by(dsl).dsl(&block)
+          }
+        end
+      end
+
+      private
+
+      def formats(format)
+        Array(format).map { |f| FORMAT_TYPE[f] }
       end
     end
   end

data/lib/swagger/dsl/resolve_module.rb

@@ -6,7 +6,7 @@ module Swagger
   class DSL
     module ResolveModule
       def resolved
-        JsonRefs.call(self.deep_dup)
+        JsonRefs.call(deep_dup)
       end
 
       def resolver

data/lib/swagger/dsl/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   class DSL < Hash
-    VERSION = "1.0.0".freeze
+    VERSION = "1.1.0".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger-dsl
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Narazaka
@@ -233,6 +233,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_airbnb.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -263,7 +264,7 @@ metadata:
   homepage_uri: https://github.com/Narazaka/swagger-dsl
   source_code_uri: https://github.com/Narazaka/swagger-dsl.git
   changelog_uri: https://github.com/Narazaka/swagger-dsl/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/swagger-dsl/1.0.0
+  documentation_uri: https://www.rubydoc.info/gems/swagger-dsl/1.1.0
 post_install_message: 
 rdoc_options: []
 require_paths: