rspec-openapi 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a131e530d729238260cf30416962eccbcbde9e1dc93aa0dc14065fe245621671
-  data.tar.gz: c94f05ec6f9ffe4b8f72e0bc6bf0f5cc1a7395977c6a2a671b361dcc1ba9f354
+  metadata.gz: cb2aae5a8366967c1ce6a904bb990372af7f5d3b09d4c81fad3866e590c168c3
+  data.tar.gz: 0665f9348a14cb0eb77c37368f69d3952d6eb71e919d8864931cdfbbbc3055dc
 SHA512:
-  metadata.gz: acd6e8a4757c7610d5d92a5ee167995fe029f435b1c1bacf8f1b8eda8099b5fe3eef5e71eb4db26863e6fde7102abdcf7620896abec4da143ce2bd3d4ee3e9ef
-  data.tar.gz: 66f7a5be114b32fcda8cd61236acda18e399ecb4a38daa30ee4b050d87f19aa604a3c84a6c82682dda5069a3affa3369d13521600b4f4e06210e3f6b49f96fb0
+  metadata.gz: 69ec6408d396d9e4c75bc4ba3ef1c71f82ea2a7bbd67def082262b275c20b9769db851fdb2c1bea971a4ede35c10b6f325fbc35a73be8591f12a986e94a01637
+  data.tar.gz: b71662890f9710012a329db3f380f831e10a8d37671fd9db2a9e3b84d237c699c0c40892020e4f20c781b36ab68563205208bc51607f73f5b2f002c80b5c48de

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v0.2.1
+
+* Generate `example` of request body and path / query params
+  [#4](https://github.com/k0kubun/rspec-openapi/issues/4)
+* Remove a wrapper param created by Rails in request body
+  [#4](https://github.com/k0kubun/rspec-openapi/issues/4)
+
 ## v0.2.0
 
 * Generate `example` of response body [#3](https://github.com/k0kubun/rspec-openapi/issues/3)

data/lib/rspec/openapi/record_builder.rb

@@ -15,7 +15,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       path: route.path.spec.to_s.delete_suffix('(.:format)'),
       path_params: request.path_parameters,
       query_params: request.query_parameters,
-      request_params: request.request_parameters,
+      request_params: raw_request_params(request),
       request_content_type: request.content_type,
       controller: route.requirements[:controller],
       action: route.requirements[:action],
@@ -35,4 +35,13 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     end
     raise "No route matched for #{request.request_method} #{request.path_info}"
   end
+
+  # workaround to get real request parameters
+  # because ActionController::ParamsWrapper overwrites request_parameters
+  def raw_request_params(request)
+    original = request.delete_header('action_dispatch.request.request_parameters')
+    request.request_parameters
+  ensure
+    request.set_header('action_dispatch.request.request_parameters', original)
+  end
 end

data/lib/rspec/openapi/schema_builder.rb

@@ -38,6 +38,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
         in: 'path',
         required: true,
         schema: build_property(try_cast(value)),
+        example: try_cast(value),
       }
     end
 
@@ -46,6 +47,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
         name: key.to_s,
         in: 'query',
         schema: build_property(try_cast(value)),
+        example: try_cast(value),
       }
     end
 
@@ -61,6 +63,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
       content: {
         normalize_content_type(record.request_content_type) => {
           schema: build_property(record.request_params),
+          example: record.request_params,
         }
       }
     }

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -74,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.0.pre1
 signing_key: 
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs