Skip to content

Commit 29201ac

Browse files
authored
Merge pull request #3374 from Blargian/fix_image_sizes
Fix images on "Managing API Keys"
2 parents 3a6c425 + 5607d20 commit 29201ac

File tree

9 files changed

+29
-20
lines changed

9 files changed

+29
-20
lines changed

docs/_snippets/images/openapi1.png

-37.8 KB
Binary file not shown.

docs/cloud/manage/openapi.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,39 @@ slug: /cloud/manage/openapi
44
title: Managing API Keys
55
---
66

7-
ClickHouse Cloud provides an API utilizing OpenAPI that allows you to programmatically manage your account and aspects of your services.
7+
import image_01 from '@site/static/images/cloud/manage/openapi1.png';
8+
import image_02 from '@site/static/images/cloud/manage/openapi2.png';
9+
import image_03 from '@site/static/images/cloud/manage/openapi3.png';
10+
import image_04 from '@site/static/images/cloud/manage/openapi4.png';
11+
import image_05 from '@site/static/images/cloud/manage/openapi5.png';
812

913
# Managing API Keys
1014

15+
ClickHouse Cloud provides an API utilizing OpenAPI that allows you to programmatically manage your account and aspects of your services.
16+
1117
:::note
1218
This document covers the ClickHouse Cloud API. For database API endpoints, please see [Cloud Endpoints API](//cloud/get-started/query-endpoints.md)
1319
:::
1420

1521
1. You can use the **API Keys** tab on the left menu to create and manage your API keys.
1622

17-
![ClickHouse Cloud API Keys Tab](@site/docs/_snippets/images/openapi1.png)
23+
<img src={image_01} width="50%"/>
1824

1925
2. The **API Keys** page will initially display a prompt to create your first API key as shown below. After your first key is created, you can create new keys using the `New API Key` button that appears in the top right corner.
2026

21-
![Initial API Screen](@site/docs/_snippets/images/openapi2.png)
27+
<img src={image_02} width="100%"/>
2228

2329
3. To create an API key, specify the key name, permissions for the key, and expiration time, then click `Generate API Key`.
30+
<br/>
2431
:::note
2532
Permissions align with ClickHouse Cloud [predefined roles](/cloud/security/cloud-access-management#predefined-roles). The developer role has read-only permissions and the admin role has full read and write permissions.
2633
:::
2734

28-
![Create API Key](@site/docs/_snippets/images/openapi3.png)
29-
35+
<img src={image_03} width="100%"/>
36+
3037
4. The next screen will display your Key ID and Key secret. Copy these values and put them somewhere safe, such as a vault. The values will not be displayed after you leave this screen.
3138

32-
![API Key ID and Key Secret](@site/docs/_snippets/images/openapi4.png)
39+
<img src={image_04} width="100%"/>
3340

3441
5. The ClickHouse Cloud API uses [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) to verify the validity of your API keys. Here is an example of how to use your API keys to send requests to the ClickHouse Cloud API using `curl`:
3542

@@ -41,12 +48,12 @@ $ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations
4148
```
4249

4350
6. Returning to the **API Keys** page, you will see the key name, last four characters of the Key ID, permissions, status, expiration date, and creator. You are able to edit the key name, permissions, and expiration from this screen. Keys may also be disabled or deleted form this screen.
44-
51+
<br/>
4552
:::note
4653
Deleting an API key is a permanent action. Any services using the key will immediately lose access to ClickHouse Cloud.
4754
:::
4855

49-
![API Key Management](@site/docs/_snippets/images/openapi5.png)
56+
<img src={image_05} width="100%"/>
5057

5158
## Endpoints {#endpoints}
5259

src/css/custom.scss

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -475,18 +475,6 @@ prism-code {
475475
}
476476

477477
/* Add a drop shadow to images in the user guides and docs */
478-
img {
479-
width: 100%;
480-
max-width: 1000px;
481-
/* padding looks bad in dark mode as it adds white space around images that have dark backgrounds */
482-
/*padding-bottom: 0.2rem;
483-
padding-top: 0.5rem;*/
484-
display: block;
485-
margin-left: auto;
486-
margin-right: auto;
487-
background: var(--clickhouse-img-background-color);
488-
box-shadow: 0px 1px 8px -1px rgba(21, 21, 21, 0.20);
489-
}
490478

491479
.eighty-percent {
492480
max-width: 80%;

src/theme/DocItem/Layout/styles.module.css

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,25 @@
55
}
66

77
.docItemContainer {
8+
max-width: 1000px;
89
display: flex;
910
flex-direction: column;
1011
justify-content: space-between;
1112
height: 100%;
1213
padding-bottom: 3.5rem;
14+
15+
img {
16+
/* padding looks bad in dark mode as it adds white space around images that have dark backgrounds */
17+
/*padding-bottom: 0.2rem;
18+
padding-top: 0.5rem;*/
19+
display: block;
20+
margin-left: auto;
21+
margin-right: auto;
22+
margin-top: 16px;
23+
margin-bottom: 16px;
24+
background: var(--clickhouse-img-background-color);
25+
box-shadow: 0px 1px 8px -1px rgba(21, 21, 21, 0.20);
26+
}
1327
}
1428

1529
.docHeaderContainer {
35.7 KB
Loading
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)