oas_rails 0.8.2 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c70c07ca9ad5ffa9227f3364f4df02846b3f713c2deebd06494c18b073efc907
-  data.tar.gz: 9375d6ea03cd901721987b627ded0a0dbdbfb064e83f84bb1a59e4d2c99da3ea
+  metadata.gz: 332f05d28a00e139df0d677f1fc187def7757e93543f9095d4e834d1cd65cccd
+  data.tar.gz: 41e70d4a52a5d3cf134846a9bcbe9b4c86f4fafb4cfea4e74dacdc8591c818dc
 SHA512:
-  metadata.gz: 602eecab29188077b177d9db096c4273c100c6ff29c7e2c1d086ca3e0ba500861f89283c687a52ea3fff4ac9a5d096410694133a79da5549a7c7d03193582fef
-  data.tar.gz: 014240210b412a6287b7fc9e17339e719ddca9639225f40cafee860ee5a5aa140e442a5068fd0e0034af53d905739052d8d435810ece7da667b69f9bf4f8e676
+  metadata.gz: 94c4b02f0c647c39c96e84e05b90486115afd2f72e11ffafec550b96d1deb4d98ae978063260b8d7f9a76a9d23f64c480bc235b0bcac61bfa7ba84d80f83cdf1
+  data.tar.gz: a61c8a315b1924be46ac68478d795d9c69539a1831364ec05aa82f7200d0f18549ba09e3933338e2d50977cb9230c5f9e49b77dcf2e12d6905f9c4c683647a48

data/README.md

@@ -112,6 +112,8 @@ Then fill it with your data. Below are the available configuration options:
 - `config.autodiscover_responses`: Automatically detects responses from controller renders. Default is `true`.
 - `config.api_path`: Sets the API path if your API is under a different namespace.
 - `config.ignored_actions`: Sets an array with the controller or controller#action. No necessary to add api_path before.
+- `config.http_verbs`: Defaults to `[:get, :post, :put, :patch, :delete]`
+- `config.use_model_names`: Use model names when possible, defaults to `false`
 
 ### Authentication Settings
 

data/app/views/oas_rails/oas_rails/index.html.erb

@@ -13,3 +13,7 @@
   allow-spec-file-download="true"
   >
 </rapi-doc>
+
+<style>
+  rapi-doc::part(btn btn-outline){ width: 220px; min-width: 170px; }
+</style>

data/lib/oas_rails/configuration.rb

@@ -11,7 +11,9 @@ module OasRails
                   :authenticate_all_routes_by_default,
                   :set_default_responses,
                   :possible_default_responses,
-                  :response_body_of_default
+                  :response_body_of_default,
+                  :http_verbs,
+                  :use_model_names
     attr_reader :servers, :tags, :security_schema
 
     def initialize
@@ -30,7 +32,9 @@ module OasRails
       @security_schemas = {}
       @set_default_responses = true
       @possible_default_responses = [:not_found, :unauthorized, :forbidden]
+      @http_verbs = [:get, :post, :put, :patch, :delete]
       @response_body_of_default = "Hash{ success: !Boolean, message: String }"
+      @use_model_names = false
     end
 
     def security_schema=(value)

data/lib/oas_rails/spec/components.rb

@@ -44,9 +44,20 @@ module OasRails
       end
 
       def add_schema(schema)
-        key = Hashable.generate_hash(schema)
-        @schemas[key] = schema if @schemas[key].nil?
+        key = nil
+        if OasRails.config.use_model_names
+          if schema[:type] == 'array'
+            arr_schema = schema[:items]
+            arr_key = arr_schema['title']
+            key = "#{arr_key}List" unless arr_key.nil?
+          else
+            key = schema['title']
+          end
+        end
+
+        key = Hashable.generate_hash(schema) if key.nil?
 
+        @schemas[key] = schema if @schemas[key].nil?
         schema_reference(key)
       end
 

data/lib/oas_rails/spec/path_item.rb

@@ -26,7 +26,7 @@ module OasRails
       end
 
       def oas_fields
-        [:get, :post, :put, :patch, :delete]
+        OasRails.config.http_verbs
       end
     end
   end

data/lib/oas_rails/version.rb

@@ -1,3 +1,3 @@
 module OasRails
-  VERSION = "0.8.2"
+  VERSION = "0.8.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oas_rails
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.4
 platform: ruby
 authors:
 - a-chacon
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-11 00:00:00.000000000 Z
+date: 2025-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -128,7 +128,7 @@ licenses:
 - GPL-3.0-only
 metadata:
   homepage_uri: https://github.com/a-chacon/oas_rails
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.11
-signing_key: 
+signing_key:
 specification_version: 4
 summary: OasRails is a Rails engine for generating automatic interactive documentation
   for your Rails APIs.