diff --git a/api/console-sm/console-sm-openapi.yaml b/api/administration-sm/administration-sm-openapi.yaml similarity index 98% rename from api/console-sm/console-sm-openapi.yaml rename to api/administration-sm/administration-sm-openapi.yaml index dd81c4cb7d1..4e5c73fef9f 100644 --- a/api/console-sm/console-sm-openapi.yaml +++ b/api/administration-sm/administration-sm-openapi.yaml @@ -155,8 +155,8 @@ components: scheme: bearer bearerFormat: JWT info: - title: Console SM Admin API - description: Access the administration API of Console SM. + title: Administration API (Self-Managed) + description: Access the administration API of Console Self-Managed. version: 1.0.0 contact: url: https://www.camunda.com diff --git a/api/console-sm/generation-strategy.js b/api/administration-sm/generation-strategy.js similarity index 56% rename from api/console-sm/generation-strategy.js rename to api/administration-sm/generation-strategy.js index 2ebe0da279d..3d0908043a2 100644 --- a/api/console-sm/generation-strategy.js +++ b/api/administration-sm/generation-strategy.js @@ -1,15 +1,17 @@ const { makeServerDynamic } = require("../make-server-dynamic"); const removeDuplicateVersionBadge = require("../remove-duplicate-version-badge"); -const outputDir = "docs/apis-tools/console-sm-api/specifications"; -const specFile = "api/console-sm/console-sm-openapi.yaml"; +const outputDir = "docs/apis-tools/administration-sm-api/specifications"; +const specFile = "api/administration-sm/administration-sm-openapi.yaml"; function preGenerateDocs() { makeServerDynamic(specFile); } function postGenerateDocs() { - removeDuplicateVersionBadge(`${outputDir}/console-sm-admin-api.info.mdx`); + removeDuplicateVersionBadge( + `${outputDir}/administration-api-self-managed.info.mdx` + ); } module.exports = { diff --git a/api/generate-api-docs.js b/api/generate-api-docs.js index 6c6f2de56a4..8b4a22187b7 100644 --- a/api/generate-api-docs.js +++ b/api/generate-api-docs.js @@ -3,12 +3,12 @@ const { execSync } = require("child_process"); // More strategies to come, for other APIs. const operate = require("./operate/generation-strategy"); const tasklist = require("./tasklist/generation-strategy"); -const consolesm = require("./console-sm/generation-strategy"); +const adminsm = require("./administration-sm/generation-strategy"); const camunda = require("./camunda/generation-strategy"); const apiStrategies = { operate, tasklist, - consolesm, + adminsm, camunda, }; diff --git a/docs/apis-tools/administration-sm-api/administration-sm-api-overview.md b/docs/apis-tools/administration-sm-api/administration-sm-api-overview.md index 932693c07f7..45bfb7b3056 100644 --- a/docs/apis-tools/administration-sm-api/administration-sm-api-overview.md +++ b/docs/apis-tools/administration-sm-api/administration-sm-api-overview.md @@ -15,4 +15,4 @@ See [the interactive Administration API Self-Managed Explorer][administration-ap An Open API UI is also available within a running instance of Console Self-Managed at `https://${base-url}/admin-api/openapi/docs`. -[administration-api-explorer]: ./specifications/sm-administration-api.info.mdx +[administration-api-explorer]: ./specifications/administration-api-self-managed.info.mdx diff --git a/docs/apis-tools/administration-sm-api/specifications/sm-administration-api.info.mdx b/docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed.info.mdx similarity index 97% rename from docs/apis-tools/administration-sm-api/specifications/sm-administration-api.info.mdx rename to docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed.info.mdx index 5d84abb5475..357adbd146d 100644 --- a/docs/apis-tools/administration-sm-api/specifications/sm-administration-api.info.mdx +++ b/docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed.info.mdx @@ -1,5 +1,5 @@ --- -id: sm-admin-api +id: administration-api-self-managed title: "Administration API (Self-Managed)" description: "Access the administration API of Console Self-Managed." sidebar_label: Introduction diff --git a/docs/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx b/docs/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx index 43b170c8562..cca9bf58fdd 100644 --- a/docs/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx +++ b/docs/apis-tools/administration-sm-api/specifications/get-clusters.api.mdx @@ -5,9 +5,9 @@ description: "Returns a list of all automation and management clusters. Each clu sidebar_label: "Get current clusters" hide_title: true hide_table_of_contents: true -api: eJzFV21v2zYQ/iuEvuyLIntvQGEMA7ygKzI0a9E4KLAgH2jpbLGmSJWk6rmG/vvujrIlvyQxsDcgiCXy7uHdcy88bRNbg5NBWXNTJJNkCeFaNz6A80maOPC1NR58Mtkm343H9FOAz52qSQPl361QLLcmgAm0K+taq5zxRp88iWwTn5dQSXpSASrGqh0dG1REbhpV0G/Y1ICYPjhlloh7eNS9UZ8bEKrAo9RCgRN2IUIJIo8GJ22aGFnBy0i/o9QTyr6W+YUILDrEEMoL1xiDCkKZjCB9kKHxp7TdmIJYAi/UQsghQAlSh3IjrBPGBjz42BAwTZVMHpJOEFcaM3xeGbs2ySMqqqBJ8xojaDXc3U6LSplprbK7aBXatwTTRf9ln2clmod/7HHjHIZBfME8wd0dmTvvB6RGzGP/P8I3DkShfEDxRvmStOYQ1gBGyCbYio0S0hSikkYuoaLjOlyfidvTReQcHwsQgxwka2UQMg9iqe1car1BMYTF/xgbraEQnL1/hlRotQLRsUX839oCNLhMTHuD9odJF2P/B8Acjm0gbw6sYOh3XGmQipn0K42+s3vvkJNKfYXsmVj3jOBiz8fzUe7qeEaYGAi0xz9Tg0/EidnrPTlM8WHyd/QxHempq6nIsuc8/Ep6V3NnV5g2afe6RIi1pLSOTQoIoAPkxcgccRJDFXsR8YBPsVGEi6tiWtc7rv5WOxrQdXkLMMcs/7d9oHH6kgYAom7maKW4//D2CXf/pY5ydIoDiUUG3l9m9V78GcMrQP38QsBO+Ek4NvFzoxwUFCMG5LTa50Pk/ICvx32Q7fwT5BR0WRSK9qR+P6jWhdQeXkjlvvcm0jkuolM3uAmh/Qe96nx9n/jEl3Z34w7vzoGHA9/SHQfchv45T6+Pb5rO27Yle38Yf39aeL9aN1cFli0p/XhuqLkDh2l45bG2BThno/OHMh8gNA7Zkj2JWl90db2Webm/8XHLbfgKksr445T3jIKLyonIKvdQufQUgf2ghnR6wAKiZjd52CZzwNvJ4eNji1u1dBgcFsQVTvTSdrNeQtuhxJeRJEqvZK1GeT8AembCMyr3iGQbp7l2MhptS+tDO9nW1oUWhb9Ip+Rcx/uE9iKzC9lofEy0zaXm5XOpSBtmMJdN39+IeDoPUnTGIdyr8avx+RaFok+g9JNoj1OGUJ/FicJnkdp2QPkdyUWnd8TvW0gHzlD03gmk3QOmImYLrv/2ccY5pszCsvphwou7W8EpT2acGDvNc2pt3IRICPMxVh0bjfb3KJQ+XYdFxW+zcTbu5ncckXgU5yCT2R4jvF6vs1xWjSlkltuKKMQ+AfhFQLJx2E7edivpkXJhc7/XVpbfRw4WgH0+h1EH5EfseI3hx2oZwL6BsL8UBhl54Pq2//T4XwsyBpumyFGtUW9wpcbywhFuV17E96BwY508JNvtXHq4d7ptaRlHC7eJ9borK67nlO77got7m6xg04W/Dlx/uuEOePwN1g6r/s3rGbXbhsza5+lRXjL6rp+azQD7p19YQMxwUDM/40a0IdArnoOV8RcY7wHV +api: eJzFV9uO2zYQ/RViXtoCXNu9AYFQFHAXSbBFtgmyXgSo4QeaGluMKVJLUus4hv69GFKW5cvuGujtyRI1PJw5M3M43oKt0ImgrLnJIYMlhmtd+4DOAweHvrLGo4dsCz+MRvSTo5dOVbQDMni/Ag7SmoAm0FdRVVrJiDf87MlkC14WWAp6UgHLiFU5OjaohFzXKqffsKkQMvDBKbMEfnTUvVEPNTKVowlqodAxu2ChQCaTw9BwMKLEl5H+ECU+sdlXQl6IEE37GEx55mpjlFkyZQYE6YMItT+l7cbkxBJ6phZM9AEKFDoUG2YdMzYAP3EETV1CNoXWEDjUpv+8MnZtYMYhqKBp57U13mq8ux3npTLjSg3uklcNhyWaNvsvxzwplCcPY8S1c2gCe0TnlTU7MnfR90hNmMfxf8JvHLJc+aDMsla+oF1zDGtEw0QdbBmdYsLkrBRGLLGk41pcP2C3p4tMGanrHFmvBslbEZiQgS21nQutN0wRLFPGB6E15ixW75fAmVYrZC1bxP+tzVGjG7Dx3qHuMOFS7v9EnOOxDxTNgRcR+n3sNORsIvxKKx9ieO+roEr1FQfP5HrPCHDY8/F8lts+nhBmw6kz/TM9+ESeInv7SA5LvF/8LX2RDn4aKmeDwXMRfqV9V3NnV+iAt69LEXAtqKyTSCEBtIBxMTFHnKRUJS0iHoBDEopwcVeMq2rH1d+Sox5dl0uAOWb5v9WB2ulLBABZVc+1kuz+47snwv2XFOXoFIciVwa9v8zrzvwZx0sMTskLAVvjJ+Giiw+1cphTjiJgLKuuHhLnB3zNuiTb+WeUlHSR54q+Cf2h160LoT2+UMp77QXhXGyi0zCiCNnFoVad7++TmOKl3d64/buzF2EvNr7jIMrQPxfp9fFN00bbNOTvT6MfTxvvjXVzlecYs/7zuaHmDt0juiuvcmTonE3BH9p8xFA745nYk6j1RVfXayGL7sZHE9wmXkFCGX9c8j6ihAKVY4nVqKFi6SkD3aA24+BR1o7ELptuYY7CoYNsOmtmHCrhRInRMJvOYqEXtp31gD6HAjIYCqL0SlRqKPcDoI9M+IgaNQK2aZprsuFwW1gfmmxbWRca4PAonBJzne4T+paYXYhaB8hAWyl0XD5XivTB9Oay8Ycblk6PgxSdcQj3avRqdF6irAtPoOwn0T1OEUJ1FicZn0Vqmh7ld2SXgt4R30lICx6h6L014O3DG+tKQU78/mkSa0yZhY3b24KPda58SF0Unfj2DvXiKs0/+Xcnno+lJJ2LinS62S66AacPQ1XVCi9k8P1gNBi1Y72QkfaUe4rGZ8Pher0eSFHWJhcDaUtiViuJxscJIs3g8K5d4Uebcyt9t1vZ+D50uECHRuKwBfLDyEdlfSiF6cG+xdDdFb1CPSBhu/9H8r/2aaoBGi6HlRbK9G7a1HVT6LqO+O71c2qfKWy3c+Hx3ummoeWHGt0mtfGu22KbcxoD8tjzW1jhpi2EKsS21HUUxuO/Zk1fDN6+npAK1+RWV75H5RrRdzJrNj3sX36LBmxiV2h+Bd76EOgVmlnTNH8B6kAKmA== sidebar_class_name: "get api-method" -info_path: docs/apis-tools/administration-sm-api/specifications/sm-administration-api +info_path: docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed custom_edit_url: null hide_send_button: true --- diff --git a/docs/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx b/docs/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx index 1de2f6077bd..6b108eaf1ed 100644 --- a/docs/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx +++ b/docs/apis-tools/administration-sm-api/specifications/get-usage-metrics.api.mdx @@ -5,9 +5,9 @@ description: "Returns usage metrics for a specific cluster for a given time rang sidebar_label: "Get usage metrics for clusters" hide_title: true hide_table_of_contents: true -api: eJzlV9tu4zYQ/RVCTy3g2O4NWARFgXTRXaRo2sXGQQsEeRhTY5kbidSSlLOGoH/vDClZsi0b2zZBH/YlkcThmTO3Q7pOTIkWvDL6Ok0ukwz9nYMMb9BbJV0ySSy60miHLrmsk2/nc/6XopNWlbyL9vzxSGbSaI/a8yqUZa5kwJx9cGxSJ06usQB+Ki179CoCqpT/+m2JBOTIp84IbB9/sUahUgJXK4VWmJXw9EXmlfNop0kzYUyJzl1r50HLiHyMUXFgooiRiZWxgsytx1S0+4XqAKbJ5ICoNx7yAVddFUu0ZEY4BVDcSWqqZY6j7KMxMz/mAMKVKCk0KRia4mk46R8rZZGSc996fph0ns3yA0pPfiBNFTuB/N2A6gpyh2SsfM7Wr6l2Jsfbm6u0UPqqVNNhffuMNcxbKseN8E/TiJ9QVpzHDuELT6QH93jn0H52AsE5lWlKIO+kddr6vyaOUhIZtUPqsXDHc9rsMgnWwnbUb4iF5hV8iM2JNWxQLBH1IGhzqlZDHi9Tt8WuVIcMSJlGhGVsSoYFfxmWb4x9HeWOaDLR7+ffHfcWWS1VSkLJlflhTKlv0W7QXjhSU4HWGhui3rd5j76y2p3vk1Z828+Z2lA9vSpQWNAZTsVxm4NFAVlmMQNWCkM8goz3uwTolISDoNNhv57U6Mk53ZkEtBNz5SFzXOKQYtEddVQ6R3hW+S0t1skSibOlx4eGlkqwQLGEob4fnWqtPlZnDiryq9iWjCzPiiY4eg1t1vedtxV1RX9aHkxcMxlzHVIUMklPRdk5HqbWibvfr/8a2CgtCpXnikI2OnUn2AXkswSPxWdfnk5QRqrOSxAm3P9Il2pNdV6b9jbEIgB+TS8z4NG8gFLNQmtfFLs7kgtzFTujsiTSSR1dNpezWb02zjeXdWmsb8h4A1YB+Q6KymtxTldQ5UwsNxLy8HlMT3mBQ+1SdvXuWkTv8SJEPvbhXs1fzUeR2PQESp+uHmftfTmKE41HkUIyu5m6ZbsYdDdZu/ZuwQMUv7cGk/bhTVe0X/9cBMVSemXC9n31FLc3Iugn0zgieyWDfjDLUElFQxUuqYE08e9RWCS4oHHjN9P5dN5ecUGG/MYiM21HFX56eppKKCqdwlSaglNIF2CkSzPbtp35W/tlcrA5NdLtdisT3mcWV2iRhGzWArlZCLyk8hegB7Bv0Y9Idas57jAJdX9P/yKEPraXx09+VuagwskY0l+3U32f7KaaK7M319S8cTzvk7pegsM7mzcNf46iE84B5XiW092BfjLdX71vRelr8ZnHxSj7R9x2p8YG8ooNkiCx/5bI8xweZ7h2Z8jz0H2Og+MM2Xh+9FQfer0ONwFqCYQ0XAvqdgvrSjkM8Oj3796Z8vaXBV8KK+6+nQAeCF5A7+7WejvA/vHnYCAW5hH1T0lH2/Mr+SHJ/Rs/aYl5 +api: eJzlV99v2zYQ/leIe2oBxvZ+AYUwDMiKpciwbEWTYAMMP5zJs81GIhWSShsI+t+HoyRbsWWvGxLsoS+JJR8/fvzu7ju6BleSx2icvdSQwZribcA1XVH0RgWQ4CmUzgYKkNXw7WzG/zQF5U3JqyCDP+5AgnI2ko38LZZlblTCnH4MHFJDUBsqkD+VnneMpgU0mv/Gx5IggxC9sWuQe/g3GxJGk41mZcgLtxJxQ0LlVYjkJ9BIxlQUwqUNEa1qkQ8xKj6YKNqTiZXzIkT0kbTo1gvTA0xA7hGNLmI+4GqrYkkeJKycLzBCBtpVy5xG2bfBzPyQA4pQkjIrowRDT6BpWPT7ynjSkM27nRey39ktP5KKIAG1NrwJ5u8HVFeYB5IQTcw5+q2zweV0fXWuC2PPSzMZ5nenWMO8lQlcCP9WRvpMqmIde4SvXMiI4e42kP9iATEEs7akBa8UFS/9X4WT0DHqmjRSEQ77tNkqid7j4+i+6SwibjCmswWxwQcSSyI7OLQ7lqshj5fJ2802VfsMjIYRYxnrkmHCX4blhfNvW7uDpmGi38++O6ytC+eXRmuynJkfxpz6mvwD+bNgNAny3vl06qcxHyhW3obTddKZb/d6bR7IimgKEh7tmibisMzRk8D12tMa2SncA/lk47tVAq0Wxqq80sN6PerR8pTvyIR2pK8irgOnOEks+lG3kBBIVd7ER8jmNSwJPXnI5otmIaFEjwXF1NTz0a625r46MahAguHY+4o894rFghOfymxXd9FXJAfTcq/jGjm2dZIoKRkiFmW/8VDaIG5/v/xrEGOsKEyem0DKWR2OsEvIJwkems9TezpCmax+EcJkT+v5z3QXEgqKG9fdhtgEMG4ggylya55haaaptM+K7R0ppL5qK6PyOWRQt1s22XRab1yITVaXzscGJDygN7jMW2vl79o+XWGVM7HcKczT6zE/5S/4qL1k5+8vRbt7exFyfg/uzezNbBSJQ4+g7OTa4WxiLEdx2uBRpCRm31PXHNceuu+sbXl34AmKn7sA2X246JP26583ybGMXbm0vHPPZJomxPYim0i8uqZ8dXaFFtekXx8wP1fJTJgyHi52K9EZshjCsHdwnluIbyazyay7+aJKsre559OEbDr99OnTRGFRWY0T5QpWNjeKbCCO7Qr2t+6N3FusnQrb1cal56mnFXmyiqYdUJgmPUoXYoF2APuO4oiDd1YU9uWod9f3r8L/26qL9DlOyxxNGphJ/rpr9jlsm50z86TdF7Lr2jnU9RID3fq8afh160VpPJjALa63c/6o3K8+dF71WnzhFBllf0eP/TB5wLziAEjO+1+JPM9MOcG1Hy3PQ/c55skJsu1Y2VFd7Gw8XRAkbAh1ui3U3RJ2mHJ4wIOfxU9GzbtfbviuWHH1bX1xzwcTen/lto8D7B9/TgHixt2R/Ql62pEfoVk0TfM3+WOSPA== sidebar_class_name: "get api-method" -info_path: docs/apis-tools/administration-sm-api/specifications/sm-administration-api +info_path: docs/apis-tools/administration-sm-api/specifications/administration-api-self-managed custom_edit_url: null hide_send_button: true --- diff --git a/docs/apis-tools/administration-sm-api/specifications/sidebar.js b/docs/apis-tools/administration-sm-api/specifications/sidebar.js index 5c1953863bc..3d3722141b7 100644 --- a/docs/apis-tools/administration-sm-api/specifications/sidebar.js +++ b/docs/apis-tools/administration-sm-api/specifications/sidebar.js @@ -1,7 +1,7 @@ module.exports = [ { type: "doc", - id: "apis-tools/administration-sm-api/specifications/sm-admin-api", + id: "apis-tools/administration-sm-api/specifications/administration-api-self-managed", }, { type: "category", diff --git a/docusaurus.config.js b/docusaurus.config.js index a90cf5de490..1280a40afbf 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -101,15 +101,15 @@ module.exports = { }, ], [ - // Zeebe REST API docs generation + // Administration Self-Managed REST API docs generation "docusaurus-plugin-openapi-docs", { - id: "api-consolesm-openapi", + id: "api-adminsm-openapi", docsPluginId: "default", config: { - consolesm: { - specPath: "api/console-sm/console-sm-openapi.yaml", - outputDir: "docs/apis-tools/console-sm-api/specifications", + adminsm: { + specPath: "api/administration-sm/administration-sm-openapi.yaml", + outputDir: "docs/apis-tools/administration-sm-api/specifications", sidebarOptions: { groupPathsBy: "tag", }, diff --git a/package.json b/package.json index 0bc82be266a..1c85373daab 100644 --- a/package.json +++ b/package.json @@ -28,7 +28,7 @@ "api:generate:operate": "npm run api:generate operate", "api:generate:tasklist": "npm run api:generate tasklist", "api:generate:zeebe": "npm run api:generate zeebe", - "api:generate:consolesm": "npm run api:generate consolesm", + "api:generate:adminsm": "npm run api:generate adminsm", "api:generate:camunda": "npm run api:generate camunda" }, "dependencies": { diff --git a/static/.htaccess b/static/.htaccess index d0fdc799642..b2e62602501 100644 --- a/static/.htaccess +++ b/static/.htaccess @@ -95,6 +95,9 @@ RewriteRule ^docs/reference/bpmn-processes/?(.*)$ /docs/components/modeler/bpmn/ # 8.7: content moves introduced prior to the release of version 8.7. #--------------------------------------------------------------------------------- +# Finalize the renaming of Console SM API to Administration API (Self-Managed) +RewriteRule ^docs/next/apis-tools/administration-sm-api/specifications/sm-administration-api/?$ /docs/next/apis-tools/administration-sm-api/specifications/administration-api-self-managed/ [R=301,L] + # Remove Zeebe REST API RewriteRule ^docs/next/apis-tools/zeebe-api-rest/specifications/?$ /docs/next/apis-tools/camunda-api-rest/specifications/$1 [R=301,L] RewriteRule ^docs/next/apis-tools/zeebe-api-rest/zeebe-api-rest-overview/?$ /docs/next/apis-tools/camunda-api-rest/camunda-api-rest-overview/$1 [R=301,L]