swagger-blocks 1.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0c8a26e0663e8e18c42ed476d2dd128e7184c15
-  data.tar.gz: 3dc1e0bb361a8f961465147a7d17b380a880a4d8
+  metadata.gz: 9b866c42150b355a3435ee64d3e614c8833f66e0
+  data.tar.gz: 25c4cce082108016db076e702d8800a04190a2e7
 SHA512:
-  metadata.gz: 20d0a772640b989d013bd24571080428811255eb74aa62458341c4bd1ae0641ccbc43fa08f9d9ba4983baf9bbebb9d900b5b88464b6effcacc89d31ba039895b
-  data.tar.gz: e9fe5b2e5e4ac9ac7bd86ec124ae13d1fe2ef076f94b8c9ba6b65f2d6bfbcfad83d93672fe80b0566dd7dc5086ba8a86db9951f35a0cb6b0c987e28cb80dba4a
+  metadata.gz: 43785e40a8cd10c442e7691cda08c23270218bbaa1de1a7ff96100ce2401230c36f4868bda1f6d3e13fc383dfda65f2a00510c291e697cf70ddcd9e3c18419b8
+  data.tar.gz: 6e9b4abc905314c968557731fd758e9cc28fda85c42e7cf389ab4b24a2caaadedb085717ab4c71e4c5f54dfb5e0118d2a2494104114348d2d690efcdebc7682c

data/README.md

@@ -254,13 +254,17 @@ end
 The special part of this controller is this line:
 
 ```Ruby
-render json: Swagger::Blocks.build_root_json(swaggered_classes)
+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.
 
 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.
 
+### Swagger 1.2 example (Rails)
+
+See the [v1.2 docs](https://github.com/fotinakis/swagger-blocks/blob/master/README_v1_2.md).
+
 ## Reference
 
 See the [swagger_v2_blocks_spec.rb](https://github.com/fotinakis/swagger-blocks/blob/master/spec/lib/swagger_v2_blocks_spec.rb) for examples of more complex features and declarations possible.
@@ -275,6 +279,7 @@ See the [swagger_v2_blocks_spec.rb](https://github.com/fotinakis/swagger-blocks/
 
 ## Release notes
 
+* v1.1.1: Bugfix for tags node support.
 * v1.1: Support for Swagger 2.0 spec.
 * v1.0.1: Make backwards-compatible with Ruby 1.9.3.
 * v1.0.0: Initial major release.

data/lib/swagger/blocks.rb

@@ -336,6 +336,13 @@ module Swagger
         self.data[:security] ||= []
         self.data[:security] << Swagger::Blocks::SecurityRequirementNode.call(version: version, &block)
       end
+
+      def tags(&block)
+        raise NotSupportedError unless is_swagger_2_0?
+
+        self.data[:tags] ||= []
+        self.data[:tags] << Swagger::Blocks::TagNode.call(version: version, &block)
+      end
     end
 
     # v1.2: http://goo.gl/PvwUXj#512-resource-object

data/lib/swagger/blocks/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Blocks
-    VERSION = '1.1'
+    VERSION = '1.1.1'
   end
 end

data/spec/lib/swagger_v2_api_declaration.json

@@ -23,6 +23,16 @@
   "produces": [
     "application/json"
   ],
+  "tags": [
+    {
+      "name": "pet",
+      "description": "Pets operations",
+      "externalDocs": {
+        "description": "Find more info here",
+        "url": "https://swagger.io"
+      }
+    }
+  ],
   "paths": {
     "/pets": {
       "get": {

data/spec/lib/swagger_v2_blocks_spec.rb

@@ -28,6 +28,14 @@ class PetControllerV2
     key :schemes, ['http']
     key :consumes, ['application/json']
     key :produces, ['application/json']
+    tags do
+      key :name, 'pet'
+      key :description, 'Pets operations'
+      externalDocs do
+        key :description, 'Find more info here'
+        key :url, 'https://swagger.io'
+      end
+    end
   end
 
   swagger_path '/pets' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger-blocks
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: 1.1.1
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-11 00:00:00.000000000 Z
+date: 2015-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler