stefan-kolb/nucleus

module Nucleus
  module API
    module Models
      class InstalledServiceProperty < Grape::Entity
        # The name of the entity to be used
        def self.entity_name
          'InstalledServiceProperty'
        end

        # all properties are read only

        expose :key, documentation: {
          type: String, desc: 'Name of the property, e.g. \'database_name\'',
          required: true
        }

        expose :value, documentation: {
          type: String, desc: 'Value of the property, e.g. \'myapp_db_1\'',
          required: true
        }

        expose :description, documentation: {
          type: String, desc: 'A rather short description of the property',
          required: true
        }
      end
    end
  end
end