Improved doc.

This commit is contained in:
Martin Edenhofer 2016-01-20 23:03:10 +01:00
parent a386f23555
commit ead406c220

View file

@ -43,8 +43,8 @@ list of all attributes
result = [ result = [
{ {
:name => 'some name', name: 'some name',
:display => '...', display: '...',
}. }.
], ],
@ -129,8 +129,8 @@ add a new attribute entry for an object
get the attribute model based on object and name get the attribute model based on object and name
attribute = ObjectManager::Attribute.get( attribute = ObjectManager::Attribute.get(
:object => 'Ticket', object: 'Ticket',
:name => 'group_id', name: 'group_id',
) )
=end =end
@ -157,9 +157,9 @@ get user based list of object attributes
returns: returns:
[ [
{ :name => 'api_key', :display => 'API KEY', :tag => 'input', :null => true, :edit => true, :maxlength => 32 }, { name: 'api_key', display: 'API KEY', tag: 'input', null: true, edit: true, maxlength: 32 },
{ :name => 'api_ip_regexp', :display => 'API IP RegExp', :tag => 'input', :null => true, :edit => true }, { name: 'api_ip_regexp', display: 'API IP RegExp', tag: 'input', null: true, edit: true },
{ :name => 'api_ip_max', :display => 'API IP Max', :tag => 'input', :null => true, :edit => true }, { name: 'api_ip_max', display: 'API IP Max', tag: 'input', null: true, edit: true },
] ]
=end =end
@ -214,9 +214,9 @@ get user based list of object attributes as hash
returns: returns:
{ {
'api_key' => { :name => 'api_key', :display => 'API KEY', :tag => 'input', :null => true, :edit => true, :maxlength => 32 }, 'api_key' => { name: 'api_key', display: 'API KEY', tag: 'input', null: true, edit: true, maxlength: 32 },
'api_ip_regexp' => { :name => 'api_ip_regexp', :display => 'API IP RegExp', :tag => 'input', :null => true, :edit => true }, 'api_ip_regexp' => { name: 'api_ip_regexp', display: 'API IP RegExp', tag: 'input', null: true, edit: true },
'api_ip_max' => { :name => 'api_ip_max', :display => 'API IP Max', :tag => 'input', :null => true, :edit => true }, 'api_ip_max' => { name: 'api_ip_max', display: 'API IP Max', tag: 'input', null: true, edit: true },
} }
=end =end