swagui 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96796f626d96d5277a24f656bf40e6edbcb1609b
-  data.tar.gz: f4f429bf1cee4358b5e5fafd5dbbfdc6efe677fc
+  metadata.gz: 6283c63492294c679588387d93c8617c67d96d80
+  data.tar.gz: 175c97e8b663689735910c234db51c3a887bf179
 SHA512:
-  metadata.gz: aa17d33e7927c59cdc493e12646a6f1d679a441887208b025d80e29e4fa3db682b40af8c73b391d4bc469e9b534ee40ea3bc502626874fcc8b31c79f91ab7584
-  data.tar.gz: 2e1507962d3e600d29fbaccd6e1b90e86497436a6de088b7cc6952360b35fb2388e1014d3a19bbf584beb39ea58abd4a4594d9e043dcf6c5ddd9bd6af65ed013
+  metadata.gz: 85328db2dcd3ad910dc884915dd485f238eabeb5e68f273783ce142b1c04da6d86de6d39e8e70cffc6fa7cf1627df59e104c3275f612ce25900f367d172c1f18
+  data.tar.gz: 0218d3fef78074e8602d1bcd2ab49fbf6d5441c25521ee089ee9948c52bc9098a882d3cffa303abd3cacd6b5b80a026c19bbe84f27039e2677c42dec5a2fc54a

data/README.md

@@ -54,6 +54,7 @@ You will be able to access the [swagger-ui] loaded with your api documentation a
     consumes:
       - application/json
 ```
+   5. __example value__: in current swagger ui, according to [swagui ui default value code], the render json structure is displayed with some empty values, such as `0`, `0.0`, `""`, etc, depends on the data type. This could make it hard to visualize how the json structure really looks like. Swagui provides an optional `example` attribute for each property, for the sample value that populates the json display.
 
 With this approach, swagger api docs are now a lot more concise and readible, let alone having dynamic `basePath`.
 
@@ -117,6 +118,7 @@ You will then able to view the [swagger-ui] loaded with your api documentation a
 
 [swagger-ui]: https://github.com/wordnik/swagger-ui
 [original swagger doc format]: https://github.com/wordnik/swagger-spec/blob/master/fixtures/v1.2/helloworld/static/api-docs
+[swagui ui default value code]: https://github.com/wordnik/swagger-ui/blob/6b448c1faecc5816d90de41ee6e90bb6322816c1/dist/lib/swagger.js#L660-L676
 ## Contributing
 
 1. Fork it ( https://github.com/jackxxu/swagui/fork )

data/lib/swagui/json_schema.rb

@@ -18,7 +18,7 @@ module Swagui
       else
         @type = 'class'
         (@schema_hash['properties'] ||= []).each do |pname, pattributes|
-          if pattributes['type'] == 'object' || (pattributes['type'] == 'array' && !pattributes['items'].nil?)
+          if pattributes['type'] == 'object' || (pattributes['type'] == 'array' && !pattributes['items'].nil? && (pattributes['items']['type'] == 'object'))
             nested_object_name = "#{@name}-#{pname}"
             if pattributes['type'] == 'object'
               @schema_hash['properties'][pname] = {'$ref' => nested_object_name }

data/lib/swagui/version.rb

@@ -1,3 +1,3 @@
 module Swagui
-  VERSION = "0.4.1"
+  VERSION = "0.5.1"
 end

data/swagger-ui/lib/swagger.js

@@ -591,6 +591,7 @@ var SwaggerModelProperty = function(name, obj) {
   this.isCollection = this.dataType && (this.dataType.toLowerCase() === 'array' || this.dataType.toLowerCase() === 'list' || this.dataType.toLowerCase() === 'set');
   this.descr = obj.description;
   this.required = obj.required;
+  this.sampleValue = obj.example; // sets the sample value
   if (obj.items != null) {
     if (obj.items.type != null) {
       this.refDataType = obj.items.type;
@@ -620,6 +621,9 @@ SwaggerModelProperty.prototype.getSampleValue = function(modelsToIgnore) {
   var result;
   if ((this.refModel != null) && (modelsToIgnore.indexOf(prop.refModel.name) === -1)) {
     result = this.refModel.createJSONSample(modelsToIgnore);
+  } else if (this.sampleValue) {
+    // displays sample value, if any
+    result = this.sampleValue
   } else {
     if (this.isCollection) {
       result = this.toSampleValue(this.refDataType);
@@ -1489,7 +1493,7 @@ SwaggerAuthorizations.prototype.apply = function(obj, authorizations) {
           if (result === true)
             status = true;
         }
-      }      
+      }
     }
   }
 

data/test/doc/schemas/account_get_request_body.schema.json

@@ -38,6 +38,15 @@
             "warehouseLocation": {
                 "description": "Coordinates of the warehouse with the product",
                 "$ref": "http://json-schema.org/geo"
+            },
+            "userIds": {
+              "type":"array",
+              "required":false,
+              "items": {
+                "type":"string",
+                "required":false,
+                "example": "1823257618648445648"
+              }
             }
         },
         "required": ["id", "name", "price"]

data/test/test_json_schema.rb

@@ -12,20 +12,20 @@ class TestJsonSchema < Minitest::Test
 
   def test_objects_method_returns_array
     schema = Swagui::JsonSchema.new(@schema_json, 'PostAccount')
-    assert_equal schema.all_objects.size, 4
+    assert_equal schema.all_objects.size, 3
   end
 
   def test_models_methods_return_array_of_hash
     schema = Swagui::JsonSchema.new(@schema_json, 'PostAccount')
-    assert_equal schema.models.size, 4
-    assert_equal schema.models.map {|x| x['id']}, ["PostAccount", "PostAccount-contact", "PostAccount-contact-phones", "PostAccount-entries"]
+    assert_equal schema.models.size, 3
+    assert_equal schema.models.map {|x| x['id']}, ["PostAccount", "PostAccount-contact", "PostAccount-entries"]
     assert_equal schema.models.first['properties']['entries'], {'type' => 'array', 'items' => {"$ref"=>"PostAccount-entries"}}
   end
 
   def test_array_schema
     schema = Swagui::JsonSchema.new(@array_schema_json, 'GetAccount')
-    assert_equal schema.models.size, 3
-    assert_equal schema.models.map {|m| m['id']}, %w(GetAccount GetAccount-tags GetAccount-dimensions)
+    assert_equal schema.models.size, 2
+    assert_equal schema.models.map {|m| m['id']}, %w(GetAccount GetAccount-dimensions)
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagui
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Jack Xu