Add title and print_width fields to properties

[pve-access-control.git] / PVE / API2 / Role.pm

diff --git a/PVE/API2/Role.pm b/PVE/API2/Role.pm
index bc77305ef54ed6302bd378e3088f5c3d16770d63..156d3b89bc4015060ae851bd180bd10a7ce2c394 100644 (file)
--- a/PVE/API2/Role.pm
+++ b/PVE/API2/Role.pm
@@ -4,6 +4,7 @@ use strict;
 use warnings;
 use PVE::Cluster qw (cfs_read_file cfs_write_file);
 use PVE::AccessControl;
+use PVE::JSONSchema qw(get_standard_option register_standard_option);
 
 use PVE::SafeSyslog;
 
@@ -11,6 +12,18 @@ use PVE::RESTHandler;
 
 use base qw(PVE::RESTHandler);
 
+register_standard_option('role-id', {
+    type => 'string',
+    format => 'pve-roleid',
+    title => 'Role ID',
+    print_width => 30
+});
+register_standard_option('role-privs', {
+    type => 'string' ,
+    format => 'pve-priv-list',
+    optional => 1, title => 'Privileges',
+});
+
 __PACKAGE__->register_method ({
     name => 'index',
     path => '',
@@ -28,7 +41,9 @@ __PACKAGE__->register_method ({
        items => {
            type => "object",
            properties => {
-               roleid => { type => 'string' },
+               roleid => get_standard_option('role-id'),
+               privs =>  get_standard_option('role-privs'),
+               special => { type => 'boolean', optional => 1, default => 0, title => 'Built-In' },
            },
        },
        links => [ { rel => 'child', href => "{roleid}" } ],
@@ -42,8 +57,11 @@ __PACKAGE__->register_method ({
 
        foreach my $role (keys %{$usercfg->{roles}}) {
            my $privs = join(',', sort keys %{$usercfg->{roles}->{$role}});
-           push @$res, { roleid => $role, privs => $privs,
-               special => PVE::AccessControl::role_is_special($role) };
+           push @$res, {
+               roleid => $role,
+               privs => $privs,
+               special => PVE::AccessControl::role_is_special($role),
+           };
        }
 
        return $res;
@@ -61,8 +79,8 @@ __PACKAGE__->register_method ({
     parameters => {
        additionalProperties => 0,
        properties => {
-           roleid => { type => 'string', format => 'pve-roleid' },
-           privs => { type => 'string' , format => 'pve-priv-list', optional => 1 },
+           roleid => get_standard_option('role-id'),
+           privs =>  get_standard_option('role-privs'),
        },
     },
     returns => { type => 'null' },
@@ -97,17 +115,13 @@ __PACKAGE__->register_method ({
     permissions => {
        check => ['perm', '/access', ['Sys.Modify']],
     },
-    description => "Create new role.",
+    description => "Update an existing role.",
     parameters => {
        additionalProperties => 0,
        properties => {
-           roleid => { type => 'string', format => 'pve-roleid' },
-           privs => { type => 'string' , format => 'pve-priv-list' },
-           append => {
-               type => 'boolean',
-               optional => 1,
-               requires => 'privs',
-           },
+           roleid => get_standard_option('role-id'),
+           privs =>  get_standard_option('role-privs'),
+           append => { type => 'boolean', optional => 1, requires => 'privs' },
        },
     },
     returns => { type => 'null' },
@@ -134,7 +148,6 @@ __PACKAGE__->register_method ({
        return undef;
 }});
 
-# fixme: return format!
 __PACKAGE__->register_method ({
     name => 'read_role',
     path => '{roleid}',
@@ -146,10 +159,16 @@ __PACKAGE__->register_method ({
     parameters => {
        additionalProperties => 0,
        properties => {
-           roleid => { type => 'string' , format => 'pve-roleid' },
+           roleid => get_standard_option('role-id'),
+       },
+    },
+    returns => {
+       type => "object",
+       additionalProperties => 0,
+       properties => {
+           privs =>  get_standard_option('role-privs'),
        },
     },
-    returns => {},
     code => sub {
        my ($param) = @_;
 
@@ -162,7 +181,8 @@ __PACKAGE__->register_method ({
        die "role '$role' does not exist\n" if !$data;
 
        return $data;
-}});
+    }
+});
 
 __PACKAGE__->register_method ({
     name => 'delete_role',
@@ -176,8 +196,8 @@ __PACKAGE__->register_method ({
     parameters => {
        additionalProperties => 0,
        properties => {
-           roleid => { type => 'string', format => 'pve-roleid' },
-       }
+           roleid => get_standard_option('role-id'),
+       },
     },
     returns => { type => 'null' },
     code => sub {
@@ -203,6 +223,7 @@ __PACKAGE__->register_method ({
            }, "delete role failed");
 
        return undef;
-}});
+    }
+});
 
 1;