jsonapi_swagger_helpers 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ae4cfb11abca237e55783d3638b67e6a163a9bc
-  data.tar.gz: 5b3c47fe4d0709438891357a1dfb2fe3c41955fd
+  metadata.gz: 1feea97f395c500cbf8914d31a2e02a3ad0529cd
+  data.tar.gz: 1d5e093336798ba21f41020ef8b58c83e8fa979e
 SHA512:
-  metadata.gz: 2ac4c4df5cccd5f90a6e24f63df634f65f5570549f991790ec628fd540be531070534623481034976ef6dc3df27a3f87d839f38f8d7378484a5950b9d8b9b08d
-  data.tar.gz: 34a3b055667e5049143676800995a18e26a073bf9f9abd30fb86c1592f0cbf75749c67daacee9a0e214c1c6fdd558e7c53077271db7b91220e7b6a36a287dc7b
+  metadata.gz: 13265b4a6f5f91b060536991587c8be0878537e705230faf04cd8df381e138257d573ad8dbaf6d3fba1e9d6ce9c25448f0e243566af0c29ea3d9f09393c8d9a6
+  data.tar.gz: c277e20daa4b1785cfbffb826267e34c733179c4ba21a87dd120ffa24508e551d19e52d346d8a9347a119404f11d8aab0b1b8c52acffb65d72b209e627632a69

data/lib/jsonapi_swagger_helpers/create_action.rb

@@ -20,9 +20,13 @@ module JsonapiSwaggerHelpers
           key :in, :body
 
           schema do
-            key :'$ref', :"#{_self.strong_resource.name}_create"
+            key :'$ref', _self.request_schema_id
           end
         end
+
+        response 200 do
+          key :description, 'API Response'
+        end
       end
     end
   end

data/lib/jsonapi_swagger_helpers/index_action.rb

@@ -8,12 +8,20 @@ module JsonapiSwaggerHelpers
 
     def generate
       _self = self
+      generate_response_schema!
 
       @node.operation :get do
         key :description, _self.full_description
         key :operationId, _self.operation_id
         key :tags, _self.all_tags
 
+        response 200 do
+          key :description, 'API Response'
+          schema do
+            key :'$ref', _self.response_schema_id
+          end
+        end
+
         _self.util.jsonapi_sorting(self)
         _self.util.jsonapi_pagination(self)
 

data/lib/jsonapi_swagger_helpers/payload_definition.rb

@@ -50,7 +50,10 @@ module JsonapiSwaggerHelpers
           property attribute do
             type = _self.class.swagger_type_for(payload.name, attribute, config[:type])
             key :type, type
-            key :description, config[:description]
+
+            if config[:description]
+              key :description, config[:description]
+            end
           end
         end
       end

data/lib/jsonapi_swagger_helpers/readable.rb

@@ -78,6 +78,23 @@ module JsonapiSwaggerHelpers
       resource.config[:type]
     end
 
+    def response_schema_id
+      "#{operation_id}_#{action_name}_response"
+    end
+
+    def generate_response_schema!
+      _self = self
+
+      payloads = util.payloads_for(resource, include_directive.to_hash)
+      JsonapiSwaggerHelpers.docs_controller.send(:swagger_schema, response_schema_id) do
+        payloads.each do |p|
+          property p.name do
+            key :'$ref', p.name
+          end
+        end
+      end
+    end
+
     def generate
       raise 'override me'
     end

data/lib/jsonapi_swagger_helpers/resource_mixin.rb

@@ -20,7 +20,7 @@ module JsonapiSwaggerHelpers
       tags = config[:tags]
       descriptions = config[:descriptions]
       only = config[:only]
-      except = config[:only]
+      except = config[:except]
 
       actions = [:index, :show, :create, :update, :destroy]
       actions.select! { |a| only.include?(a) } unless only.empty?

data/lib/jsonapi_swagger_helpers/show_action.rb

@@ -8,12 +8,20 @@ module JsonapiSwaggerHelpers
 
     def generate
       _self = self
+      generate_response_schema!
 
       @node.operation :get do
         key :description, _self.full_description
         key :operationId, _self.operation_id
         key :tags, _self.all_tags
 
+        response 200 do
+          key :description, 'API Response'
+          schema do
+            key :'$ref', _self.response_schema_id
+          end
+        end
+
         _self.util.id_in_url(self)
         _self.util.jsonapi_fields(self, _self.jsonapi_type)
 

data/lib/jsonapi_swagger_helpers/update_action.rb

@@ -22,9 +22,13 @@ module JsonapiSwaggerHelpers
           key :in, :body
 
           schema do
-            key :'$ref', :"#{_self.strong_resource.name}_update"
+            key :'$ref', _self.request_schema_id
           end
         end
+
+        response 200 do
+          key :description, 'API Response'
+        end
       end
     end
   end

data/lib/jsonapi_swagger_helpers/version.rb

@@ -1,3 +1,3 @@
 module JsonapiSwaggerHelpers
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/lib/jsonapi_swagger_helpers/writeable.rb

@@ -56,21 +56,53 @@ module JsonapiSwaggerHelpers
       controller._strong_resources[action_name]
     end
 
+    def request_schema_id
+      "#{operation_id}_#{action_name}_request"
+    end
+
+    def generate_request_schema!
+      _self = self
+
+      JsonapiSwaggerHelpers.docs_controller.send(:swagger_schema, request_schema_id) do
+        property _self.strong_resource.name do
+          key :'$ref', :"#{_self.strong_resource.name}_#{_self.action_name}"
+        end
+
+        _self.each_strong_relation(_self.strong_resource) do |relation_name, relation_config|
+          property relation_name do
+            key :'$ref', :"#{_self.strong_resource.name}_#{relation_name}_#{_self.action_name}"
+          end
+        end
+      end
+    end
+
+    def each_strong_relation(strong_resource)
+      strong_resource.relations.each_pair do |relation_name, relation_config|
+        yield relation_name, relation_config
+
+        each_strong_relation(relation_config[:resource]) do |sub_relation_name, sub_relation_config|
+          yield sub_relation_name, sub_relation_config
+        end
+      end
+    end
+
     def define_schema
+      generate_request_schema!
+
       _self = self
       context.send(:swagger_schema, :"#{strong_resource.name}_#{action_name}") do
         _self.strong_resource.attributes.each_pair do |attribute, config|
           property attribute do
-            key :type, config[:type] # TODO - swagger type?
+            key :type, config[:type]
           end
         end
       end
 
-      _self.strong_resource.relations.each_pair do |relation_name, relation_config|
+      _self.each_strong_relation(_self.strong_resource) do |relation_name, relation_config|
         context.send(:swagger_schema, :"#{strong_resource.name}_#{relation_name}_#{action_name}") do
           relation_config[:resource].attributes.each_pair do |attribute, config|
             property attribute do
-              key :type, config[:type] # TODO - swagger type?
+              key :type, config[:type]
             end
           end
         end
@@ -78,14 +110,7 @@ module JsonapiSwaggerHelpers
     end
 
     def generate
-      _self = self
-
-      define_schema
-      @node.operation :post do
-        key :description, _self.description
-        key :operationId, _self.operation_id
-        key :tags, _self.all_tags
-      end
+      raise 'override me'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_swagger_helpers
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Lee Richmond
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-21 00:00:00.000000000 Z
+date: 2017-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: swagger-blocks