rspec-openapi 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a02d800d2c00b3cfec6a1a860f17eafaed45e51329aaa7407ed1e96892a10ac9
-  data.tar.gz: db0ec61540014497148d218846c01287d2b4f0e1ec4782148d932c5308ccbc75
+  metadata.gz: 3bf318171323fbd3fa8d664a4f34ec1fe5af39a4d39ab5ee7b020b3871a31cb4
+  data.tar.gz: 610173247f3b9c99c7f5d2461bad49ae1d9000d7c8f63dfc4ac884472830c005
 SHA512:
-  metadata.gz: b357caa7a5b3f497a743ddf7be434ceb141e5de9b93d5995ac66e7d42abce47fddaa65f5f62f0ceffca4e4d42a40405c7b6d8190b4d2557148d633af1c9e289d
-  data.tar.gz: c8166a897c99f4b60747bc4c51f223c20627303fd6276c2e8e9a4908fee6287d43f1fb43135354ff7615f7c0cece8665c1b5a96da234e3598dbe311c1468d712
+  metadata.gz: 4b8c0402fe94dbcc43353c210acb1c9c4b182331020670bb8955dc4abf17a18732852fc4b191a3d1ded1d3613ef5e0059aa79e09084eb23bd9ce7ca5beec9e25
+  data.tar.gz: 6c4cd49edbaea41dfc1c2b17c89ec85dac8e1063612ff29f3c63dccde9dacd7a19eb276253363f1091a19976e0e6a20d40dc32f5deae36fa291e17f054b22eaf

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v0.4.3
+
+* Allow customizing `schema`, `description`, and `tags` through `:openapi` metadata
+  [#36](https://github.com/k0kubun/rspec-openapi/pull/36)
+
 ## v0.4.2
 
 * Allow using Proc as `RSpec::OpenAPI.path`

data/README.md

@@ -172,6 +172,22 @@ RSpec.describe '/resources', type: :request do
 end
 ```
 
+## Customizations
+
+Some examples' attributes can be overwritten via RSpec metadata options. Example:
+
+```rb
+  describe 'GET /api/v1/posts', openapi: {
+    summary: 'list all posts',
+    description: 'list all posts ordered by pub_date',
+    tags: %w[v1 posts],
+  } do
+    # ...
+  end
+```
+
+**NOTE**: `description` key will override also the one provided by `RSpec::OpenAPI.description_builder` method.
+
 ## Links
 
 Existing RSpec plugins which have OpenAPI integration:

data/lib/rspec/openapi/record_builder.rb

@@ -40,6 +40,8 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       headers_arr << [header, header_value] if header_value
     end
 
+    metadata_options = example.metadata[:openapi] || {}
+
     RSpec::OpenAPI::Record.new(
       method: request.request_method,
       path: path,
@@ -48,9 +50,9 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       request_params: raw_request_params(request),
       request_content_type: request.media_type,
       request_headers: request_headers,
-      summary: summary,
-      tags: tags,
-      description: RSpec::OpenAPI.description_builder.call(example),
+      summary: metadata_options[:summary] || summary,
+      tags: metadata_options[:tags] || tags,
+      description: metadata_options[:description] || RSpec::OpenAPI.description_builder.call(example),
       status: response.status,
       response_body: response_body,
       response_content_type: response.media_type,

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.4.2'
+    VERSION = '0.4.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs