rswag-schema_components 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: def74130974a6329b0920949d31cebf6f4baaa9793a4564e0fc6eb2d48f45791
-  data.tar.gz: 1dd91453b48237f28b2e20c9f4b697b1093607ab3b0aeb6d106ee1660ed17296
+  metadata.gz: e4a83a9214d990e259d26b551a5cec0c13d91c6ca42d0b452303854bd68ab04a
+  data.tar.gz: e212ca7db382ef8ae1b4c66a49e7c65ee3f6650ffe58e64989379d759b0c078c
 SHA512:
-  metadata.gz: 6aab8d92127314e2a2bbd8b6c3e77fd42d193ca4192591a30546fcae82c2c6c5146eee4520170de71ead000cd89cd3b1412494eafd00f6c37b9fab085df24f50
-  data.tar.gz: 38d454499a3376a05de446cda72741cd2f9ea3ab5144b74a9c669277b7318506b38c73bfab7597983e8bbae7ad5157f9ff398415296a45088942f2e496a602d8
+  metadata.gz: 491792f034575c3bda0d4e188a58fbe80ceae052c418f1342ebb18ecfaa96d615e7726c1c31d2e560ae3cbe7d4ab577695c0999db75a81a1256f0b595c4c615b
+  data.tar.gz: c613bd114d13304bc6627f3b6acf69707f56a877c12095c4b7216e20548e5a02acfd6118d6c8cc85f2fe9b3f5ab134dbc6ff6ab8e006600ebe7cab1db2fc0a53

data/lib/rswag/schema_components/component.rb

@@ -7,7 +7,7 @@ module Rswag
 
       included do
         class << self
-          attr_accessor :schema_value
+          attr_accessor :schema_value, :schema_hidden_value
 
           def schema(schema_definition)
             self.schema_value = if superclass.respond_to?(:schema_value)
@@ -17,11 +17,19 @@ module Rswag
               schema_definition
             end
           end
+
+          def schema_hidden(flag = false)
+            self.schema_hidden_value = flag
+          end
         end
 
         def to_schema
           self.class.schema_value
         end
+
+        def hidden?
+          self.class.schema_hidden_value
+        end
       end
     end
   end

data/lib/rswag/schema_components/loader.rb

@@ -27,18 +27,29 @@ module Rswag
         load_classes.each do |klass|
           component_name = extract_component_name(klass)
 
-          definition = klass.new.to_schema
+          component = klass.new
+          definition = component.to_schema
+
+          if component.hidden?
+            next
+          end
 
           if components[component_name].present?
             raise "Duplicate component name \"#{component_name}\" found in \"#{definitions_path}\""
           end
 
-          components[component_name] = definition.merge(title: component_name)
+          definition = definition.merge(title: component_name) if type_allows_title?
+
+          components[component_name] = definition
         end
 
         components
       end
 
+      private def type_allows_title?
+        type == "schemas"
+      end
+
       private def load_classes
         Dir.glob(base_path.join("#{definitions_path}/**/*")).filter_map do |file_path|
           next if File.directory?(file_path)

data/lib/rswag/schema_components/version.rb

@@ -1,5 +1,5 @@
 module Rswag
   module SchemaComponents
-    VERSION = "0.1.5"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rswag-schema_components
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Marten Klitzke
 bindir: bin
 cert_chain: []
-date: 2025-04-03 00:00:00.000000000 Z
+date: 2025-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails