rspec-rails-api 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 331b6d7af2333dde18fea74c45a4e07b01fae9d276540298eed0e7505423ae51
-  data.tar.gz: 1691d15f501cd1d9fd56059b3fea6c9c5b40e2fa21e29c5912ca30c34713b4ce
+  metadata.gz: a6196620d9b256a8ab9b95a82618671a1b3e12e26b01f1b99238512938fcab25
+  data.tar.gz: d6a70286ac640e5d6f2e0030316b786ecff6642ea3acb1c5ce70d31f6ece3fde
 SHA512:
-  metadata.gz: ef79c2fba59a70e1dbd9406360aa321bd59d289da466963cb54c74078dd1b60ad632e711491dfd4e869ce0fe912e8b4d0f30cdf125333ea49bb20691f3f354a9
-  data.tar.gz: bdc2ec91fcea8cd0b3a27bef42f9d83e7a6527c7ad3b4f096066f78eec50fccec35c2db23dbd067f5353dc4d1fed1ee5baf3a70118194a053538cca6f9f951ce
+  metadata.gz: f1e3e62a5a7d3b37c80b5fee37bcaed6a3d8c2cbe5de560b35c14f52e556e87c25eb980d03c7154a1ad809f1b4ef5974faa85d3c7edfd77be03cb8a1bb82c3e1
+  data.tar.gz: cf8e1745a4f9498062dd26495162c3a4f2ac6244850e0142106f0e27f2b4673393caf05bf1a647e55b3424901a02e32b9ab9cea32f387aaf3eac27e855f33709

data/CHANGELOG.md

@@ -18,6 +18,12 @@ 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

data/Gemfile.lock

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

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

@@ -235,11 +235,11 @@ module RSpec
             elsif field.type == :object && field.attributes.is_a?(Symbol)
               property = { '$ref' => "#/components/schemas/#{field.attributes}" }
             elsif field.type == :object && field.attributes
-              property = { type: :object, properties: process_entity(field.attributes)[:properties] }
+              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.2'
+      VERSION = '0.8.3'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Manuel Tancoigne