Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename console sm to admin sm #4162

Merged
merged 7 commits into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
id: console-sm-api-authentication
id: administration-sm-api-authentication
title: "Authentication"
sidebar_position: 2
description: "Console SM API is a REST API and provides access to Console SM data. Requests and responses are in JSON notation."
description: "The Administration API for Self-Managed is a REST API and provides access to Console Self-Managed data. Requests and responses are in JSON notation."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we use this sort of phrasing elsewhere in the docs, it might be good to standardize on JSON vs JSON notation, but this isn't blocking for this PR.

---

To authenticate for the API, generate a JWT token and pass it in each request:

1. [Add an M2M application in Identity](/self-managed/identity/user-guide/additional-features/incorporate-applications.md).
2. [Add permissions to this application](/self-managed/identity/user-guide/additional-features/incorporate-applications.md) for **Console SM API**.
2. [Add permissions to this application](/self-managed/identity/user-guide/additional-features/incorporate-applications.md) for **Administration Self-Managed API**.
3. [Generate a token](/self-managed/identity/user-guide/authorizations/generating-m2m-tokens.md) to access the REST API. You will need the `client_id` and `client_secret` from the Identity application you created.
```shell
curl --location --request POST 'http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token' \
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
id: administration-sm-api-overview
title: "Overview"
sidebar_position: 1
description: "Access the Administration API for Self-Managed."
---

The Administration API for Self-Managed is a REST API and provides endpoints to get cluster data including installed apps and usage metrics.

## API Explorer

See [the interactive Administration API Self-Managed Explorer][administration-api-explorer] for specifications, example requests and responses, and code samples of interacting with the Administration Self-Managed API.

### Open API

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
11 changes: 11 additions & 0 deletions docs/apis-tools/administration-sm-api/sidebar-schema.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */

module.exports = {
"Administration API (Self-Managed)": [
"apis-tools/administration-sm-api/administration-sm-api-overview",
"apis-tools/administration-sm-api/administration-sm-api-authentication",
{
Specifications: require("./specifications/sidebar.js"),
},
],
};
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ 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
sidebar_class_name: "get api-method"
info_path: docs/apis-tools/console-sm-api/specifications/console-sm-admin-api
info_path: docs/apis-tools/administration-sm-api/specifications/sm-administration-api
custom_edit_url: null
hide_send_button: true
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ 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
sidebar_class_name: "get api-method"
info_path: docs/apis-tools/console-sm-api/specifications/console-sm-admin-api
info_path: docs/apis-tools/administration-sm-api/specifications/sm-administration-api
custom_edit_url: null
hide_send_button: true
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
module.exports = [
{
type: "doc",
id: "apis-tools/console-sm-api/specifications/console-sm-admin-api",
id: "apis-tools/administration-sm-api/specifications/sm-admin-api",
},
{
type: "category",
label: "Usage Metrics",
items: [
{
type: "doc",
id: "apis-tools/console-sm-api/specifications/get-usage-metrics",
id: "apis-tools/administration-sm-api/specifications/get-usage-metrics",
label: "Get usage metrics for clusters",
className: "api-method get",
},
Expand All @@ -21,7 +21,7 @@ module.exports = [
items: [
{
type: "doc",
id: "apis-tools/console-sm-api/specifications/get-clusters",
id: "apis-tools/administration-sm-api/specifications/get-clusters",
label: "Get current clusters",
className: "api-method get",
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: console-sm-admin-api
title: "Console SM Admin API"
description: "Access the administration API of Console SM."
id: sm-admin-api
title: "Administration API (Self-Managed)"
description: "Access the administration API of Console Self-Managed."
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
Expand All @@ -13,9 +13,9 @@ import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";

<h1 className={"openapi__heading"}>Console SM Admin API</h1>
<h1 className={"openapi__heading"}>Administration API (Self-Managed)</h1>

Access the administration API of Console SM.
Access the administration API of Console Self-Managed.

<div style={{ marginBottom: "2rem" }}>
<h2 id={"authentication"} style={{ marginBottom: "1rem" }}>
Expand Down
4 changes: 2 additions & 2 deletions docs/apis-tools/camunda-api-rest/specifications/sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ module.exports = [
},
{
type: "category",
label: "Process Instance",
label: "Process instance",
items: [
{
type: "doc",
Expand All @@ -107,7 +107,7 @@ module.exports = [
},
{
type: "category",
label: "Decision Definition",
label: "Decision definition",
items: [
{
type: "doc",
Expand Down
20 changes: 0 additions & 20 deletions docs/apis-tools/console-sm-api/console-sm-api-overview.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/apis-tools/console-sm-api/sidebar-schema.js

This file was deleted.

2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -678,7 +678,7 @@ module.exports = {
{
APIs: [
require("./docs/apis-tools/administration-api/sidebar-schema"),
require("./docs/apis-tools/console-sm-api/sidebar-schema"),
require("./docs/apis-tools/administration-sm-api/sidebar-schema"),
require("./docs/apis-tools/camunda-api-rest/sidebar-schema"),
require("./docs/apis-tools/operate-api/sidebar-schema"),
{
Expand Down
3 changes: 3 additions & 0 deletions static/.htaccess
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ RewriteRule (.*) https://%{SERVER_NAME}/$1 [R=301,L]
# Disable directory listing and multi views
Options -Indexes -MultiViews

# Rename Console SM to Administration API (Self-Managed)
RewriteRule ^docs/apis-tools/console-sm-api/(.*)$ /docs/apis-tools/administration-sm-api/$1 [R=301,L]

#remove SM Architecture page
RewriteRule ^docs/next/self-managed/platform-architecture/overview/?$ /docs/next/self-managed/about-self-managed/$1 [R=301,L]
RewriteRule ^docs/self-managed/platform-architecture/overview/?$ /docs/self-managed/about-self-managed/$1 [R=301,L]
Expand Down
Loading