Merge 203c118 into 1c23474

camunda · Mar 7, 2025 · f87ed80 · f87ed80
2 parents 1c23474 + 203c118
commit f87ed80
Show file tree

Hide file tree

Showing 18 changed files with 190 additions and 99 deletions.
diff --git 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
@@ -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";
 <Heading
   as={"h1"}
   className={"openapi__heading"}
-  children={"Assign a user to a group"}
+  children={"Assign a user to a group (Work-in-Progress)"}
 ></Heading>
 
 <MethodEndpoint
@@ -34,6 +34,9 @@ import Heading from "@theme/Heading";
 
 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.
+
 <Heading
   id={"request"}
   as={"h2"}

diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-group.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-group.api.mdx
@@ -1,11 +1,11 @@
 ---
 id: create-group
-title: "Create group"
-description: "Create group"
-sidebar_label: "Create group"
+title: "Create group (Work-in-Progress)"
+description: "Create a new group."
+sidebar_label: "Create group (Work-in-Progress)"
 hide_title: true
 hide_table_of_contents: true
-api: eJztWE1z2zYQ/Ss7OLVTWpTz0bq8qY6duk1Sjy23B9eHJbgSEYMAA4CWNRr+984ClCxbdppDjtKMRiSx2Lcf74ECViLg3IviWrx3tmvFTSZsSw6DsuasEoWQjjBQGsyEoy8d+fCbrZaiWAlpTSAT+BLbVisZ5+WfvTX8zMuaGuSrsGxJFMKWn0kGkYnWMUpQ5HnUYENbVj44ZeYiExV56VTLPkUhpjVBpXyrcQk8A+wMQk1gaAFzjm8k+j4TQQXNXmLIxzH6ixS16Hs2cORba3yCfjU+5J9dpOgRFughVaAC30lJ3s86rZcjkX2v5CPQn7R8PoxbWq7zXMcx5Jo9KdeLuftOr1N/Mx4/D9M6e6cqqqDCgKA8GBvgDrWqvpJp62ypqflpN+PHABM4T5ZQUUClIVUC0EMyLKkCZeD64vQYfn3z9pebH+oQWl/k+WKxGLmZPKBKBetG1s1zN5P8ZbsfRzCtyRE0uISSAKtKMSZqeKgx+JakmikJwcY6DmEDl2/0r3ko5AsNSqO77JxZ12AQheic2iHrBK4uzkBVZIKaLZWZ70LHOTPk7hQCS9uFotRobsVDI/9PEhPwXdOg23DkMUCfCR8wdFtpCGUCzcltx69MeP3qWbn9Pp2eQ3IB0lYEM+sg1MqvgTiJRhnVdI0o3ozHmWjwPt39PB737JM7/g2ZGKD7VqOJ1HqajjLQWEcDf2JiyviARn6vzlin5uop7uMFZSDxu5TRWlAvLB/DQgka5a1PSgLsQs2oST6s5xgEar8X2V5ke5G9LLLXu3w/ta5UVUUm0nOjt+HVhVrbBe1fXntd7XX1oq7ePvdvcGKAq+yYh+ScdWCl7JyjCha10tE9/w1eYw/CS1zca22vtb3WdrXWP/Wd9mZpK8eVoVBb3m231kdeYahFIfI47kUmPLk7crxPX4nOaVGIVRJRX+T5qrY+9MWqtS70+R136A6dwlInXvJwEtuaRNpK1HXC2m0mD2xvsI+x6UyFcAQXJ5dTeI+BFriMxWXIx66PxkfjZ72y6QseJ+dnkDJMVNxaHtZuWefPuk3G3+K472+4kLJzKiwveVoqT0noyE06LvmGIgNe9M73yUhkw8Xpmjh//DONveel7eLhcOTkHps2CTMdbmx26UzImY1IA112Y+YGkvMpyfHocJea52dRYdI2TWfiMmvmsFChBtyqgdSdD5x7JrSSZPx2QGuzD2kE/k6IcDji/iWSrVfXuQp1V46kbXKZpm1+S23LvEFl8gHC58eTj1ef3k0OPpwdn3y6PDk4HI1H4T7EOjHBGzTbcTyWwqNEN+0IdB/yVqMyXMEY3GpQybUYVHKTDUy/FqtViZ6unO57fvylI7cUxfXNgzD4rs9ETViRi7K65SMYcZzeYAdTxmVz3TH+zgFPn61nTKSkNnzV9mZL4ed/XU6ZRsMJWmMrnuNwwadruBCFEHwEx7MjO+OzldBo5h3O2Tb55M9/cIvOUw==
+api: eJztWE1z2zYQ/Ss7OCVTWpTz0bq8qY6duk1Tjy03B1uHJbgiEYMAA4CWNRr+984SlC1btptDDj1IMxqRwmIfdve9lbgrEbD0IrsUH51tGzFLhG3IYVDWnBQiE9IRBoqLiSjIS6caXhWZOOzXAMHQAko2GV2ZKzOtlIfJ6QkoD8oAwhfrrveU2Tt1tnTkPfjQ7zMFLJTW0JqCXGmhsYFMUKghd4TXypQgKzQleQhK6yujggdHmtATLFSoAA20jbQ1m9bKWLdeHl0ZkQhH31ry4TdbLEW2EtIaBuBLbBqtZB9m+tVzNCvhZUU18lVYNiQyYfOvJINIROM4KUGR51WDNW1Y+eCUKbeSM60ICuUbjUvgHWDnECrayJXoukQEFTR76TMcE3oWTy26jg0c+cYaH6HfjPf5Yxup9wgL9BALVoBvpSTv563Wy5FIflTwPdCftHz6GNe0XMe5PscQa/IoXc/G7lu9Dv3dePw0TOPsjSqogAIDMs2MDXCDWhUvRNo4m2uqf9qO+CHABE6jJRQUUGmImQD0EA1zKpjXl2fHh/Dru/e/zF5VITQ+S9PFYjFyc7lHhQrWjawrUzeX/Ga71yOYVuQIalxCToBFoRgTNdznGHxDUs2VhGD7PA7HBk5fZPXLBYqr2+ycW1djEJlondoi6wQuzk5AFSy/+ZLVtAXd75kjVycTmNs2ZLlGcy3uC/lfkpiAb+sa3R1HHgJ0ieDG0G6EIZQJVJLbPL8y4e2bJ+X2+3R6CtEFSFsQzK2DwN1oAOIgamVU3dYiezceJ6LG23j383jcsU+u+HdEYoBuG42mp9bjcJSB2joa+NMHpowPaOSPqox1qlSPcR82lIHEH2JEa0E90z6GRgka5bWPSgJsQ8WoUT6s5yJ2Z78T2U5kO5E9L7K323w/ti5XRUGmp+ed3oafLtTaLmj347XT1U5Xz+rq/VP/BicGOMuOeUjOWQdWytY5KmBRKd2757/Ba+xBeJGLO63ttLbT2rbWukTUFCrLz/+N9T11MFQiE2n/NOdFIjy5G3I8OViJ1mmRiVXUSZel6aqyPnTZqrEudOkNF+EGncJcR+rxctTTmifaStRVxNquFy9sPkMfYt2aAuEAzo7Op/ARAy1w2eePIR+6PhgfjJ/0yqbPeOTpRYwwsm2jA6zdspSfdBuNv8dx1804kbJ1KizPeVtMT07oyE1aTvkdCwa83jvfRyORDBfHa2788WXal5e719n9/OPoFusmai/OL+4exJlzc9sjDYzYPjMXkJyPQY5H+9vsOz3pRSRtXbem76SmHGY0GzmQuvWBY0+EVpKM3zzQ2uxTXIF/IiLsj7h+kWTrBlqqULX5SNo6lXHb3WeubZ7WqEw6QPj0cPLXxecPk71PJ4dHn8+P9vZH41G4DX2emOA1ms1zxLFWHKm8ejy8ev049o250v9/IjaQKdBtSBuNynD9+9SuBo1fikHjs2TQ6aVYrXL0dOF01/HX31pyS5Fdzu5lzXddIirCglzfFK55RiQOY2r2pozL5rpl/K0JVJesd0ykpCa8aDvb6E+nf59PWQTDiK+2Be9xuODxHy5EJgSPNHl3r63+u5XQaMoWS7aNPvn1Lz5PSAw=
 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";
 <Heading
   as={"h1"}
   className={"openapi__heading"}
