F / Singluar example for MediaType

Author: hikari-desu

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

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

lib/open_api/version.rb

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

spec/api_spec.rb

@@ -194,6 +194,14 @@
         expect_its :headers, has_key: :'X-Request-Start'
       end
 
+      context 'when passing a example' do
+        api -> do
+          response :success, 'succ', :json, data: { name: String }, example: { name: 'Tom' }
+        end, has_key!: :success
+        focus_on :success
+        expect_its :content, has_keys: { 'application/json': [ example: [:name] ] }
+      end
+
       context 'when re-calling through the same code and media-type' do
         api -> do
           response :success, 'success desc1', :json, data: { name: String }