swagger-blocks 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a714aa2b6fbb1add356e052e03c827226ef6a401
-  data.tar.gz: 36c7a3f585dcbcd8e4b90994a8e99053e651e035
+  metadata.gz: 24f472035a66f88b4a1921e3111332bbeff71c18
+  data.tar.gz: 0710bc5237aedac01946d26c94141e87b684882c
 SHA512:
-  metadata.gz: 3cabc6e8842e9e75dfc4d5f5dace3db91d49a37cbac643d0b341abdbd814f34f5f2f51b8621df2e0417f86bc969685bddbbc0aee6cac8e185911128e7f95e516
-  data.tar.gz: 9cbf2507bc76247123d13527a6e28f3833029d80d04b58f411fef9a3705be2e0becc8430fe034672dba74d328be71c02f16379b68a5a45176f2357a62412ce8a
+  metadata.gz: 47dab1f23c968995ab005b8319f728187510672e778f816d4229e7ef1d3d56d3bf20bcf51034232f80a6412c9ef1b66de0de502fc206bad5d10d9064c1aa29af
+  data.tar.gz: 19a7cc6a7d3dea1c46156f83c312f6e5aef8e4a0d1a0a89c74e796c0fa2d5ef863d5f9781b867b479b75c57431f7be9858bcd2128874eff355692540785113c1

data/README.md

@@ -43,6 +43,7 @@ class PetsController < ActionController::Base
 
   swagger_path '/pets/{id}' do
     operation :get do
+      key :summary, 'Find Pet by ID'
       key :description, 'Returns a single pet if the user has access'
       key :operationId, 'findPetById'
       key :tags, [
@@ -72,6 +73,7 @@ class PetsController < ActionController::Base
   end
   swagger_path '/pets' do
     operation :get do
+      key :summary, 'All Pets'
       key :description, 'Returns all pets from the system that the user has access to'
       key :operationId, 'findPets'
       key :produces, [
@@ -276,6 +278,17 @@ render json: Swagger::Blocks.build_root_json(SWAGGERED_CLASSES)
 
 That is the only line necessary to build the full [root Swagger object](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#schema) JSON and all definitions underneath it. You simply pass in a list of all the "swaggered" classes in your app.
 
+If you want to include controllers outside the standard path just use the full class path including module names, like:
+
+```Ruby
+SWAGGERED_CLASSES = [
+  Api::V1::PetsController,
+  self,
+]
+```
+
+If you are receiving a "swagger_root must be declared" error make sure you are including "self" in your SWAGGERED_CLASSES definition, as shown above.
+
 Now, simply point Swagger UI at `/apidocs` and everything should Just Work™. If you change any of the Swagger block definitions, you can simply refresh Swagger UI to see the changes.
 
 ### Security handling
@@ -471,6 +484,7 @@ Throw a ★ on it! :)
 
 ## Release notes
 
+* v2.0.1: Bugfix to allow nested arrays of `items`.
 * v2.0.0: Code cleanup, drop support for Swagger 1.2 spec.
 * v1.4.0: Allow parameters to be defined once in swagger_root and reused.
 * v1.3.4: Fix support for fully-qualified URIs in `$ref` values.

data/lib/swagger/blocks/nodes/items_node.rb

@@ -8,6 +8,10 @@ module Swagger
           self.data[:properties].version = version
           self.data[:properties].property(name, inline_keys, &block)
         end
+        
+        def items(inline_keys = nil, &block)
+          self.data[:items] = Swagger::Blocks::Nodes::ItemsNode.call(version: version, inline_keys: inline_keys, &block)
+        end
       end
     end
   end

data/lib/swagger/blocks/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Blocks
-    VERSION = '2.0.0'
+    VERSION = '2.0.1'
   end
 end

data/spec/lib/swagger_v2_api_declaration.json

@@ -301,6 +301,15 @@
                   }
                 }
               }
+            },
+            "arrayOfArrays": {
+              "type": "array",
+              "items": {
+                "type": "array",
+                "items": {
+                  "type": "integer"
+                }
+              }
             }
           }
         }

data/spec/lib/swagger_v2_blocks_spec.rb

@@ -261,6 +261,15 @@ class PetV2
             end
           end
         end
+        property :arrayOfArrays do
+          key :type, :array
+          items do
+            key :type, :array
+            items do
+              key :type, :integer
+            end
+          end
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger-blocks
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-30 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Define and serve live-updating Swagger JSON for Ruby apps.