-  children={"Create group"}
+  children={"Create group (Work-in-Progress)"}
 ></Heading>
 
 <MethodEndpoint
@@ -32,7 +32,10 @@ import Heading from "@theme/Heading";
   context={"endpoint"}
 ></MethodEndpoint>
 
-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.
 
 <Heading
   id={"request"}

diff --git a/docs/apis-tools/camunda-api-rest/specifications/create-role.api.mdx b/docs/apis-tools/camunda-api-rest/specifications/create-role.api.mdx
@@ -1,11 +1,11 @@
 ---
 id: create-role
-title: "Create role"
+title: "Create role (Work-in-Progress)"
 description: "Create a new role."
-sidebar_label: "Create role"
+sidebar_label: "Create role (Work-in-Progress)"
 hide_title: true
 hide_table_of_contents: true
-api: eJztWE1z2zYQ/Ss7OLVTWpQTp3V5UxW7dZukHlluD64PS3AlIgYBBgAtazT8750lKFu2JDeH3CrPeEQKi3378R5E7koEnHuR3YiJ1SRuE2FrchiUNReFyIR0hIG6tUQU5KVTNS+KTIy7JUAwtABnNQ3+MSIRjr405MMvtliKbCWkNYFM4Eusa61k5zv97NnHSnhZUoV8FZY1iUzY/DPJIBJRO44kKPK8arCiDSsfnDLzrZCmJUGhfK1xCbwD7AxCSU8RirZNRFBBsxPOKiYxiTGLtuV1R762xkfgN8Nj/tjGYX+wQA+xRAX4RkryftZovYyl+Ea5M9IftNwdxh0t11muA4mZJi9qtS9z3+h14ifD4W6Q2tl7VVABBQYE5cHYAPeoVTHYn2btbK6p+mE73ecAI7iMllBQQKUhlgHQQzTMqQBl4GZyPoafT979dPtdGULtszRdLBYDN5NHVKhg3cC6eepmkv/Z7vsBTEtyBBUuISfAolCMiRqeCgy+JqlmSkKwXRX7sIGrF9v4enfi6jYzZ9ZVGEQmGqe2iDqC68kFqIJMULOlMvNt6G7PDLk7mcDcNiHLNZo78dTH/5LDCHxTVegeGfIcoE2EDxiajTSEMoHm5DbjVya8fbNTar9Np5cQXYC0BcHMOgil8msgTqJSRlVNJbKT4TARFT7Eux+Hw5Z9cse/IhMD9FBrNB21XqajDFTWUc+fLjFlfEAjv1VnrFNz9RL3+WnSk/h9zGgtqH2HRzxwQKO881FJgE0oGTXKh9XcBYHaH0R2ENlBZPtF9nab7+fW5aooyHT0fNRb/9OFWtsFHX68Dro66Gqvrt7tehocGeAqO+YhOWcdWCkb56iARal0556fgtfYvfBefR4+aO2gtf+11tpEVBRKyy/ctfUddTCUIhMpv8t5kQhP7p4cv6ivROO0yMQqyqTN0nRVWh/abFVbF9r0nntwj05hriPzeDnKaU0TbSXqMkJtt4sXNl+fx1g1pkA4hcnZ1RR+xUALXHblY8jnrk+Hp8OdXtl0j8fR5QXEDCPZNg6AtVtW8k630fhrHLftLRdSNk6F5RVvi+XJCR25UcMVfyRBj9d55/toJJL+4nxNjd//nnbd5cNr8jT6OHvAqo7Si6OLx9dwptzMdkg9IbZj5gaS8zHJ4eB4m3yXF52GpK2qxnQHqZnDQoUScKMGUjc+cO6J0EqS8ZsBrc0+xBX4KyLC8YD7F0m2Pj/nKpRNPpC2SmXc9viZa5unFSqT9hA+HY8+Xn96Pzr6cDE++3R1dnQ8GA7CQ+jqxPyu0GzGEedIbseMaWN8tG/c1Lcr0ENIa43KcIW74Fe9iG5EFNFt0gvhRqxWOXq6drpt+esvDbmlyG5un3TDd20iSsKCXKe6O57AiHGM52jKsGyuG4bfGu+0yXrHSEqqw6u2txv6v/zzasos68dnlS14j8MFj9ZwITIheEbHu+NwiL9bCY1m3uCcbaNP/vsXgObXLg==
+api: eJztWN9T4zYQ/ld29HQ3NXG4Hy31W8pBS3u9ZiD0HoCHtbyxdciST5IJmYz/985aDgQC9B7uoTMNM0zsaLWfdvf7NvauRMDSi+xCnFpN4ioRtiGHQVlzUohMSEcYqF9LREFeOtXwosjEYb8ECIYW4Kym0aW5NLNKeZhMT0B5UAYQPlt3vafM3tTZ0pH34EO/zRSwUFpDawpypYXGBjJBoYbcEV4rU4Ks0JTkISitL40KHhxpQk+wUKECNNA20tZsWitj3Xp5dGlEIhx9bcmHX2yxFNlKSGsYgC+xabSSfZDpF8/BrISXFdXIV2HZkMiEzb+QDCIRjeOUBEWeVw3WtGHlg1Om3MrNrCIolG80LoF3gJ1DqOg+VaLrEhFU0OyE0xuzeRrPLLqO1x35xhofgd+M9/ljG4f9wQI9xFoV4Fspyft5q/UypuI7xc5If9Dy6WNc03Id5fogMdLkUa6ei9y3eh34u/H4aZDG2RtVUAEFBmSKGRvgBrUqRs+H2Tiba6p/2A73IcAEptESCgqoNMQ0AHqIhjkVzOmL0+ND+Pnd+5+uXlUhND5L08ViMXJzuUeFCtaNrCtTN5f8z3avRzCryBHUuIScAItCMSZquE8w+IakmisJwfZZHI4NnL1YxperE1e3mTm3rsYgMtE6tUXUCZyfnoAqWHrzJStpC7rfM0euTiYwt23Ico3mWtzX8d/kMAHf1jW6O4Y8BOgSwU2h3QhDKBOoJLd5fmXC2zdPSu232WwK0QVIWxDMrYPAnWgA4iBqZVTd1iJ7Nx4nosbbePfjeNyxT674N0RigG4bjaan1uNwlIHaOhr40wemjA9o5PeqjHWqVI9xH3aTgcQfYkRrQT3XPGLDAY3y2kclAbahYtQoH1ZzETuz34lsJ7KdyJ4X2dttvh9bl6uiINPT805vw08Xam0XtPvx2ulqp6tndfX+qafBiQHOsmMeknPWgZWydY4KWFRK9+75KXiNPQjvxefhndZ2Wvtfa61LRE2hsvzm31jfUwdDJTKR8rucF4nw5G7I8cRgJVqnRSZWUSZdlqaryvrQZavGutClN1yDG3QKcx2Zx8tRTmuaaCtRVxFqu1y8sPn6fIh1awqEAzg9OpvBrxhogcs+fQz50PXB+GD8pFc2fcYjDy5ihJFsGw1g7ZaV/KTbaPwtjrvuihMpW6fC8oy3xfTkhI7cpOWM35FgwOu98300Eslwcbymxu+fZ311uXmd3o8+jm6xbqL04uji7jWcKTe3PdJAiO0zcwHJ+RjkeLS/Tb7pSa8haeu6NX0jNeUwntnIgdStDxx7IrSSZPzmgdZmH+MK/B0RYX/E9YskW/fPUoWqzUfS1qmM2+4+c23ztEZl0gHCp4eTP88/fZjsfTw5PPp0drS3PxqPwm3o88T8rtFsniMOtPp5yqvHY6vXj0PfmCj950dhA5UC3Ya00agMV79P7GoQ+IWIAr9KBpFeiNUqR0/nTncdf/21JbcU2cXVvab5rktERViQ6zvCNU+HxGFMzN6MYdlctwy/NXrqkvWOiZTUhBdtrzZ60/SvsxkrYBjt1bbgPQ4XPPbDhciE4EEm746DK/5uJTSassWSbaNP/vsH6YNClw==
 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";
 <Heading
   as={"h1"}
   className={"openapi__heading"}
-  children={"Create role"}
+  children={"Create role (Work-in-Progress)"}
 ></Heading>
 
 <MethodEndpoint
@@ -34,6 +34,9 @@ import Heading from "@theme/Heading";
 
 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.
+
 <Heading
   id={"request"}
   as={"h2"}