diff --git a/perun-openapi/openapi.yml b/perun-openapi/openapi.yml index 9201e09a20..c6020330b6 100644 --- a/perun-openapi/openapi.yml +++ b/perun-openapi/openapi.yml @@ -3350,7 +3350,7 @@ components: complementaryObjectName: name: complementaryObjectName - description: "Property beanName of complementaryObject, meaning object type (Vo | Group | Facility | ... )" + description: "Property beanName of complementaryObject, meaning object type (supported object types: Group | RichGroup | Vo | Resource | Facility | SecurityTeam )" schema: type: string in: query @@ -3941,7 +3941,7 @@ paths: application/json: schema: title: setRoleWithUserComplementaryObject - description: "input to setRoleWithUserComplementaryObject" + description: "input to setRoleWithUserComplementaryObject (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam )" type: object required: - role @@ -3983,7 +3983,7 @@ paths: user: { type: integer, description: "user id", nullable: false } complementaryObjects: type: array - description: "List of complementary objects" + description: "List of complementary objects (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam )" nullable: false items: $ref: "#/components/schemas/PerunBean" @@ -4005,7 +4005,7 @@ paths: application/json: schema: title: unsetRoleWithUserComplementaryObject - description: "input to unsetRoleWithUserComplementaryObject" + description: "input to unsetRoleWithUserComplementaryObject (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam )" type: object required: - role @@ -4047,7 +4047,7 @@ paths: user: { type: integer, description: "user id", nullable: false } complementaryObjects: type: array - description: "List of complementary objects" + description: "List of complementary objects (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam )" nullable: false items: $ref: "#/components/schemas/PerunBean" @@ -4121,7 +4121,7 @@ paths: application/json: schema: title: setRoleWithGroupComplementaryObject - description: "input to unsetRoleWithUserComplementaryObject" + description: "input to unsetRoleWithUserComplementaryObject (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam )" type: object required: - role @@ -4163,7 +4163,7 @@ paths: authorizedGroup: { type: integer, nullable: false } complementaryObjects: type: array - description: "List of complementary objects" + description: "List of complementary objects (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam )" nullable: false items: $ref: "#/components/schemas/PerunBean" @@ -4185,7 +4185,7 @@ paths: application/json: schema: title: unsetRoleWithGroupComplementaryObject - description: "input to unsetRoleWithUserComplementaryObject" + description: "input to unsetRoleWithUserComplementaryObject (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam )" type: object required: - role @@ -4227,7 +4227,7 @@ paths: authorizedGroup: { type: integer, nullable: false } complementaryObjects: type: array - description: "List of complementary objects" + description: "List of complementary objects (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam )" nullable: false items: $ref: "#/components/schemas/PerunBean" diff --git a/perun-rpc/src/main/java/cz/metacentrum/perun/rpc/methods/AuthzResolverMethod.java b/perun-rpc/src/main/java/cz/metacentrum/perun/rpc/methods/AuthzResolverMethod.java index ccf308ff8d..6afa6f3346 100644 --- a/perun-rpc/src/main/java/cz/metacentrum/perun/rpc/methods/AuthzResolverMethod.java +++ b/perun-rpc/src/main/java/cz/metacentrum/perun/rpc/methods/AuthzResolverMethod.java @@ -154,7 +154,7 @@ public AuthzRoles call(ApiCaller ac, Deserializer parms) throws PerunException { * * @param role String Expected Role to filter managers by * @param complementaryObjectId int Property id of complementaryObject to get managers for - * @param complementaryObjectName String Property beanName of complementaryObject, meaning object type (Vo | Group | Facility | ... ) + * @param complementaryObjectName String Property beanName of complementaryObject, meaning object type (supported object types: Group | RichGroup | Vo | Resource | Facility | SecurityTeam ). * @param specificAttributes List list of specified attributes which are needed in object richUser * @param onlyDirectAdmins boolean When true, return only direct users of the complementary object for role with specific attributes * @param allUserAttributes boolean When true, do not specify attributes through list and return them all in objects richUser. Ignoring list of specific attributes @@ -197,7 +197,7 @@ public List call(ApiCaller ac, Deserializer parms) throws PerunExcepti * * @param role String Expected Role to filter authorizedGroups by * @param complementaryObjectId int Property id of complementaryObject to get groups of managers for - * @param complementaryObjectName String Property beanName of complementaryObject, meaning object type (Vo | Group | Facility | ... ) + * @param complementaryObjectName String Property beanName of complementaryObject, meaning object type (supported object types: Group | RichGroup | Vo | Resource | Facility | SecurityTeam ). * @return List List of authorizedGroups for complementaryObject and role */ getAdminGroups { @@ -239,7 +239,7 @@ public List call(ApiCaller ac, Deserializer parms) throws PerunException * * @param role String Role which will be set for given users ( FACILITYADMIN | GROUPADMIN | PERUNADMIN | RESOURCEADMIN | RESOURCESELFSERVICE | SPONSOR | TOPGROUPCREATOR | VOADMIN | VOOBSERVER | PERUNOBSERVER | SECURITYADMIN | CABINETADMIN | AUDITCONSUMERADMIN ) * @param user int id of User to set role for - * @param complementaryObject Object Object (e.g.: vo | group | facility ) to associate role and user with. + * @param complementaryObject Object Object to associate role and user with (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam ). * @exampleParam role "VOADMIN" * @exampleParam complementaryObject { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } */ @@ -253,7 +253,7 @@ public List call(ApiCaller ac, Deserializer parms) throws PerunException * * @param role String Role which will be set for given users ( FACILITYADMIN | GROUPADMIN | PERUNADMIN | RESOURCEADMIN | RESOURCESELFSERVICE | SPONSOR | TOPGROUPCREATOR | VOADMIN | VOOBSERVER | PERUNOBSERVER | SECURITYADMIN | CABINETADMIN | AUDITCONSUMERADMIN ) * @param user int id of User to set role for - * @param complementaryObjects List Objects (e.g.: vo | group | facility ) to associate role and user with + * @param complementaryObjects List Objects to associate role and user with (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam ). * @exampleParam role "VOADMIN" * @exampleParam complementaryObjects [ { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , {...} , {...} ] */ @@ -276,7 +276,7 @@ public List call(ApiCaller ac, Deserializer parms) throws PerunException * * @param role String Role which will be set for given users ( FACILITYADMIN | GROUPADMIN | PERUNADMIN | RESOURCEADMIN | RESOURCESELFSERVICE | SPONSOR | TOPGROUPCREATOR | VOADMIN | VOOBSERVER | PERUNOBSERVER | SECURITYADMIN | CABINETADMIN | AUDITCONSUMERADMIN ) * @param authorizedGroup int id of Group to set role for - * @param complementaryObject Object Object (e.g.: vo | group | facility ) to associate role and authorizedGroup with + * @param complementaryObject Object Object to associate role and authorizedGroup with (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam ). * @exampleParam role "VOADMIN" * @exampleParam complementaryObject { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } */ @@ -290,7 +290,7 @@ public List call(ApiCaller ac, Deserializer parms) throws PerunException * * @param role String Role which will be set for given users ( FACILITYADMIN | GROUPADMIN | PERUNADMIN | RESOURCEADMIN | RESOURCESELFSERVICE | SPONSOR | TOPGROUPCREATOR | VOADMIN | VOOBSERVER | PERUNOBSERVER | SECURITYADMIN | CABINETADMIN | AUDITCONSUMERADMIN ) * @param authorizedGroup int id of Group to set role for - * @param complementaryObjects List Objects (e.g.: vo | group | facility ) to associate role and authorizedGroup with + * @param complementaryObjects List Objects to associate role and authorizedGroup with (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam ). * @exampleParam role "VOADMIN" * @exampleParam complementaryObjects [ { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , {...} , {...} ] */ @@ -313,7 +313,7 @@ public List call(ApiCaller ac, Deserializer parms) throws PerunException * * @param role String Role which will be set for given users ( FACILITYADMIN | GROUPADMIN | PERUNADMIN | RESOURCEADMIN | RESOURCESELFSERVICE | SPONSOR | TOPGROUPCREATOR | VOADMIN | VOOBSERVER | PERUNOBSERVER | SECURITYADMIN | CABINETADMIN | AUDITCONSUMERADMIN ) * @param users int[] ids of users for which is the role set - * @param complementaryObject Object Object (e.g.: vo | group | facility ) to associate role and users with + * @param complementaryObject Object Object to associate role and users with (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam ). * @exampleParam role "VOADMIN" * @exampleParam complementaryObject { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } */ @@ -336,7 +336,7 @@ public List call(ApiCaller ac, Deserializer parms) throws PerunException * * @param role String Role which will be set for given groups ( FACILITYADMIN | GROUPADMIN | PERUNADMIN | RESOURCEADMIN | RESOURCESELFSERVICE | SPONSOR | TOPGROUPCREATOR | VOADMIN | VOOBSERVER | PERUNOBSERVER | SECURITYADMIN | CABINETADMIN | AUDITCONSUMERADMIN ) * @param authorizedGroups int[] ids of groups for which is the role set - * @param complementaryObject Object Object (e.g.: vo | group | facility ) to associate role and authorizedGroups with + * @param complementaryObject Object Object to associate role and authorizedGroups with (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam ). * @exampleParam role "VOADMIN" * @exampleParam complementaryObject { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } */ @@ -454,7 +454,7 @@ public Void call(ApiCaller ac, Deserializer parms) throws PerunException { * * @param role String Role which will be set for given users ( FACILITYADMIN | GROUPADMIN | PERUNADMIN | RESOURCEADMIN | RESOURCESELFSERVICE | SPONSOR | TOPGROUPCREATOR | VOADMIN | VOOBSERVER | PERUNOBSERVER | SECURITYADMIN | CABINETADMIN | AUDITCONSUMERADMIN ) * @param user int id of User to unset role for - * @param complementaryObject Object Object (e.g.: vo | group | facility ) to remove role for a user + * @param complementaryObject Object Object to remove role for a user (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam ). * @exampleParam role "voadmin" * @exampleParam complementaryObject { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } */ @@ -468,7 +468,7 @@ public Void call(ApiCaller ac, Deserializer parms) throws PerunException { * * @param role String Role which will be set for given users ( FACILITYADMIN | GROUPADMIN | PERUNADMIN | RESOURCEADMIN | RESOURCESELFSERVICE | SPONSOR | TOPGROUPCREATOR | VOADMIN | VOOBSERVER | PERUNOBSERVER | SECURITYADMIN | CABINETADMIN | AUDITCONSUMERADMIN ) * @param user int id of User to unset role for - * @param complementaryObjects List Objects (e.g.: vo | group | facility ) to remove role for a user + * @param complementaryObjects List Objects to remove role for a user (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam ). * @exampleParam role "voadmin" * @exampleParam complementaryObjects [ { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , {...} , {...} ] */ @@ -491,7 +491,7 @@ public Void call(ApiCaller ac, Deserializer parms) throws PerunException { * * @param role String Role which will be set for given users ( FACILITYADMIN | GROUPADMIN | PERUNADMIN | RESOURCEADMIN | RESOURCESELFSERVICE | SPONSOR | TOPGROUPCREATOR | VOADMIN | VOOBSERVER | PERUNOBSERVER | SECURITYADMIN | CABINETADMIN | AUDITCONSUMERADMIN ) * @param authorizedGroup int id of Group to unset role for - * @param complementaryObject Object Object (e.g.: vo | group | facility ) to remove role for an authorizedGroup + * @param complementaryObject Object Object to remove role for an authorizedGroup (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam ). * @exampleParam role "voadmin" * @exampleParam complementaryObject { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } */ @@ -505,7 +505,7 @@ public Void call(ApiCaller ac, Deserializer parms) throws PerunException { * * @param role String Role which will be set for given users ( FACILITYADMIN | GROUPADMIN | PERUNADMIN | RESOURCEADMIN | RESOURCESELFSERVICE | SPONSOR | TOPGROUPCREATOR | VOADMIN | VOOBSERVER | PERUNOBSERVER | SECURITYADMIN | CABINETADMIN | AUDITCONSUMERADMIN ) * @param authorizedGroup int id of Group to unset role for - * @param complementaryObjects List Objects (e.g.: vo | group | facility ) to remove role for an authorizedGroup + * @param complementaryObjects List Objects to remove role for an authorizedGroup (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam ). * @exampleParam role "voadmin" * @exampleParam complementaryObjects [ { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , {...} , {...} ] */ @@ -528,7 +528,7 @@ public Void call(ApiCaller ac, Deserializer parms) throws PerunException { * * @param role String Role which will be unset for given users ( FACILITYADMIN | GROUPADMIN | PERUNADMIN | RESOURCEADMIN | RESOURCESELFSERVICE | SPONSOR | TOPGROUPCREATOR | VOADMIN | VOOBSERVER | PERUNOBSERVER | SECURITYADMIN | CABINETADMIN | AUDITCONSUMERADMIN ) * @param users int[] ids of users for which is the role set - * @param complementaryObject Object Object (e.g.: vo | group | facility ) to associate role and users with + * @param complementaryObject Object Object to remove role for a users (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam ). * @exampleParam role "VOADMIN" * @exampleParam complementaryObject { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } */ @@ -551,7 +551,7 @@ public Void call(ApiCaller ac, Deserializer parms) throws PerunException { * * @param role String Role which will be set for given groups ( FACILITYADMIN | GROUPADMIN | PERUNADMIN | RESOURCEADMIN | RESOURCESELFSERVICE | SPONSOR | TOPGROUPCREATOR | VOADMIN | VOOBSERVER | PERUNOBSERVER | SECURITYADMIN | CABINETADMIN | AUDITCONSUMERADMIN ) * @param authorizedGroups int[] ids of groups for which is the role set - * @param complementaryObject Object Object (e.g.: vo | group | facility ) to associate role and authorizedGroups with + * @param complementaryObject Object Object to remove role for an authorizedGroups (supported objects: Group | RichGroup | Vo | Resource | Facility | SecurityTeam ). * @exampleParam role "VOADMIN" * @exampleParam complementaryObject { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } */