zero-rails_openapi 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1945a762cf400f52a4fbc222c7cd10e6fed4937e3d4afcb9357e4e030edf349
-  data.tar.gz: f6b25115dd788832d34e5f83e4b216c49381367b80e0ae1c33a65fa964726b0d
+  metadata.gz: 3b19a052b847ba122b75b0b0fb1ecfa401c087a111fa18a7129b0553496298eb
+  data.tar.gz: 9baa8e072b95a4da0dae09c6538e6172d509231361806ee1613a066ec4d0fd81
 SHA512:
-  metadata.gz: 56e62cdd21432ee8394ca955ca63498a9e198da18c553f30fa35840fad8219afc599bccb25e71a1c6565e513be26c3a2422c4e08c51b1e51ab48edd31423d813
-  data.tar.gz: ce16f8ad8b4f83cdf5c7cbc4106b0f81354790a8febdeea0bf19b598f594e77505921260e832b6bf40f807ce580c9bef8c494b95c54de6d6d788e52c5032ef93
+  metadata.gz: 4166f08378b66d7a80d7c26d2b893688e5c19f74cc8352eaf6e2a8f1217bbd2f9910285dc2d941193e0ea4fc10d8cf3270012c0491fb1583ae1282e28058e955
+  data.tar.gz: 315db1cf5d4cb569071f01fab825076157eb42d8b7261a6d131ddf22aae75c63fa7f5b6cc5b4d9309332a0bf57ab92c4d3e364749522be082b8e45902a9fbf73

data/README.md

@@ -132,12 +132,12 @@
 ### First of all, `include OpenApi::DSL` in your base class (which is for writing spec):
 
   For example:
-    ```ruby
-    # in app/controllers/api/api_controller.rb
-    class ApiController < ActionController::API
-      include OpenApi::DSL
-    end
-    ```
+  ```ruby
+  # in app/controllers/api/api_controller.rb
+  class ApiController < ActionController::API
+    include OpenApi::DSL
+  end
+  ```
 
 ### DSL Usage Example
 
@@ -452,10 +452,11 @@
 
   ```ruby
   # ** Method Signature
-  response code, desc, media_type = nil, data: { }, **options
+  response code, desc, media_type = nil, headers: { }, data: { }, **options
   # ** Usage
   resp 200, 'success', :json, data: { name: 'test' }
   response 200, 'query result', :pdf, data: File
+  response :success, 'succ', :json, headers: { 'X-Request-Start': String }, data: { }
 
   # ** Method Signature
   response_ref code_and_compkey_hash

data/lib/oas_objs/media_type_obj.rb

@@ -7,21 +7,22 @@ module OpenApi
   module DSL
     # https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#media-type-object
     class MediaTypeObj < Hash
-      attr_accessor :media_type, :schema, :examples
+      attr_accessor :media_type, :schema, :examples, :example
 
-      def initialize(media_type, hash)
-        examples_hash   = hash.delete(:examples)
-        exp_params      = schema_type.keys if (exp_params = hash.delete(:exp_params)) == :all
-        self.examples   = ExampleObj.new(examples_hash, exp_params, multiple: true) if examples_hash.present?
+      def initialize(media_type, example: nil, examples: nil, exp_params: nil, **media_hash)
+        schema_type     = media_hash.values_at(:type, :data).compact.first
+        exp_params      = schema_type.keys if exp_params == :all
+        self.examples   = ExampleObj.new(examples, exp_params, multiple: true) if examples.present?
+        self.example    = ExampleObj.new(example) if example.present?
         self.media_type = media_type_mapping(media_type)
-        self.schema     = SchemaObj.new(hash.values_at(:type, :data).compact.first,
-                                        hash.except(:type, :data))
+        self.schema     = SchemaObj.new(schema_type, media_hash.except(:type, :data))
       end
 
       def process
         return { } if media_type.nil?
         schema_processed = schema.process
         result = schema_processed.values.join.blank? ? { } : { schema: schema_processed }
+        result[:example] = example.process unless example.nil?
         result[:examples] = examples.process unless examples.nil?
         { media_type => result }
       end

data/lib/open_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenApi
-  VERSION = '2.1.0'
+  VERSION = '2.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zero-rails_openapi
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-16 00:00:00.000000000 Z
+date: 2019-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler