From d258628517d2e5d8bb8aa57d6f34b6a8616a264b Mon Sep 17 00:00:00 2001 From: "camunda-docs-pr-automation[bot]" <187566563+camunda-docs-pr-automation[bot]@users.noreply.github.com> Date: Fri, 7 Mar 2025 19:05:22 +0000 Subject: [PATCH] docs: update REST API spec (#5191) Co-authored-by: tmetzke --- api/camunda/camunda-openapi.yaml | 91 ++++++++++++++----- .../specifications/add-user-to-group.api.mdx | 11 ++- .../specifications/create-group.api.mdx | 15 +-- .../specifications/create-role.api.mdx | 11 ++- .../specifications/delete-group.api.mdx | 11 ++- .../delete-mapping-rule.api.mdx | 11 ++- .../specifications/delete-role.api.mdx | 11 ++- .../specifications/find-mappings.api.mdx | 11 ++- .../specifications/find-users.api.mdx | 4 +- .../specifications/get-group.api.mdx | 11 ++- .../specifications/get-role.api.mdx | 13 ++- .../specifications/search-groups.api.mdx | 11 ++- .../specifications/search-roles.api.mdx | 13 ++- .../search-users-for-tenant.api.mdx | 4 +- .../specifications/sidebar.ts | 28 +++--- .../unassign-user-from-group.api.mdx | 11 ++- .../specifications/update-group.api.mdx | 11 ++- .../specifications/update-role.api.mdx | 11 ++- 18 files changed, 190 insertions(+), 99 deletions(-) diff --git a/api/camunda/camunda-openapi.yaml b/api/camunda/camunda-openapi.yaml index d97b7a0851b..b571dc863c0 100644 --- a/api/camunda/camunda-openapi.yaml +++ b/api/camunda/camunda-openapi.yaml @@ -2113,9 +2113,12 @@ paths: tags: - Role operationId: createRole - summary: Create role + summary: Create role (Work-in-Progress) description: | Create a new role. + + This API is in a Work-in-Progress state and will undergo potential breaking changes till + its release with an upcoming minor release. requestBody: content: application/json: @@ -2142,9 +2145,12 @@ paths: tags: - Role operationId: getRole - summary: Get role + summary: Get role (Work-in-Progress) description: | Get a role by its key. + + This API is in a Work-in-Progress state and will undergo potential breaking changes till + its release with an upcoming minor release. parameters: - name: roleKey in: path @@ -2175,8 +2181,12 @@ paths: tags: - Role operationId: updateRole - summary: Update role - description: Update a role with the given key. + summary: Update role (Work-in-Progress) + description: | + Update a role with the given key. + + This API is in a Work-in-Progress state and will undergo potential breaking changes till + its release with an upcoming minor release. parameters: - name: roleKey in: path @@ -2209,8 +2219,12 @@ paths: tags: - Role operationId: deleteRole - summary: Delete role - description: Deletes the role with the given key. + summary: Delete role (Work-in-Progress) + description: | + Deletes the role with the given key. + + This API is in a Work-in-Progress state and will undergo potential breaking changes till + its release with an upcoming minor release. parameters: - name: roleKey in: path @@ -2236,9 +2250,12 @@ paths: tags: - Role operationId: searchRoles - summary: Query roles + summary: Query roles (Work-in-Progress) description: | Search for roles based on given criteria. + + This API is in a Work-in-Progress state and will undergo potential breaking changes till + its release with an upcoming minor release. requestBody: required: false content: @@ -2270,7 +2287,12 @@ paths: tags: - Group operationId: createGroup - summary: Create group + summary: Create group (Work-in-Progress) + description: | + Create a new group. + + This API is in a Work-in-Progress state and will undergo potential breaking changes till + its release with an upcoming minor release. requestBody: content: application/json: @@ -2296,9 +2318,12 @@ paths: tags: - Group operationId: getGroup - summary: Get group + summary: Get group (Work-in-Progress) description: | Get a group by its key. + + This API is in a Work-in-Progress state and will undergo potential breaking changes till + its release with an upcoming minor release. parameters: - name: groupKey in: path @@ -2329,8 +2354,12 @@ paths: tags: - Group operationId: updateGroup - summary: Update group - description: Update a group with the given key. + summary: Update group (Work-in-Progress) + description: | + Update a group with the given key. + + This API is in a Work-in-Progress state and will undergo potential breaking changes till + its release with an upcoming minor release. parameters: - name: groupKey in: path @@ -2363,8 +2392,12 @@ paths: tags: - Group operationId: deleteGroup - summary: Delete group - description: Deletes the group with the given key. + summary: Delete group (Work-in-Progress) + description: | + Deletes the group with the given key. + + This API is in a Work-in-Progress state and will undergo potential breaking changes till + its release with an upcoming minor release. parameters: - name: groupKey in: path @@ -2390,9 +2423,12 @@ paths: tags: - Group operationId: addUserToGroup - summary: Assign a user to a group + summary: Assign a user to a group (Work-in-Progress) description: | Assigns a user to a group. + + This API is in a Work-in-Progress state and will undergo potential breaking changes till + its release with an upcoming minor release. parameters: - name: groupKey in: path @@ -2432,9 +2468,12 @@ paths: tags: - Group operationId: unassignUserFromGroup - summary: Unassign a user from a group + summary: Unassign a user from a group (Work-in-Progress) description: | Unassigns a user from a group. + + This API is in a Work-in-Progress state and will undergo potential breaking changes till + its release with an upcoming minor release. parameters: - name: groupKey in: path @@ -2468,9 +2507,12 @@ paths: tags: - Group operationId: searchGroups - summary: Query groups + summary: Query groups (Work-in-Progress) description: | Search for groups based on given criteria. + + This API is in a Work-in-Progress state and will undergo potential breaking changes till + its release with an upcoming minor release. requestBody: required: false content: @@ -2540,8 +2582,12 @@ paths: tags: - Mapping rule operationId: deleteMappingRule - summary: Delete a mapping rule - description: Deletes the mapping rule with the given key. + summary: Delete a mapping rule (Work-in-Progress) + description: | + Deletes the mapping rule with the given key. + + This API is in a Work-in-Progress state and will undergo potential breaking changes till + its release with an upcoming minor release. parameters: - name: mappingKey in: path @@ -2568,9 +2614,12 @@ paths: tags: - Mapping rule operationId: findMappings - summary: Query mappings + summary: Query mappings (Work-in-Progress) description: | Search for mapping rules based on given criteria. + + This API is in a Work-in-Progress state and will undergo potential breaking changes till + its release with an upcoming minor release. requestBody: content: application/json: @@ -5190,7 +5239,7 @@ components: email: description: The email of the user. type: "string" - key: + userKey: description: The key of the user. type: "string" UserSearchResult: @@ -5250,7 +5299,7 @@ components: name: type: string description: The role name. - key: + roleKey: type: string description: The role key. assignedMemberKeys: diff --git a/docs/apis-tools/camunda-api-rest/specifications/add-user-to-group.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/add-user-to-group.api.mdx index 5d9dcd5b97e..94b0941a946 100644 --- a/docs/apis-tools/camunda-api-rest/specifications/add-user-to-group.api.mdx +++ b/docs/apis-tools/camunda-api-rest/specifications/add-user-to-group.api.mdx @@ -1,11 +1,11 @@ --- id: add-user-to-group -title: "Assign a user to a group" +title: "Assign a user to a group (Work-in-Progress)" description: "Assigns a user to a group." -sidebar_label: "Assign a user to a group" +sidebar_label: "Assign a user to a group (Work-in-Progress)" hide_title: true hide_table_of_contents: true -api: eJztWE1z2zYQ/SsYnJIpI8qJkzq8aRw7dZumHltuD64PS2IlIgEBBgAtczj8750FSFuRZCfj6VEHjUQC2A/se1joddzD0vHsmn+0pqn5TcJNjRa8NPpM8IyDEFcO7dzE8YQLdIWVNU3gGZ85J5faMWCNQ8u8YcCWNHPyr+YJr8FChR4tuei4hgp5xsOEP7DlCZdkpAZf8oRb/NZIi4Jn3ja46WleYrTMvmI74Ql3RYkV8Kzjvq3JrPNW6iXv++TeEwX1HEchmcf8SO1xiZYnfGFsBT6+enfI+/6GjLvaaIeOVryevqavRxyswDEIG4iCuaYo0LlFo1RL++jHfCe8T/jhdLrbUG3NrRQomAAPTDqmjWe3oKSg2AujPWpPS6GulSxCYdPamlxh9csXR3a6tRQ3qsvO40wm0INUzORfsPAMHIsTcxRManZ9cXrM3h++/fXmRel97bI0Xa1WE7soXqGQ3tiJscvULgr60LyXEzYv0SKroGU5MhBCkk9QlFCN1kt0zNVYyIUsxu0YwmZUh4ivoSIxLMLb/eKHem3iY61sjZXbiGZXF2dMCtReLlqpl9uuw5oFNIpsQG4an+UK9FcqlJde7XS66cU1VQW2ZWaxw0GfcOfBN+6HsHvzess2weK3+fycRROsMALZwljmS+lGR5REJbWsmopnh9Npwiu4i0/vptOebFLFfyITzfCuVqADtDbTkZpVxuKAn5CY1M6DLv6vyhgrl3LT74ROgbEWfADxh5hR3/eBUG+28X5qbC6FQB3gyeicQOdHVoFSZoV7Xu15tefVE7w63N2oYu82dmh90pexxclb1NRqQzckmi1Mo/ck25NsT7InSPb+qWvlNrekY6AsgmgfLpzf3zH3dNvTbU+33XR7u+vP10wz2mVLOERrjWWmKBprUbBVKVUwT3/oRt/DZTJicc+1Pdf2XNvmWp/wCn1pSHmqjQvQIc0m42noUy7tRvGoT6nZubQbNJ6epBq0t6PW1FjFM95FCvVZmnalcb7PutpY36e3VJ9bsBJyFVFJw5FqI4SUKUCVMYztUtIAyUxjisdQNVoAO2IXJ5dz9hE8rqANW0suvzd9ND2a7rRKUx+xODs/YzHDCMS1w2E0SyzfaTZO/hnDQcRyWDRW+vaSlsXtyREs2llD1bgHyOAvWKfnOIknw4/TETa//zMPlZd6YcLyAQHbgVBV0LoY+XRysI2287NAmsJUVaPDyamX8c4Da4kVqnGeEkq4kgVqF3A9yILjtE9xhP0dPbKDCRUlImc8MJfSl00+KUyVFnHZ/XeuTJ5WIHU6uHDp8ezPq88fZq8+nR2ffL48eXUwmU78nQ/JE6Ar0GtxRPV0WzzdTLp7aBg/UlyHwni882mtQGqCSsioG6h0HfVXxxOerSmxgU30btRMb5KBEte863JweGVV39Prbw3almfXNw8MCpQT0tFvwbMFKLcprK4n8eJikGBfsi1dd2cGw0vQbaCtauiJJ/wrtuuCMkm/z45iXfR9RhDjvvU3fcJLBIE27EocnRUF1n5t3aN9n/h3fwie/3VJzPkPKoog4w== +api: eJztWE1z2zYQ/Ss7OCVTWlQSJ0140zgfdZumHltuDrYPS3IlIgYBBgAtazT8750FSFuRZDfj6aUzOmgkEsAudve9BfRWwuPciexCfLKmbcRVIkxDFr00+rgUmcCyPHdkpyaOJ6IkV1jZ8ASRiYlzcq4dILSOLHgDCHOeObrUl3paSQeTk2OQDqQGhK/GXh9IfXBizdySc+A8egLUJSykUtDqkuzcQGM8aS9RQW4Jr6WeQ1GhnpMDL5W61NI7sKQIHcFC+gpQQ9sUpuaptdTGDsOjSy0S0aDFmjxZjnUlNNYkMhF2+gctRSIkR9Ogr0QiLH1vpaVSZN62tBnytKIYIlzTciQS4YqKahTZSvhlw2adt1LPRdcld544O09xFLL6kB+pPc3JikTMjK3Rx1dvDkXXXbFx1xjtyPGKl+OX/PWAgwU6wFBJKsG1RUHOzVqlllxQP8Q7El0iDsfj3YYaa25kSSWU6JELro2HG1Sy5L0XRnNFeSk2jZJFQFjaWJMrqn/55tjOai3EDZjBSZwJJXmUCkz+jQoP6CBOzKlkhF2cfjyCd4evf716VnnfuCxNF4vFyM6KAyqlN3Zk7Dy1s4I/PO/5CKYVWYIal5ATYFlK9omKA2rIekkOXEOFnMliSEe/beA6RHz1FYnbYrzdLb6v1yY+1srWWrlNLTg/PQZZMhFmS8b1luuwZoatYhuYm9ZnuUJ9zYXy0qudTje9uLau0S7BzHY46BLBFG3dv8Lu1cst2wyL36bTE4gmoDAlwcxY8NwXekccRC21rNtaZIfjcSJqvI1Pb8bjjm1yxX8iEg102yjUAVqb4UgNtbHU4ycEJrXzqIv/qjLGyrnc9DviLjDUQvQgfh8j6rouEOrVNt4/GpvLsiQd4AncJ8j5gVWolFnQnld7Xu159QivDncfVPHsNrY/+vjyEI44eUOaj9pwGjLNZqbVe5LtSbYn2SMke/fYtXKbW9IBKktYLu8vnD/eMfd029NtT7fddHu968/XRANn2TIOyVpjwRRFay2VsKikCub5D93gu79MRizuubbn2p5r21zrElGTrwxLYI1xATqs2WQiDeeUS1eDeNSlfNi5dNVrPB1LNWRvBq2ptUpkYhUp1GVpuqqM8122aoz1XXrD9blBKzFXEZU8HKk2QEiZAlUVt7FdSh5gmWkI8QjrVpcIb+H0w9kUPqGnBS5Datnlj6bfjt+Od1rlqQ9YZEUvRhiBuNYcBrPM8p1m4+SfMRxELEdFa6VfnvGymJ6c0JKdtFyNO4D0/oJ1fo6TRNL/+DjA5vev01B5qWcmLO8RsL0RrgpZF3c+Hr3YRtvJcSBNYeq61aFz6nkvRq4FVqjWeQ4oEUoWpF3AdS8LDtM+xxH4O3qEFyMuSkTO0DDn0ldtPipMnRZx2d13rkye1ih12rtw6dHkz/Mv7ycHn4+PPnw5+3DwYjQe+VsfgmdA16jX9hFl3G0VF55tKrbPN/Owuj9D/jdqcA8aT7c+bRRKzTAO2V71NL+I2rATicjWVOLAdH436LlXSU/XC7Fa5ejo3Kqu49ffW7JLkV1c3bM7tINSOv5dimyGym2KvuvZfHbay8PPYUtz3hlB/xL1MrQU1fKTSMQ1LdfFbpaln7yLdUH6CZsY8tZddYmoCEuyIStxdFIU1Pi1dQ/eSbg33DXok7/OmNX/AKJtjD0= sidebar_class_name: "post api-method" info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api custom_edit_url: null @@ -23,7 +23,7 @@ import Heading from "@theme/Heading"; -Create group +Create a new group. + +This API is in a Work-in-Progress state and will undergo potential breaking changes till +its release with an upcoming minor release.