rspec-rails-api 0.8.1 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f3ec1cf7d649accd5699f84d2f2e7162e830bc4071b50433dc179d69028451d
-  data.tar.gz: b612884d3574e170f737fc080e58b19f7ca4485104b14a3ca884570e5e3ac0a5
+  metadata.gz: a6196620d9b256a8ab9b95a82618671a1b3e12e26b01f1b99238512938fcab25
+  data.tar.gz: d6a70286ac640e5d6f2e0030316b786ecff6642ea3acb1c5ce70d31f6ece3fde
 SHA512:
-  metadata.gz: 35cd6e4ed48cd3cf05e950c8a98dcc030efdf82da422803818082d4af7eeb936bac6a6ae6341fc6495dbc944797212750fc14384d3aa73e78e81e0588724d01f
-  data.tar.gz: 01daf64801e027024566367126f4f2a3767be1957932d540384517e9a1369296bfa649b5473badab670969416e380f8ab6532f88c2deffb4790b6e750d7afbda
+  metadata.gz: f1e3e62a5a7d3b37c80b5fee37bcaed6a3d8c2cbe5de560b35c14f52e556e87c25eb980d03c7154a1ad809f1b4ef5974faa85d3c7edfd77be03cb8a1bb82c3e1
+  data.tar.gz: cf8e1745a4f9498062dd26495162c3a4f2ac6244850e0142106f0e27f2b4673393caf05bf1a647e55b3424901a02e32b9ab9cea32f387aaf3eac27e855f33709

data/CHANGELOG.md

@@ -18,6 +18,18 @@ Maintenance, in case of rework, dependencies change
 
 ## [Unreleased]
 
+## [0.8.3] - 2024-11-22
+
+### Fixed
+
+- Fixed documentation generation of the description on objects and arrays
+
+## [0.8.2] - 2024-11-22
+
+### Fixed
+
+- Fixed documentation generation of object's attributes when they are not passed as reference.
+
 ## [0.8.1] - 2024-10-16
 
 ### Fixed

data/Gemfile.lock

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

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

@@ -234,10 +234,12 @@ module RSpec
               property[:items] = { type: field.attributes }
             elsif field.type == :object && field.attributes.is_a?(Symbol)
               property = { '$ref' => "#/components/schemas/#{field.attributes}" }
+            elsif field.type == :object && field.attributes
+              property = { type: :object, description: field.description, properties: process_entity(field.attributes)[:properties] }
             elsif field.type == :array && field.attributes.is_a?(Symbol)
-              property = { type: :array, items: { '$ref' => "#/components/schemas/#{field.attributes}" } }
+              property = { type: :array, description: field.description, items: { '$ref' => "#/components/schemas/#{field.attributes}" } }
             elsif field.type == :array && field.attributes
-              property = { type: :array, items: process_entity(field.attributes) }
+              property = { type: :array, description: field.description, items: process_entity(field.attributes) }
             end
 
             required.push name unless field.required == false

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

@@ -3,7 +3,7 @@
 module RSpec
   module Rails
     module Api
-      VERSION = '0.8.1'
+      VERSION = '0.8.3'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.3
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-16 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies: []
 description: |
   Create acceptance tests to check the Rails API responses and generate
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Tests standard Rails API responses and generate doc