swagger-dsl 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ec890325cd8a13a5777720b3351c4c041d91e393fba975379795bace2860d95
-  data.tar.gz: 8082c1127a67be4060d2dbb32e1f89955b5b12642861198bdf1d0b627be750db
+  metadata.gz: 0e4b01a3c2f9182385dc31cf96d36b19781fb69c58403642c410e36e8e5cf3e0
+  data.tar.gz: ba787a1d0b03f8f214aca38482ad1e8dc7d9e7b9c8e7eea1c4d2e0432c9b4a4f
 SHA512:
-  metadata.gz: ef51b9cdb97ec79798999e4b4d5414e8bdd9b79e696d5492e11a3ec2f16fbb63be0222fd81a03bbe9fd57532b1b4a7e87c074c2c6fc0e855814c8ba8075c0e87
-  data.tar.gz: cce2fd4ff859619d69ab8fedf7668f7f70f83c60ab825ec31a60f40608f3fe30de2de82177815d68008c3d87530642860882f672b3488b9278da3483232f8f67
+  metadata.gz: 103ae693a31e19ea4c0c786f5b2add798da809a473f9113e7b297d39275a139f7089b1c300bfe2c40895a713c2e6011a6188cb4e722d44ae983cb2ded6082996
+  data.tar.gz: e8771d5f49a83fed9673a25e147d232920fc315affe95728a7293b7bdbf1d6a61ea6aa33c99c32dffa4c98dd1a43b46297008afc3b7b543fc254690cae58d9c9

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 2.0.0
+
+- fix(brake): adjust to OAS3 spec
+
 ## 1.4.0
 
 - add: lazy_define_paths for Rails eager_load

data/lib/swagger/dsl/json_schema/jimmy_patch.rb

@@ -5,7 +5,7 @@ module Jimmy
   class SchemaCreation
     module Referencing
       def component(id)
-        name = "#/components/#{id}"
+        name = "#/components/schemas/#{id}"
         reference_name = Swagger::DSL.current.config.dsl_options[:reference_name]
         reference_name ? reference_name.call(name) : name
       end

data/lib/swagger/dsl/operation.rb

@@ -16,33 +16,49 @@ module Swagger
 
       def initialize(operation_id, format: :json, &block)
         self["operationId"] = operation_id
-        self["requestBody"] = { "content" => {}, "required" => true }
         self["responses"] = {}
         self["parameters"] = []
+        self["tags"] = []
         @format = format
         instance_eval(&block)
       end
 
+      def summary(text)
+        self["summary"] = text
+      end
+
+      def description(text)
+        self["description"] = text
+      end
+
+      def tags(*tags)
+        self["tags"].concat(tags.flatten(1))
+      end
+
       def params(default_required: Swagger::DSL.current.config.default_required, &block)
         self["parameters"] = Parameters.new(default_required: default_required, &block)
       end
 
       def body(format: @format, dsl: nil, &block)
         formats(format).each do |f|
+          self["requestBody"] ||= { "required" => true }
+          self["requestBody"]["content"] ||= {}
           self["requestBody"]["content"][f] = { "schema" => Swagger::DSL::JsonSchema.by(dsl).dsl(&block) }
         end
       end
 
       def body_description(body_description = nil)
+        self["requestBody"] ||= { "required" => true }
         self["requestBody"]["description"] = body_description
       end
 
       def body_optional(optional = true)
+        self["requestBody"] ||= {}
         self["requestBody"]["required"] = optional
       end
 
       def render(code = 200, format: @format, dsl: nil, &block)
-        self["responses"][code] ||= { "content" => {} }
+        self["responses"][code] ||= { "content" => {}, "description" => "#{code}" }
         formats(format).each do |f|
           self["responses"][code]["content"][f] = { "schema" => Swagger::DSL::JsonSchema.by(dsl).dsl(&block) }
         end

data/lib/swagger/dsl/serializer.rb

@@ -6,7 +6,7 @@ module Swagger
     module Serializer
       def swagger(dsl: nil, &block)
         name = self.name.sub(/Serializer$/, "")
-        Swagger::DSL.current["components"][name] =
+        Swagger::DSL.current["components"]["schemas"][name] =
           Swagger::DSL::JsonSchema.by(dsl).dsl(&block).merge(Swagger::DSL.current.config.inject_key => name)
       end
 

data/lib/swagger/dsl/version.rb

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

data/lib/swagger/dsl.rb

@@ -20,9 +20,10 @@ module Swagger
     def initialize(schema = nil, config: Config.new)
       merge!(schema || {})
       self["openapi"] ||= "3.0.0"
-      self["info"] ||= {}
+      self["info"] ||= { "title" => "OpenAPI schema", "version" => "0.0.0" }
       self["paths"] ||= {}
-      self["components"] = Components[self["components"] || {}]
+      self["components"] ||= {}
+      self["components"]["schemas"] = Components[self["components"]["schemas"] || {}]
       @config = config
       @define_paths_procs = []
     end

data/swagger-dsl.gemspec

@@ -28,12 +28,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
 
   spec.add_dependency "jimmy", "~> 0.5"
-  spec.add_dependency "json-schema-subset-dsl", "~> 1.2"
+  spec.add_dependency "json-schema-subset-dsl", "~> 2.0"
   spec.add_dependency "hana", "~> 1.3"
   spec.add_dependency "json_refs", "~> 0.1"
-  spec.add_dependency "activesupport", "~> 6.0"
+  spec.add_dependency "activesupport", ">= 4.0.2"
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.9"
   spec.add_development_dependency "rspec-power_assert", "~> 1.1"
   spec.add_development_dependency "rubocop", "~> 0.76"
@@ -42,4 +42,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-config-prettier", "~> 0.1"
   spec.add_development_dependency "yard", "~> 0.9"
   spec.add_development_dependency "pry-byebug", "~> 3.7"
+  spec.add_development_dependency "json_spec", "~> 1"
+  spec.add_development_dependency "openapi3_parser", "~> 0.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger-dsl
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Narazaka
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-12-07 00:00:00.000000000 Z
+date: 2022-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jimmy
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: hana
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,16 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 4.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 4.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -220,7 +220,35 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
-description: 
+- !ruby/object:Gem::Dependency
+  name: json_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: openapi3_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description:
 email:
 - info@narazaka.net
 executables: []
@@ -264,8 +292,8 @@ 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.4.0
-post_install_message: 
+  documentation_uri: https://www.rubydoc.info/gems/swagger-dsl/2.0.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -280,9 +308,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Swagger (OpenAPI 3) DSL
 test_files: []