explicit 0.2.16 → 0.2.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ea020d82544c742432038439630cad304e496fb33335e44de226db513feacbe
-  data.tar.gz: f733ee198a502d8962e5e726527153f28e924e275ddbe7f965e7b8dc89ee74f9
+  metadata.gz: 336334a1c2bd5bdde4580b2b3712618a7edacf3edfec03d1f96c44f704b09c3a
+  data.tar.gz: d756447ce81a13fb7bb7d722bdf7b89221bd556d16ea79bbe2dd39af3bda5e05
 SHA512:
-  metadata.gz: 31c95c4c1751c84cc4e02a2141bc209005700ac8aba906caecfbaf38193e92d43ad42832bd37a844487ccfc0f7ed433689e078545baf5b35d2db267bff419eff
-  data.tar.gz: fcbdf61db1ed115b8d0e8c28ff0ba7ea434f4c6c4096dda5e3b238777709a2797d4279906deba7cea11364b90ee2bb43bfeb4b846aad12098b1f2ce84ae6c0de
+  metadata.gz: e574720e293d3bd0b1ed92a0a19dd83a8b1aa4fea48a2e2b3c1d5cffc2ead2a8d87bebabd5815a6d9752b4dee11a70f37a32f438f0c635e8b7f04015802d597d
+  data.tar.gz: d8c7391dd7b6f0a769d885984a2bb823784d7423540e6b07a4e2136d4ac2fe50e42ecc42b120bc3f687244755bc12539278d5f73f21e0c85e8f01325c973606c

data/README.md

@@ -45,6 +45,7 @@ documented types at runtime.
    - [Customizing error messages](#customizing-error-messages)
    - [Customizing error serialization](#customizing-error-serialization)
    - [Raise on invalid example](#raise-on-invalid-example)
+   - [CORS](#cors)
 
 # Installation
 
@@ -841,7 +842,20 @@ end
 
 ### Raise on invalid example
 
+When adding a request example with `example(params:, response:)`, the response
+must match the documented types. If it doesn't match, Explicit logs a warning,
+but you can choose a more strict behaviour that raises an error instead.
+
 ```ruby
 config.raise_on_invalid_example = true # default is false
 config.raise_on_invalid_example = ::Rails.env.development? # recommended
 ```
+
+### CORS
+
+Enable/disable [CORS headers](https://github.com/luizpvas/explicit/blob/main/lib/explicit/documentation/output/swagger.rb#L67-L74)
+support.
+
+```ruby
+config.cors_enabled = true
+```

data/lib/explicit/configuration.rb

@@ -6,6 +6,7 @@ module Explicit
   class Configuration
     def initialize
       @rescue_from_invalid_params = true
+      @cors_enabled = !defined?(::Rack::Cors)
     end
 
     def request_examples_file_path=(path)
@@ -36,6 +37,14 @@ module Explicit
       @raise_on_invalid_example
     end
 
+    def cors_enabled=(enabled)
+      @cors_enabled = enabled
+    end
+
+    def cors_enabled?
+      @cors_enabled
+    end
+
     def test_runner=(test_runner)
       @test_runner = test_runner
     end

data/lib/explicit/documentation/output/swagger.rb

@@ -65,6 +65,8 @@ module Explicit::Documentation::Output
       end
 
       def cors_access_control_headers
+        return {} if !::Explicit.configuration.cors_enabled?
+
         {
           "Access-Control-Allow-Origin" => "*",
           "Access-Control-Allow-Methods" => "GET, OPTIONS",
@@ -156,7 +158,7 @@ module Explicit::Documentation::Output
               in: "header",
               required: type.required?,
               schema: type.swagger_schema,
-              style: "simple"
+              style: "form"
             }
           end
 
@@ -167,7 +169,7 @@ module Explicit::Documentation::Output
               in: "path",
               required: type.required?,
               schema: type.swagger_schema,
-              style: "simple"
+              style: "form"
             }
           end
 
@@ -178,7 +180,7 @@ module Explicit::Documentation::Output
               in: "query",
               required: type.required?,
               schema: type.swagger_schema,
-              style: "simple"
+              style: "form"
             }
           end
 

data/lib/explicit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Explicit
-  VERSION = "0.2.16"
+  VERSION = "0.2.18"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: explicit
 version: !ruby/object:Gem::Version
-  version: 0.2.16
+  version: 0.2.18
 platform: ruby
 authors:
 - Luiz Vasconcellos