Ruby API Annotation DSL

baz_serializer.rb

class BazSerializer < BaseSerializer
  attribtes :id, :thing, :bar
  
  deprecated_attribute :old_thing
    deprecation_flag: ::FeatureFlags::DEPRECATED_FEATURE_FOO,
    upgrade_instructions: <<-INSTRUCTIONS
      Replace `baz.old_thing` with `baz.thing`
    INSTRUCTIONS

  deprecated_belongs_to :foo
    deprecation_flag: ::FeatureFlags::DEPRECATED_FEATURE_FOO,
    upgrade_instructions: <<-INSTRUCTIONS
      Replace `baz.foo.bar` with `baz.bar`
    INSTRUCTIONS
end

foo_serializer.rb

FooSerializer = DeprecatedSerializer.new do
  deprecation_flag ::FeatureFlags::DEPRECATED_FEATURE_FOO
  upgrade_instructions <<-INSTRUCTIONS
    Replace Usage of `foo` with usage of `baz`
  INSTRUCTIONS

  attributes :id, :bar
  
  has_one :baz
end