rspec-rails-api 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a96138e6fbb4608ddbf6a4e03912e3e2e262610bc0f98dadf5ad2c26a756ce8
-  data.tar.gz: 8bfaf96bafa6a8420db600978af05499e398d06ae6db0d18cfdc7cde86c68119
+  metadata.gz: 063a556e42014a4511564abe16c657d4957ae13e51a884b9813ba1c168a3ba57
+  data.tar.gz: 35917b290d4121f22208ca686f13408cea7889f5c349d39e018a606710efb0f9
 SHA512:
-  metadata.gz: '04593f5aed1d220b4293da9571e9e8dfffef8564b49c76a64598c28565094cd14b6dfaf828074de51604cb5e861eaac35a536c9774edf227770f984929481d39'
-  data.tar.gz: 7857727829cf0e9df507566f31fc01ec6f1da45cbd0181cf8340f6f96245f0f0935eb5dc7f01c8b607335e98a9e0c7f6bedad5a44ec7d19bec8c058256732b83
+  metadata.gz: ffb97e91dde2e69050a7b38399511e902a0b9c62807af391269fd66e84379752c2883897639c8c36633ba6f85ffbb00abfa5cc89c050653943ce4cbab2a7cbf4
+  data.tar.gz: 92f2182d34c8b83f8201975eb6d0551ec96cf1ca563668a2acd073eec549403c047c3ab73f9d11b6fe974529ce5a9c2cec02eecacecddcbf0cd7831c7ea13cfa

data/CHANGELOG.md

@@ -18,6 +18,24 @@ Maintenance, in case of rework, dependencies change
 
 ## [Unreleased]
 
+## [0.7.0] - 2024-01-24
+
+### Fixed
+
+- [BREAKING] Don't add `name` property in security schemes that should not have one. 
+  Only `type: :apiKey` should have one, so the `name` argument of `add_security_scheme` has been removed. Specify it
+  when it is required/accepted only.
+  ```rb
+  # Change:
+  #                            ref       name                      schema 
+  renderer.add_security_scheme :basic,   "Basic authentication",   { type: "http", scheme: "basic" }
+  renderer.add_security_scheme :api_key, "API key authentication", { type: "apiKey", in: "header" }
+  # To:
+  #                            ref       schema
+  renderer.add_security_scheme :basic,   type: "http", scheme: "basic"
+  renderer.add_security_scheme :api_key, name: "API key authentication", type: "apiKey", in: "header"
+  ```
+
 ## [0.6.3] - 2024-01-24
 
 ### Fixed
@@ -83,7 +101,7 @@ Maintenance, in case of rework, dependencies change
   prefix
 
 ### Fixed
-- 
+
 - Fixed an error when an object is defined with an attribute named `type`.
 
 ## [0.4.0] - 2021-12-19

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-rails-api (0.6.3)
+    rspec-rails-api (0.7.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/rspec/rails/api/open_api_renderer.rb

@@ -38,12 +38,10 @@ module RSpec
         # Adds a security scheme definition to the API documentation
         #
         # @param reference  [Symbol] Reference to use in the tests
-        # @param name       [String] Human friendly name
         # @param definition [Hash]   Security scheme definition as per https://swagger.io/specification/#security-scheme-object
-        def add_security_scheme(reference, name, definition)
+        def add_security_scheme(reference, definition)
           raise "Security scheme #{reference} is already defined" if @api_security.key? reference
 
-          definition[:name] = name unless reference == :basic
           @api_security[reference] = definition
         end
 

data/lib/rspec/rails/api/version.rb

@@ -3,7 +3,7 @@
 module RSpec
   module Rails
     module Api
-      VERSION = '0.6.3'
+      VERSION = '0.7.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-24 00:00:00.000000000 Z
+date: 2024-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport