apiwork 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e82aa84563a02e2459a6d464c65cd50e5bb3edcb762a0a5b9412e79475663c52
-  data.tar.gz: ac7da6d7f57a6be553fa8809da6f449029ac9d9c42e4da24c780e9f4364c1a4a
+  metadata.gz: e7d4674d14687a7f9eb3547135c22df22c1cada2dc55b7f2b0f011462d20bf1a
+  data.tar.gz: f580dcdf234e49b933b1636f2a2c14d2ca11caf4d5364a70ec574763978c834c
 SHA512:
-  metadata.gz: 4f7bd06c06cb8485762e066e8efb64d21af6258b85442bbbc9813b1359e3d38706314dd285fe48de42d8a5526590c08508c436abdb8acfe0c23c203ade8391db
-  data.tar.gz: 7ce587bd8232382e56a8f5da4ba33d1dd942482e018e1e968aacb1f1a6be8bb778d85dec4ee425799a350b0afdd7a4c7277c264b661209bb16f6404e7ec9bf32
+  metadata.gz: 33a16b4c739c5c13ba2374882d0997bea4cda29b00eef1c1afe7c810fe0247fab1ca6568bb225ac8e32617742b0ff9df85920518db7a4c062a223cdc688cee6b
+  data.tar.gz: d707cbf17e3df65f57a523e7695b5ce2c7d009b3aa28599b071fb0ec1ba910281af9224493708214654a979ffe6362d661d6d5410bcec93ffadc08e37c9f6f96

data/lib/apiwork/adapter/serializer/resource/default/contract_builder.rb

@@ -59,6 +59,8 @@ module Apiwork
                 end
 
                 representation_class.attributes.each do |name, attribute|
+                  next if attribute.write_only?
+
                   param_options = {
                     deprecated: attribute.deprecated?,
                     description: attribute.description,

data/lib/apiwork/representation/attribute.rb

@@ -83,7 +83,8 @@ module Apiwork
                   :of,
                   :optional,
                   :preload,
-                  :type
+                  :type,
+                  :write_only
 
       def initialize(
         name,
@@ -105,6 +106,7 @@ module Apiwork
         sortable: false,
         type: nil,
         writable: false,
+        write_only: false,
         &block
       )
         @name = name
@@ -157,6 +159,7 @@ module Apiwork
         @example = example
         @format = format
         @deprecated = deprecated
+        @write_only = write_only
 
         validate_min_max_range!
         validate_format!
@@ -225,6 +228,14 @@ module Apiwork
         [true, action].include?(@writable)
       end
 
+      # @api public
+      # Whether this attribute is write-only.
+      #
+      # @return [Boolean]
+      def write_only?
+        @write_only
+      end
+
       def encode(value)
         result = @empty && value.nil? ? '' : value
         @encode ? @encode.call(result) : result

data/lib/apiwork/representation/base.rb

@@ -222,6 +222,9 @@ module Apiwork
         #   Use an explicit type or block in those cases.
         # @param writable [Boolean, Symbol] (false) [:create, :update]
         #   The write access. `true` for both create and update, `:create` for create only, `:update` for update only.
+        # @param write_only [Boolean] (false)
+        #   Whether the attribute is write-only. Write-only attributes are excluded from response
+        #   serialization and response types but remain in writable payloads.
         # @yieldparam element [Representation::Element]
         # @return [void]
         #
@@ -286,6 +289,7 @@ module Apiwork
           sortable: false,
           type: nil,
           writable: false,
+          write_only: false,
           &block
         )
           self.attributes = attributes.merge(
@@ -309,6 +313,7 @@ module Apiwork
               sortable:,
               type:,
               writable:,
+              write_only:,
               &block
             ),
           )

data/lib/apiwork/representation/serializer.rb

@@ -21,6 +21,8 @@ module Apiwork
         add_discriminator_field(fields) if @representation_class.subclass?
 
         @representation_class.attributes.each do |name, attribute|
+          next if attribute.write_only?
+
           value = @representation.respond_to?(name) ? @representation.public_send(name) : @representation.record.public_send(name)
           value = map_type_column_output(name, value)
           value = attribute.encode(value)

data/lib/apiwork/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Apiwork
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apiwork
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - skiftle
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-03 00:00:00.000000000 Z
+date: 2026-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails