Skip to content

Commit

Permalink
docs: update REST API spec (#5177)
Browse files Browse the repository at this point in the history
Co-authored-by: tmetzke <tmetzke@users.noreply.github.com>
  • Loading branch information
1 parent e8e9fce commit a296506
Show file tree
Hide file tree
Showing 17 changed files with 182 additions and 590 deletions.
204 changes: 26 additions & 178 deletions api/camunda/camunda-openapi.yaml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Assign a single group to a specified tenant."
sidebar_label: "Assign a group to a tenant"
hide_title: true
hide_table_of_contents: true
api: eJztWE1z2zYQ/Ss7OCVTWpQTJ3V50zhO6jbxeGy5Pbg+gORKRAICND4sazj8750FSFmW5Nbt+KiDhiKw2IfFvgcQ2zLH55ZlN2yKiivHbhOmGzTcCa3OSpYxbq2Yqy9G+2aqe6OElWgLIxqyYhmbBBvgYIWaS4Q5WYPT1NJgIWYCS3Bh7IglrOGG1+jQEHDLFK+RZSz2/45LljBBXhvuKpYwg3deGCxZ5ozHTehpheCVuPMIokTlCMuAnoGrcA3SFhXWnGUtc8uG0KwzQs1Z1yWrCYRZvyp+8LgTXiiHczQsYTNtau5i08cj1nW3BGkbrSxaGvFu/I4e27BxlRfcgvVFgdbOvJRLiAmjBddPFqFL2NF4vNtVY/S9KLGEkjsOwoLSDu65FCXNvtDKoXI0lDeNFEVgR9oYnUusf/puyU+7FuQGO+AiWkKJjgsJOv+OhQNuIRrmWIJQcHP5+QR+Ofrw8+2byrnGZmm6WCxGZlYcYCmcNiNt5qmZFfQju7cjmFZoEGq+hByBl6UgTC4poAaNE2gHBhbDevTTBsrE6C/FkiEncVrEz9Xgx4xtEmctcd6IbUXA9eXZwIilUPNt6DBmxr0kHzzX3mW55OoHJcoJJ3eCbqJYX9fcLAfCPQXoEmYdd97+K/Hev9vyTbT4dTq9gOgCCl0izLQBVwk7AFEQtVCi9jXLjsbjhNX8Ib59HI878kkZf0EkCvChkVwFam2GIxTU2mDPnxCYUNZxVbxWZrQRc7GJO6LtYcgF60n8KUbUdV0Q1Pttvn/WJhdliSrQE2j/QOsGVXEp9QL3utrraq+rf9DV0Tbfz7WDmfaqjLqK5xpos3YQqpXJXl57ee3l9Yy8Puz6DpwooFU2xEM0RhvQReGNwRIWlZDBPX1lDtj9uRa5uNfaXmt7rW1rrUtYja7SdJNufGAO3Sozlsbjy6bt6t7bpeEgs2k73EQ7ujqiuR9uyt5IlrE2qqjL0rSttHVd1jbauC69pxTdcyN4LiMxqTuqbWCR1AWXoXlXNqmDbsNDlCe89qrkcAyXp1dT+MIdLvgyrC5BPnV9PD4e7/RKps94nFycQYwwcnFtfxjcktB3uo3GL3EcLtUWC2+EW17RsLg8OXKDZuIpIyuO9HjBO71HI5b0fz4PzPntz2lIvlAzHYb3JNieCGUFjY0zH48Otwl3cRZ0U+i69ipsnmoOC+Eq4GuBFdJbRwElTIoClQ3U7qsXg9nX2AN/REQ4HFFSInOGPXMuXOXzUaHrtIjDVs9c6jytuVBpD2HTk8m36/NPk4OvZyen51enB4ej8cg9uBB8o62ruVqbx6oWtFYEcjvLRu3jqfFfK0h9qhw+uLSRXCgiT4ix7QV209eTLEtYtl5aihqj1lW95zbphXLD2jbnFq+N7DpqvvNoliy7uX3UVRBiKSz9L1k249JuFoXWA3tz2ZeP3sILS1U7Y+sbuVoGiUtPbyxhP3D5pHRG5azXn9yqjvU/5rZa5e62S1iFvEQT1jB2T4oCG7c28NnPB9Lwai+9uCbx/Q3twyPs
api: eJztWE1z2zYQ/Ss7OCVTWpQdJ0150zh26jbxeGy5Pbg6gORKRAICND4sazj8750FSEWRlNbt+KiDhiKw2IfFvgcQ2zLHF5Zl92yKiivHZgnTDRruhFaXJcsYt1Ys1EejfTPVvVHCSrSFEQ1ZsYxNgg1wsEItJMKCrMFpammwEHOBJbgwdsQS1nDDa3RoCLhlitfIMhb7L0uWMEFOG+4qljCDD14YLFnmjMdt5GmF4JV48AiiROUIyoCeg6twA9EWFdacZS1zq4bArDNCLVjXJWv8MOnfcfVy+MHjXnihHC7QsITNtam5i03vTlnXzQjSNlpZtDTiZHxCj13YuMhLbsH6okBr517KFcR80Xrr7xahS9jpeLzfVWP0oyixhJI7DsKC0g4euRQlzb7QyqFyNJQ3jRRFIEfaGJ1LrH/6YslPuxHkFjngOlpCiY4LCTr/goUDbiEa5liCUHB/c3EGv5y+/Xn2qnKusVmaLpfLkZkXR1gKp81Im0Vq5gX9yO71CKYVGoSaryBH4GUpCJNLCqhB4wTagYDFsB79tIEyMfpLsWTISZwW0XM9+FvGtomzkThvxK4g4O7mcmDESqjFLnQYM+dekg+ea++yXHL1lRLlhJN7QbdRrK9rblYD4b4H6BJmHXfe/ivx3pzs+CZa/DqdXkN0AYUuEebagKuEHYAoiFooUfuaZafjccJq/hTf3o3HHfmkjD8jEgX41EiuArW2wxEKam2w508ITCjruCpeKjPaiIXYxh3R9jDkgvUk/hAj6rouCOrNLt8vtMlFWaIK9ATaP9C6QVVcSr3Eg64Oujro6h90dbrL9yvtYK69KqOu4rkG2mwchGptcpDXQV4Hef1AXm/3fQdOFNAqG+IhGqMN6KLwxmAJy0rI4J6+Mgfs/lyLXDxo7aC1g9Z2tdYlrEZXabpINz4wh26VGUvj8WXTdrj2dmk4x2zaDhfRjm6OaB6He7I3kmWsjSLqsjRtK21dl7WNNq5LHylDj9wInsvIS+qOYhtIJHXBZWjel0zqoMvwEOQZr70qObyHm/PbKXzkDpd8FRaXIL93/X78frzXK5n+wOPk+hJihJGKG9vD4JZ0vtdtNH6O43Cntlh4I9zqlobF5cmRGzQTTwlZU6THC97pPRqxpP9zMRDntz+nIfdCzXUY3nNgdyKUFTQ2znw8Ot7l2/VlkE2h69qrsHeqBSyFq4BvBFZIbx0FlDApClQ2MLsvXgxmn2IP/BER4XhESYnMGbbMhXCVz0eFrtMiDls/c6nztOZCpT2ETc8mn++uPkyOPl2enV/dnh8dj8Yj9+RC8I22ruZqYx7rStBGCcjtLRq13w6N/1o/6lPl8MmljeRCEXlCjG2vr/u+mmRZwrKNwlKUGDWuqz2zpNfJPWvbnFu8M7LrqPnBo1mx7H72TVZBh6Ww9L9k2ZxLu10S2ozr1U1fPHoNzyxU7Q2tb+RqFRQuPb2xhH3F1WbdjGpZLz+3dRHrf0xtvcjdrEtYhbxEE5Ywdk+KAhu3MfCH3w6k4PVGen1H0vsbZZsh/A==
sidebar_class_name: "put api-method"
info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api
custom_edit_url: null
Expand All @@ -28,7 +28,7 @@ import Heading from "@theme/Heading";

<MethodEndpoint
method={"put"}
path={"/tenants/{tenantKey}/groups/{groupKey}"}
path={"/tenants/{tenantId}/groups/{groupKey}"}
context={"endpoint"}
></MethodEndpoint>

Expand All @@ -44,7 +44,7 @@ Assign a single group to a specified tenant.
<ParamsDetails
parameters={[
{
name: "tenantKey",
name: "tenantId",
in: "path",
required: true,
description: "The unique identifier of the tenant.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Assign a single mapping rule to a specified tenant."
sidebar_label: "Assign a mapping rule to a tenant"
hide_title: true
hide_table_of_contents: true
api: eJztWEtz2zYQ/is7OCVTWpQdJ3V50zh26zbxeGy5Pbg6gORKRAICNB6WNRz+98wSpExLcuvJ+KiDhiKw2Of3AcTWzPGFZckdm6LiyrFZxHSFhjuh1UXOEsatFQv1lVeVUItrL3GqO9GI5WgzIyqSZQmbtJLAwQq1kAhlWAPGSwSnaaLCTMwF5uBaFSMWsYobXqJDQ17UTPESWcLC/F+4YhETpLzirmARM3jvhcGcJc543PRgWiB4Je49gshRObJlQM/BFTgwabMCS86SmrlVRdasM0ItWNNEawc659/Ug2FCdvohlMMFGhaxuTYld2Ho0zFrmhlZtpVWFi2tOBof0WPb+rOsL7kF67MMrZ17KVcQqkkF0M+S0kTseDzerbEy+kHkmEPOHQdhQWkHD1yKnILItHKoHC3lVSVF1kInroxOJZa/fLOkpx7EugEauAqSkKPjQoJOv2HmgFsIginmIBTcXZ+fwm/HH3+dvSucq2wSx8vlcmTm2QHmwmkz0mYRm3lGP5J7P4JpgYYSsoIUgee5IJtcUkAVGifQ9ojM+nx0bgMVZPSvYlFfmuAW4XW9+Klwm0Aa1M8bsU0UuL2+6PGxomJtmW7XzLmXpIOn2rsklVx9p0I54eROo5tWrC9LblY9/J4baCJmHXfe/i/+Phxt6SZY/DGdXkFQAZnOEebagCuE7Q1REKVQovQlS47H44iV/DG8fRqPG9JJFX9FJArwsZJctdDaDEcoKLXBDj9tYEJZx1X2VpXRRizEpt0RbRd9LVgH4s8hoqZpWkJ92Mb7uTapyHNULTyBdhO0rmcVl1Ivcc+rPa/2vPoPXh1v4/1SO5hrr/LAq3CugTbb56FaS+5ZtmfZnmUvsOzjrs/BiQLKsiEcojHagM4ybwzmsCyEbNXTx2ZvuzveAhb3XNtzbc+1ba41ESvRFZpu25VvkUNXzYTF4RSzcb2+Djdxd54d0Hlm4/rpntrQjRLNQ3+T9kayhNWBTk0Sx3WhrWuSutLGNfED1eqBG8FTGRBK04F2PZykzrhsh3eVlSbottyHe8pLr3IOJ3B9djOF37nDJV+1aSaTz1WfjE/GO7WS6AsaJ1cXECIMoBxsFL1aYvxOtUH4NYrbu7bFzBvhVje0LKQnRW7QTDyVZg2Wzl6rnd6DEIu6P+c9hP78Z9qiQKi5bpd3aNh2hKqCxgbPx6PDbeRdXbQEynRZetXuomoBS+EK4IPAMumto4AiJkWGyrYY77obvdiXMAN/B4twOKKiBOT0m+dCuMKno0yXcRaWrZ+p1GlccqHizoSNTydfby8/Tw6+XJyeXd6cHRyOxiP36NrgK21dydXAj3XLaLtX5HY2meqnU+Qn+01d4Rw+uriSXCiCUhtx3fHurus+WRaxZNiIekY9mhw0iWZRx587Vtcpt3hrZNPQ8L1Hs2LJ3eyJbi0/c2Hpf86SOZd2s5M0DPTddddzeg+v7HDtDLIb5GrVMl96emMR+46rZx036oK9vXObza+fcHGQ7mbWRKxAnqNpkxkEJlmGlRssffE7gzi+3nSvbomcPwA/3ECo
api: eJztWEtz2zYQ/is7OCVTWpQdJ3V50zh26zbxeGy5Pbg6gORKRAICNB6WNRz+98wSpExLcuvJ+KiDhiKw2Of3AcTWzPGFZckdm6LiyrFZxHSFhjuh1UXOEsatFQv1lVeVUItrL3GqO9GI5WgzIyqSZQmbtJLAwQq1kAhlWAPGSwSnaaLCTMwF5uBaFSMWsYobXqJDQ17UTPESWcLC/EXOIiZId8VdwSJm8N4LgzlLnPG46cC0QPBK3HsEkaNyZMqAnoMrcGDRZgWWnCU1c6uKjFlnhFqwponW9jvf/8LV23kwzMdOP4RyuEDDIjbXpuQuDH06Zk0zI8u20sqipRVH4yN6bFt/lvQlt2B9lqG1cy/lCkIxKf/6WVKaiB2Px7s1VkY/iBxzyLnjICwo7eCBS5FTEJlWDpWjpbyqpMha5MSV0anE8pdvlvTUg1g3MANXQRJydFxI0Ok3zBxwC0EwxRyEgrvr81P47fjjr7N3hXOVTeJ4uVyOzDw7wFw4bUbaLGIzz+hHcu9HMC3QUEJWkCLwPBdkk0sKqELjBNoekFmfj85toIKM/lUs6ksT3CK4rhc/FW4TSIP6eSO2eQK31xc9PlZUrC3T7Zo595J08FR7l6SSq+9UKCec3Gl004r1ZcnNqoffcwNNxKzjztv/xd+Hoy3dBIs/ptMrCCog0znCXBtwhbC9IQqiFEqUvmTJ8XgcsZI/hrdP43FDOqnir4hEAT5WkqsWWpvhCAWlNtjhpw1MKOu4yt6qMtqIhdi0O6Ltoq8F60D8OUTUNE1LqA/beD/XJhV5jqqFJ9Bugtb1rOJS6iXuebXn1Z5X/8Gr4228X2oHc+1VHngVzjXQZvs8VGvJPcv2LNuz7AWWfdz1OThRQFk2hEM0RhvQWeaNwRyWhZCtevrY7G13x1vA4p5re67tubbNtSZiJbpC02W78i1y6KqZsDicYjau+9twE3fH2QEdZzaun66pDV0o0Tz092hvJEtYHdjUJHFcF9q6JqkrbVwTP1CpHrgRPJUBoDQdWNejSeqMy3Z4V1Vpgi7LfbSnvPQq53AC12c3U/idO1zyVZtlMvlc9cn4ZLxTK4m+oHFydQEhwoDJwT7RqyXC71QbhF+juL1qW8y8EW51Q8tCelLkBs3EU2XWWOnstdrpPQixqPtz3iPoz3+mLQiEmut2eQeGbUeoKmhs8Hw8OtwG3tVFy59Ml6VX7SaqFrAUrgA+CCyT3joKKGJSZKhsC/GuudGLfQkz8HewCIcjKkpATr93LoQrfDrKdBlnYdn6mUqdxiUXKu5M2Ph08vX28vPk4MvF6dnlzdnB4Wg8co+uDb7S1pVcDfxYN4y2O0VuZ4upfjpEfrLb1BXO4aOLK8mFIii1Edcd7e663pNlEUsGbahnzKO5QYtoFnX0uWN1nXKLt0Y2DQ3fezQrltzNntjW0jMXlv7nLJlzaTf7SMM43113Haf38Mr+1s4Yu0GuVi3xpac3FrHvuBq226gF9va+bXa+fsLDQbabWROxAnmOps1lEJhkGVZusPTFjwxi+HrHvbolav4ANew+uA==
sidebar_class_name: "put api-method"
info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api
custom_edit_url: null
Expand All @@ -28,7 +28,7 @@ import Heading from "@theme/Heading";

<MethodEndpoint
method={"put"}
path={"/tenants/{tenantKey}/mapping-rules/{mappingKey}"}
path={"/tenants/{tenantId}/mapping-rules/{mappingKey}"}
context={"endpoint"}
></MethodEndpoint>

Expand All @@ -44,7 +44,7 @@ Assign a single mapping rule to a specified tenant.
<ParamsDetails
parameters={[
{
name: "tenantKey",
name: "tenantId",
in: "path",
required: true,
description: "The unique identifier of the tenant.",
Expand Down
Loading

0 comments on commit a296506

Please sign in to comment.