From de77f5d834828fe5283f4e795a6564373a03e7ab Mon Sep 17 00:00:00 2001 From: Martin Eiber Date: Thu, 12 Sep 2024 11:05:09 +0200 Subject: [PATCH] [Role Management] List all available Roles (#421) * Fix endpoint description. * Add description. --- src/Role/Controller/GetRolesController.php | 1 + translations/studio_api_docs.en.yaml | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/src/Role/Controller/GetRolesController.php b/src/Role/Controller/GetRolesController.php index b50c748af..35afd8831 100644 --- a/src/Role/Controller/GetRolesController.php +++ b/src/Role/Controller/GetRolesController.php @@ -51,6 +51,7 @@ public function __construct( #[Get( path: self::API_PATH . '/roles', operationId: 'role_get_collection', + description: 'role_get_collection_description', summary: 'role_get_collection_summary', tags: [Tags::Role->value] )] diff --git a/translations/studio_api_docs.en.yaml b/translations/studio_api_docs.en.yaml index 12cc03b7b..c79128def 100644 --- a/translations/studio_api_docs.en.yaml +++ b/translations/studio_api_docs.en.yaml @@ -349,8 +349,9 @@ role_folder_create_summary: Create a new role folder. role_folder_delete_by_id_summary: Delete a specific folder with all sub roles. role_get_by_id_success_response: List of available user roles. role_get_by_id_summary: Get all available user roles. -role_get_collection_success_response: Role data. -role_get_collection_summary: Get role by id. +role_get_collection_success_response: List of available roles. +role_get_collection_summary: Get all available roles. +role_get_collection_description: Get all available roles with basic information role_get_tree_success_response: Collection of roles including folders for the given parent id. role_get_tree_summary: Get collection of roles for tree view. role_update_by_id_response: Updated data.