Skip to content

Commit 274689b

Browse files
saig0saig0
committed
feat(engine): create new tenants
related to #CAM-5753
1 parent baaad05 commit 274689b

File tree

12 files changed

+767
-8
lines changed

12 files changed

+767
-8
lines changed

Diff for: ‎.project

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>camunda-docs-manual</name>
4+
<comment></comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
</buildSpec>
9+
<natures>
10+
</natures>
11+
</projectDescription>

Diff for: ‎content/reference/rest/group/get.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@ GET `/group/{id}`
3939

4040
# Result
4141

42-
A JSON array of group objects.
43-
Each group object has the following properties:
42+
A JSON object with the following properties:
4443

4544
<table class="table table-striped">
4645
<tr>
@@ -82,7 +81,7 @@ Each group object has the following properties:
8281
<tr>
8382
<td>404</td>
8483
<td>application/json</td>
85-
<td>Execution with given id does not exist. See the <a href="{{< relref "reference/rest/overview/index.md#error-handling" >}}">Introduction</a> for the error response format.</td>
84+
<td>Group with given id does not exist. See the <a href="{{< relref "reference/rest/overview/index.md#error-handling" >}}">Introduction</a> for the error response format.</td>
8685
</tr>
8786
</table>
8887

Diff for: ‎content/reference/rest/tenant/delete.md

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
3+
title: "Delete Tenant"
4+
weight: 70
5+
6+
menu:
7+
main:
8+
name: "Delete"
9+
identifier: "rest-api-tenant-delete"
10+
parent: "rest-api-tenant"
11+
pre: "DELETE `/tenant/{id}`"
12+
13+
---
14+
15+
16+
Deletes a tenant by id.
17+
18+
19+
# Method
20+
21+
DELETE `/tenant/{id}`
22+
23+
24+
# Parameters
25+
26+
## Path Parameters
27+
28+
<table class="table table-striped">
29+
<tr>
30+
<th>Name</th>
31+
<th>Description</th>
32+
</tr>
33+
<tr>
34+
<td>id</td>
35+
<td>The id of the tenant to be deleted.</td>
36+
</tr>
37+
</table>
38+
39+
40+
# Result
41+
42+
This method returns no content.
43+
44+
45+
# Response Codes
46+
47+
<table class="table table-striped">
48+
<tr>
49+
<th>Code</th>
50+
<th>Media type</th>
51+
<th>Description</th>
52+
</tr>
53+
<tr>
54+
<td>200</td>
55+
<td>application/json</td>
56+
<td>Request successful.</td>
57+
</tr>
58+
<tr>
59+
<td>403</td>
60+
<td>application/json</td>
61+
<td>Identity service is read-only.</td>
62+
</tr>
63+
<tr>
64+
<td>404</td>
65+
<td>application/json</td>
66+
<td>Tenant cannot be found. See the <a href="{{< relref "reference/rest/overview/index.md#error-handling" >}}">Introduction</a> for the error response format.</td>
67+
</tr>
68+
</table>
69+
70+
71+
# Example
72+
73+
## Request
74+
75+
DELETE `/tenant/tenantOne`
76+
77+
## Response
78+
79+
Status 204. No content.

Diff for: ‎content/reference/rest/tenant/get-query-count.md

+96
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
3+
title: "Get Tenants Count"
4+
weight: 20
5+
6+
menu:
7+
main:
8+
name: "Get List Count"
9+
identifier: "rest-api-tenant-get-query-count"
10+
parent: "rest-api-tenant"
11+
pre: "GET `/tenant/count`"
12+
13+
---
14+
15+
16+
Query for tenants using a list of parameters and retrieves the count.
17+
18+
# Method
19+
20+
GET `/tenant/count`
21+
22+
23+
# Parameters
24+
25+
## Query Parameters
26+
27+
<table class="table table-striped">
28+
<tr>
29+
<th>Name</th>
30+
<th>Description</th>
31+
</tr>
32+
<tr>
33+
<td>id</td>
34+
<td>Filter by the id of the tenant.</td>
35+
</tr>
36+
<tr>
37+
<td>name</td>
38+
<td>Filter by the name of the tenant.</td>
39+
</tr>
40+
<tr>
41+
<td>nameLike</td>
42+
<td>Filter by the name that the parameter is a substring of.</td>
43+
</tr>
44+
</table>
45+
46+
47+
# Result
48+
49+
A JSON object that contains the count as the only property.
50+
51+
<table class="table table-striped">
52+
<tr>
53+
<th>Name</th>
54+
<th>Value</th>
55+
<th>Description</th>
56+
</tr>
57+
<tr>
58+
<td>count</td>
59+
<td>Number</td>
60+
<td>The number of matching tenants.</td>
61+
</tr>
62+
</table>
63+
64+
65+
# Response Codes
66+
67+
<table class="table table-striped">
68+
<tr>
69+
<th>Code</th>
70+
<th>Media type</th>
71+
<th>Description</th>
72+
</tr>
73+
<tr>
74+
<td>200</td>
75+
<td>application/json</td>
76+
<td>Request successful.</td>
77+
</tr>
78+
<tr>
79+
<td>400</td>
80+
<td>application/json</td>
81+
<td>Returned if some of the query parameters are invalid. See the <a href="{{< relref "reference/rest/overview/index.md#error-handling" >}}">Introduction</a> for the error response format.</td>
82+
</tr>
83+
</table>
84+
85+
86+
# Example
87+
88+
## Request
89+
90+
GET `/tenant/count?name=tenantOne`
91+
92+
## Response
93+
94+
Status 200.
95+
96+
{"count": 1}

Diff for: ‎content/reference/rest/tenant/get-query.md

+126
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
3+
title: "Get Tenants"
4+
weight: 10
5+
6+
menu:
7+
main:
8+
name: "Get List"
9+
identifier: "rest-api-tenant-get-query"
10+
parent: "rest-api-tenant"
11+
pre: "GET `/tenant`"
12+
13+
---
14+
15+
16+
Query for a list of tenants using a list of parameters.
17+
The size of the result set can be retrieved by using the [get tenants count]({{< relref "reference/rest/tenant/get-query-count.md" >}}) method.
18+
19+
20+
# Method
21+
22+
GET `/tenant`
23+
24+
25+
# Parameters
26+
27+
## Query Parameters
28+
29+
<table class="table table-striped">
30+
<tr>
31+
<th>Name</th>
32+
<th>Description</th>
33+
</tr>
34+
<tr>
35+
<td>id</td>
36+
<td>Filter by the id of the tenant.</td>
37+
</tr>
38+
<tr>
39+
<td>name</td>
40+
<td>Filter by the name of the tenant.</td>
41+
</tr>
42+
<tr>
43+
<td>nameLike</td>
44+
<td>Filter by the name that the parameter is a substring of.</td>
45+
</tr>
46+
<tr>
47+
<td>sortBy</td>
48+
<td>Sort the results lexicographically by a given criterion. Valid values are
49+
<code>id</code> and <code>name</code>.
50+
Must be used in conjunction with the <code>sortOrder</code> parameter.</td>
51+
</tr>
52+
<tr>
53+
<td>sortOrder</td>
54+
<td>Sort the results in a given order. Values may be <code>asc</code> for ascending order or <code>desc</code> for descending order.
55+
Must be used in conjunction with the <code>sortBy</code> parameter.</td>
56+
</tr>
57+
<tr>
58+
<td>firstResult</td>
59+
<td>Pagination of results. Specifies the index of the first result to return.</td>
60+
</tr>
61+
<tr>
62+
<td>maxResults</td>
63+
<td>Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.</td>
64+
</tr>
65+
</table>
66+
67+
68+
# Result
69+
70+
A JSON array of tenant objects.
71+
Each tenant object has the following properties:
72+
73+
<table class="table table-striped">
74+
<tr>
75+
<th>Name</th>
76+
<th>Value</th>
77+
<th>Description</th>
78+
</tr>
79+
<tr>
80+
<td>id</td>
81+
<td>String</td>
82+
<td>The id of the tenant.</td>
83+
</tr>
84+
<tr>
85+
<td>name</td>
86+
<td>String</td>
87+
<td>The name of the tenant.</td>
88+
</tr>
89+
</table>
90+
91+
92+
# Response Codes
93+
94+
<table class="table table-striped">
95+
<tr>
96+
<th>Code</th>
97+
<th>Media type</th>
98+
<th>Description</th>
99+
</tr>
100+
<tr>
101+
<td>200</td>
102+
<td>application/json</td>
103+
<td>Request successful.</td>
104+
</tr>
105+
<tr>
106+
<td>400</td>
107+
<td>application/json</td>
108+
<td>Returned if some of the query parameters are invalid, for example if a <code>sortOrder</code> parameter is supplied, but no <code>sortBy</code> is specified. See the <a href="{{< relref "reference/rest/overview/index.md#error-handling" >}}">Introduction</a> for the error response format.</td>
109+
</tr>
110+
</table>
111+
112+
113+
# Example
114+
115+
## Request
116+
117+
GET `/tenant?name=tenantOne`
118+
119+
## Response
120+
121+
Status 200.
122+
123+
[{
124+
"id":"tenantOne",
125+
"name":"Tenant One"
126+
}]

0 commit comments

Comments
 (0)