Skip to content

Commit 3bcfa6b

Browse files
gingerwizardgingerwizard
committed
respond to comments
1 parent 7f39ab0 commit 3bcfa6b

8 files changed

+11
-1654
lines changed

‎docs/en/cloud/manage/api/invitations-api-reference.md

Lines changed: 2 additions & 145 deletions
Original file line numberDiff line numberDiff line change
@@ -5,148 +5,5 @@ title: Invitations
55

66
## List all invitations
77

8-
Returns list of all organization invitations.
9-
10-
| Method | Path |
11-
| :----- | :--- |
12-
| GET | `/v1/organizations/{organizationId}/invitations` |
13-
14-
### Request
15-
16-
#### Path Params
17-
18-
| Name | Type | Description |
19-
| :--- | :--- | :---------- |
20-
| organizationId | uuid | ID of the requested organization. |
21-
22-
23-
### Response
24-
25-
#### Response Schema
26-
27-
| Name | Type | Description |
28-
| :--- | :--- | :---------- |
29-
| role | string | Role of the member in the organization. |
30-
| id | uuid | Unique invitation ID. |
31-
| email | email | Email of the invited user. Only a user with this email can join using the invitation. The email is stored in a lowercase form. |
32-
| createdAt | date-time | Invitation creation timestamp. ISO-8601. |
33-
| expireAt | date-time | Timestamp the invitation expires. ISO-8601. |
34-
35-
#### Sample response
36-
37-
```
38-
{
39-
"role": "string",
40-
"id": "uuid",
41-
"email": "email",
42-
"createdAt": "date-time",
43-
"expireAt": "date-time"
44-
}
45-
```
46-
47-
## Create an invitation
48-
49-
Creates organization invitation.
50-
51-
| Method | Path |
52-
| :----- | :--- |
53-
| POST | `/v1/organizations/{organizationId}/invitations` |
54-
55-
### Request
56-
57-
#### Path Params
58-
59-
| Name | Type | Description |
60-
| :--- | :--- | :---------- |
61-
| organizationId | uuid | ID of the organization to invite a user to. |
62-
63-
### Body Params
64-
65-
| Name | Type | Description |
66-
| :--- | :--- | :---------- |
67-
| email | string | Email of the invited user. Only a user with this email can join using the invitation. The email is stored in a lowercase form. |
68-
| role | string | Role of the member in the organization. |
69-
70-
### Response
71-
72-
#### Response Schema
73-
74-
| Name | Type | Description |
75-
| :--- | :--- | :---------- |
76-
| role | string | Role of the member in the organization. |
77-
| id | uuid | Unique invitation ID. |
78-
| email | email | Email of the invited user. Only a user with this email can join using the invitation. The email is stored in a lowercase form. |
79-
| createdAt | date-time | Invitation creation timestamp. ISO-8601. |
80-
| expireAt | date-time | Timestamp the invitation expires. ISO-8601. |
81-
82-
#### Sample response
83-
84-
```
85-
{
86-
"role": "string",
87-
"id": "uuid",
88-
"email": "email",
89-
"createdAt": "date-time",
90-
"expireAt": "date-time"
91-
}
92-
```
93-
94-
## Get invitation details
95-
96-
Returns details for a single organization invitation.
97-
98-
| Method | Path |
99-
| :----- | :--- |
100-
| GET | `/v1/organizations/{organizationId}/invitations/{invitationId}` |
101-
102-
### Request
103-
104-
#### Path Params
105-
106-
| Name | Type | Description |
107-
| :--- | :--- | :---------- |
108-
| organizationId | uuid | ID of the requested organization. |
109-
| invitationId | uuid | ID of the requested organization. |
110-
111-
112-
### Response
113-
114-
#### Response Schema
115-
116-
| Name | Type | Description |
117-
| :--- | :--- | :---------- |
118-
| role | string | Role of the member in the organization. |
119-
| id | uuid | Unique invitation ID. |
120-
| email | email | Email of the invited user. Only a user with this email can join using the invitation. The email is stored in a lowercase form. |
121-
| createdAt | date-time | Invitation creation timestamp. ISO-8601. |
122-
| expireAt | date-time | Timestamp the invitation expires. ISO-8601. |
123-
124-
#### Sample response
125-
126-
```
127-
{
128-
"role": "string",
129-
"id": "uuid",
130-
"email": "email",
131-
"createdAt": "date-time",
132-
"expireAt": "date-time"
133-
}
134-
```
135-
136-
## Delete organization invitation
137-
138-
Deletes a single organization invitation.
139-
140-
| Method | Path |
141-
| :----- | :--- |
142-
| DELETE | `/v1/organizations/{organizationId}/invitations/{invitationId}` |
143-
144-
### Request
145-
146-
#### Path Params
147-
148-
| Name | Type | Description |
149-
| :--- | :--- | :---------- |
150-
| organizationId | uuid | ID of the organization that has the invitation. |
151-
| invitationId | uuid | ID of the requested organization. |
152-
8+
This file is generated by `clickhouseapi.js` during the build process. If the
9+
content needs changing please edit `clickhouseapi.js`.

‎docs/en/cloud/manage/api/keys-api-reference.md

Lines changed: 2 additions & 211 deletions
Original file line numberDiff line numberDiff line change
@@ -5,214 +5,5 @@ title: Keys
55

66
## Get list of all keys
77

8-
Returns a list of all keys in the organization.
9-
10-
| Method | Path |
11-
| :----- | :--- |
12-
| GET | `/v1/organizations/{organizationId}/keys` |
13-
14-
### Request
15-
16-
#### Path Params
17-
18-
| Name | Type | Description |
19-
| :--- | :--- | :---------- |
20-
| organizationId | uuid | ID of the requested organization. |
21-
22-
23-
### Response
24-
25-
#### Response Schema
26-
27-
| Name | Type | Description |
28-
| :--- | :--- | :---------- |
29-
| id | uuid | Unique API key ID. |
30-
| name | string | Name of the key |
31-
| state | string | State of the key: 'enabled', 'disabled'. |
32-
| roles | array | List of roles assigned to the key. Contains at least 1 element. |
33-
| keySuffix | string | Last 4 letters of the key. |
34-
| createdAt | date-time | Timestamp the key was created. ISO-8601. |
35-
| expireAt | date-time | Timestamp the key expires. If not present or is empty the key never expires. ISO-8601. |
36-
| usedAt | date-time | Timestamp the key was used last time. If not present the key was never used. ISO-8601. |
37-
38-
#### Sample response
39-
40-
```
41-
{
42-
"id": "uuid",
43-
"name": "string",
44-
"state": "string",
45-
"roles": "Array",
46-
"keySuffix": "string",
47-
"createdAt": "date-time",
48-
"expireAt": "date-time",
49-
"usedAt": "date-time"
50-
}
51-
```
52-
53-
## Create key
54-
55-
Creates new API key.
56-
57-
| Method | Path |
58-
| :----- | :--- |
59-
| POST | `/v1/organizations/{organizationId}/keys` |
60-
61-
### Request
62-
63-
#### Path Params
64-
65-
| Name | Type | Description |
66-
| :--- | :--- | :---------- |
67-
| organizationId | uuid | ID of the organization that will own the key. |
68-
69-
### Body Params
70-
71-
| Name | Type | Description |
72-
| :--- | :--- | :---------- |
73-
| name | string | Name of the key. |
74-
| expireAt | string | Timestamp the key expires. If not present or is empty the key never expires. ISO-8601. |
75-
| state | string | Initial state of the key: 'enabled', 'disabled'. If not provided the new key will be 'enabled'. |
76-
| hashData | | |
77-
| roles | array | List of roles assigned to the key. Contains at least 1 element. |
78-
79-
### Response
80-
81-
#### Response Schema
82-
83-
| Name | Type | Description |
84-
| :--- | :--- | :---------- |
85-
| key | | |
86-
| keyId | string | Generated key ID. Provided only if there was no 'hashData' in the request. |
87-
| keySecret | string | Generated key secret. Provided only if there was no 'hashData' in the request. |
88-
89-
#### Sample response
90-
91-
```
92-
{
93-
"keyId": "string",
94-
"keySecret": "string"
95-
}
96-
```
97-
98-
## Get key details
99-
100-
Returns a single key details.
101-
102-
| Method | Path |
103-
| :----- | :--- |
104-
| GET | `/v1/organizations/{organizationId}/keys/{keyId}` |
105-
106-
### Request
107-
108-
#### Path Params
109-
110-
| Name | Type | Description |
111-
| :--- | :--- | :---------- |
112-
| organizationId | uuid | ID of the requested organization. |
113-
| keyId | uuid | ID of the requested key. |
114-
115-
116-
### Response
117-
118-
#### Response Schema
119-
120-
| Name | Type | Description |
121-
| :--- | :--- | :---------- |
122-
| id | uuid | Unique API key ID. |
123-
| name | string | Name of the key |
124-
| state | string | State of the key: 'enabled', 'disabled'. |
125-
| roles | array | List of roles assigned to the key. Contains at least 1 element. |
126-
| keySuffix | string | Last 4 letters of the key. |
127-
| createdAt | date-time | Timestamp the key was created. ISO-8601. |
128-
| expireAt | date-time | Timestamp the key expires. If not present or is empty the key never expires. ISO-8601. |
129-
| usedAt | date-time | Timestamp the key was used last time. If not present the key was never used. ISO-8601. |
130-
131-
#### Sample response
132-
133-
```
134-
{
135-
"id": "uuid",
136-
"name": "string",
137-
"state": "string",
138-
"roles": "Array",
139-
"keySuffix": "string",
140-
"createdAt": "date-time",
141-
"expireAt": "date-time",
142-
"usedAt": "date-time"
143-
}
144-
```
145-
146-
## Update key
147-
148-
Updates API key properties.
149-
150-
| Method | Path |
151-
| :----- | :--- |
152-
| PATCH | `/v1/organizations/{organizationId}/keys/{keyId}` |
153-
154-
### Request
155-
156-
#### Path Params
157-
158-
| Name | Type | Description |
159-
| :--- | :--- | :---------- |
160-
| organizationId | uuid | ID of the organization that owns the key. |
161-
| keyId | uuid | ID of the key to update. |
162-
163-
### Body Params
164-
165-
| Name | Type | Description |
166-
| :--- | :--- | :---------- |
167-
| name | string | Name of the key |
168-
| roles | array | List of roles assigned to the key. Contains at least 1 element. |
169-
| expireAt | string | Timestamp the key expires. If not present or is empty the key never expires. ISO-8601. |
170-
| state | string | State of the key: 'enabled', 'disabled'. |
171-
172-
### Response
173-
174-
#### Response Schema
175-
176-
| Name | Type | Description |
177-
| :--- | :--- | :---------- |
178-
| id | uuid | Unique API key ID. |
179-
| name | string | Name of the key |
180-
| state | string | State of the key: 'enabled', 'disabled'. |
181-
| roles | array | List of roles assigned to the key. Contains at least 1 element. |
182-
| keySuffix | string | Last 4 letters of the key. |
183-
| createdAt | date-time | Timestamp the key was created. ISO-8601. |
184-
| expireAt | date-time | Timestamp the key expires. If not present or is empty the key never expires. ISO-8601. |
185-
| usedAt | date-time | Timestamp the key was used last time. If not present the key was never used. ISO-8601. |
186-
187-
#### Sample response
188-
189-
```
190-
{
191-
"id": "uuid",
192-
"name": "string",
193-
"state": "string",
194-
"roles": "Array",
195-
"keySuffix": "string",
196-
"createdAt": "date-time",
197-
"expireAt": "date-time",
198-
"usedAt": "date-time"
199-
}
200-
```
201-
202-
## Delete key
203-
204-
Deletes API key. Only a key not used to authenticate the active request can be deleted.
205-
206-
| Method | Path |
207-
| :----- | :--- |
208-
| DELETE | `/v1/organizations/{organizationId}/keys/{keyId}` |
209-
210-
### Request
211-
212-
#### Path Params
213-
214-
| Name | Type | Description |
215-
| :--- | :--- | :---------- |
216-
| organizationId | uuid | ID of the organization that owns the key. |
217-
| keyId | uuid | ID of the key to delete. |
218-
8+
This file is generated by `clickhouseapi.js` during the build process. If the
9+
content needs changing please edit `clickhouseapi.js`.

0 commit comments

Comments
 (0)