Skip to content

Commit eec0c06

Browse files
authored
Merge pull request #2055 from PFYasu/RDoc-3378-3379
RDoc-3378 & RDoc-3379 & RDoc-2664 & RDoc-2663 Described Cloud Portal Home Page & Described Cloud Portal API Page
2 parents b5998ce + c171a0c commit eec0c06

File tree

35 files changed

+401
-17
lines changed

35 files changed

+401
-17
lines changed

Documentation/4.2/Raven.Documentation.Pages/cloud/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,5 +81,11 @@
8181
"Name": "Product Features",
8282
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
8383
"Mappings": []
84+
},
85+
{
86+
"Path": "cloud-api.markdown",
87+
"Name": "API",
88+
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
89+
"Mappings": []
8490
}
8591
]
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Cloud: API
2+
---
3+
4+
{NOTE: }
5+
6+
*RavenDB Cloud API* provides client libraries that allow you to perform API operations.
7+
The API is defined using the OpenAPI 3.0 standard.
8+
9+
* In this page:
10+
* [Swagger & available clients](#swagger-&-available-clients)
11+
* [API methods overview](#api-methods-overview)
12+
* [API Keys expiration](#api-keys-expiration)
13+
* [Product quota](#product-quota)
14+
15+
{NOTE/}
16+
17+
---
18+
19+
{PANEL: Swagger & available clients}
20+
21+
!["Figure 1 - Swagger UI"](images\cloud-api-swagger-ui-overview.png "Figure 1 - Swagger UI")
22+
23+
You can use [Swagger UI](https://api.cloud.ravendb.net/swagger/index.html) to perform the API calls directly from the website
24+
or use [Swagger JSON](https://api.cloud.ravendb.net/api/v1/swagger.json) to prepare your own API client.
25+
26+
Client libraries are available in the following languages:
27+
28+
[C#](https://www.nuget.org/packages/RavenDB.Cloud.Api.Client)
29+
[node.js](https://www.npmjs.com/package/ravendb-cloud)
30+
31+
{PANEL/}
32+
33+
{PANEL: API methods overview}
34+
35+
*The RavenDB Cloud API* contains three categories of API methods: **Account**, **Metadata**, **Products**.
36+
37+
| **Category** | **Description** |
38+
|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
39+
| Account | Returns Cloud account information - domain name. |
40+
| Metadata | Return information about available instance types, regions and release channels. |
41+
| Products | Allows to manage products - restart a node, download a client certificate, change the instance and disk type, terminate a cluster, add or remove an additional node from the cluster. |
42+
43+
More information about available methods, requests and responses can be found in the [Swagger & available clients](#swagger-&-available-clients) section.
44+
45+
{PANEL/}
46+
47+
{PANEL: API Keys expiration}
48+
49+
Max expiration period is *12 months* and cannot be longer than this period.
50+
51+
{WARNING: }
52+
RavenDB Cloud does not send reminders about upcoming API key expiration.
53+
{WARNING/}
54+
55+
You can change the expiration date or extend it for another *12 months*.
56+
For more details, please check the [Edit API Key](../cloud/portal/cloud-portal-api-tab#edit-api-key) section.
57+
58+
{PANEL/}
59+
60+
{PANEL: Product quota}
61+
62+
You cannot create another product via the *RavenDB Cloud API* if you have **three or more** products.
63+
64+
{INFO: }
65+
Contact support to extend the quota.
66+
{INFO/}
67+
68+
{PANEL/}
76.3 KB
Loading

Documentation/4.2/Raven.Documentation.Pages/cloud/portal/.docs.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
"DiscussionId": "3c97190a-8168-4315-b7b9-09e923616c25",
66
"Mappings": []
77
},
8+
{
9+
"Path": "cloud-portal-home-tab.markdown",
10+
"Name": "Home Tab",
11+
"DiscussionId": "7a99aa88-f94e-4d4c-8ecf-4e2c1547cd5d",
12+
"Mappings": []
13+
},
814
{
915
"Path": "cloud-portal-products-tab.markdown",
1016
"Name": "Products Tab",
@@ -23,6 +29,12 @@
2329
"DiscussionId": "62743f76-a49d-4b75-a0ca-fa1283729b65",
2430
"Mappings": []
2531
},
32+
{
33+
"Path": "cloud-portal-api-tab.markdown",
34+
"Name": "API Tab",
35+
"DiscussionId": "2c7b04b6-883f-471e-aae3-40a0a54ad66e",
36+
"Mappings": []
37+
},
2638
{
2739
"Path": "cloud-portal-support-tab.markdown",
2840
"Name": "Support Tab",
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Cloud Portal: The API Tab
2+
3+
{NOTE: }
4+
5+
The RavenDB Cloud API allows you to automate actions on your RavenDB Cloud products. By making simple HTTP calls, you can adjust your storage size or change the instance type. Scale up or down without visiting the RavenDB Cloud portal.
6+
7+
* In this page:
8+
* [The API Tab](../../cloud/portal/cloud-portal-api-tab#the-api-tab)
9+
* [Create API Key](../../cloud/portal/cloud-portal-api-tab#create-api-key)
10+
* [Edit API Key](../../cloud/portal/cloud-portal-api-tab#edit-api-key)
11+
* [Deactivate API Key](../../cloud/portal/cloud-portal-api-tab#deactivate-api-key)
12+
{NOTE/}
13+
14+
---
15+
16+
{PANEL: The API Tab}
17+
18+
!["Figure 1 - The API Tab"](images\portal-api-tab-overview.png "Figure 1 - The API Tab")
19+
20+
You can read more about the *RavenDB Cloud API* in the [API](../../cloud/cloud-api) page.
21+
22+
---
23+
24+
### Create API Key
25+
26+
!["Figure 2 - Create API Key"](images\portal-api-tab-empty-api-key-list.png "Figure 2 - Create API Key")
27+
28+
**1**. Click the *Add API Key* button.
29+
30+
!["Figure 3 - Create API Key - configuration"](images\portal-api-tab-create-api-key-modal.png "Figure 3 - Create API Key - configuration")
31+
32+
**2**. Enter an API Key description.
33+
**3**. Select an API Key expiration date.
34+
**4**. Click the *Create* button.
35+
36+
!["Figure 4 - Create API Key - API Key"](images\portal-api-tab-create-api-key-modal-copy-api-key.png "Figure 4 - Create API Key - API Key")
37+
38+
**5**. Copy your API Key.
39+
**6**. Click the *Close* button.
40+
41+
---
42+
43+
### Edit API Key
44+
45+
!["Figure 5 - Edit API Key"](images\portal-api-tab-with-api-keys-edit-api-key.png "Figure 5 - Edit API Key")
46+
47+
**1**. Click the *Edit* button.
48+
49+
!["Figure 6 - Edit API Key - configuration"](images\portal-api-tab-edit-api-key-modal.png "Figure 6 - Edit API Key - configuration")
50+
51+
**2**. Enter an API Key description.
52+
**3**. Select an API Key expiration date.
53+
**4**. Click the *Save* button.
54+
55+
---
56+
57+
### Deactivate API Key
58+
59+
!["Figure 7 - Deactivate API Key"](images\portal-api-tab-with-api-keys-deactivate-api-key.png "Figure 7 - Deactivate API Key")
60+
61+
**1**. Click the *Deactivate* button.
62+
63+
!["Figure 8 - Deactivate API Key - confirmation"](images\portal-api-tab-deactivate-api-key-modal.png "Figure 8 - Deactivate API Key - confirmation")
64+
65+
**2**. Click the *Deactivate* button.
66+
67+
---
68+
69+
{PANEL/}
70+
71+
##Related Articles
72+
73+
[Overview](../../cloud/cloud-overview)
74+
75+
[The Products tab](../../cloud/portal/cloud-portal-products-tab)
76+
[The Backups Tab](../../cloud/portal/cloud-portal-backups-tab)
77+
[The Billing & Costs Tab](../../cloud/portal/cloud-portal-billing-tab)
78+
[The Support Tab](../../cloud/portal/cloud-portal-support-tab)
79+
80+
**Links**
81+
[Register]( https://cloud.ravendb.net/user/register)
82+
[Login]( https://cloud.ravendb.net/user/login)
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Cloud Portal: The Home Tab
2+
3+
{NOTE: }
4+
5+
Use this tab to manage your account and assigned roles. You can also use it to view useful resources, such as documentation, the community, and articles.
6+
7+
* In this page:
8+
* [The Home Tab](../../cloud/portal/cloud-portal-home-tab#the-home-tab)
9+
{NOTE/}
10+
11+
---
12+
13+
{PANEL: The Home Tab}
14+
15+
!["Figure 1 - The Home Tab"](images\portal-home-tab-overview.png "Figure 1 - The Home Tab")
16+
17+
In the **Your profile** section, you can check your 2FA settings and the date of your last login.
18+
19+
In the **Assigned roles** section, you can view your defined roles.
20+
21+
In the **Documentation** section, you can explore important topics.
22+
23+
In the **Connect & learn** section, you can connect with developers and ask questions.
24+
25+
{PANEL/}
26+
27+
##Related Articles
28+
29+
[Overview](../../cloud/cloud-overview)
30+
31+
[The Products tab](../../cloud/portal/cloud-portal-products-tab)
32+
[The Backups Tab](../../cloud/portal/cloud-portal-backups-tab)
33+
[The Billing & Costs Tab](../../cloud/portal/cloud-portal-billing-tab)
34+
[The Support Tab](../../cloud/portal/cloud-portal-support-tab)
35+
36+
**Links**
37+
[Register]( https://cloud.ravendb.net/user/register)
38+
[Login]( https://cloud.ravendb.net/user/login)

Documentation/4.2/Raven.Documentation.Pages/cloud/portal/cloud-portal.markdown

Lines changed: 33 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,57 @@
22

33
{NOTE: }
44

5-
[Logging into your account](../../cloud/cloud-overview#login-to-your-account)
6-
takes you to your account's Portal, which gives you access to all the different aspects of your cloud account.
5+
[Logging into your account](../../cloud/cloud-overview#login-to-your-account)
6+
takes you to your account's Portal, which gives you access to all the different aspects of your cloud account.
77

8-
!["Account Portal"](images\portal-tabs.png "Account Portal")
8+
* In this page:
9+
* [Cloud Portal overview](../../cloud/portal/cloud-portal#cloud-portal-overview)
10+
{NOTE/}
11+
12+
---
13+
14+
{PANEL: Cloud Portal overview}
915

16+
!["Figure 1 - Cloud Portal overview"](images\portal-tabs.png "Figure 1 - Cloud Portal overview")
1017

11-
* **[The Products tab](../../cloud/portal/cloud-portal-products-tab)**
12-
Use this tab to [provision new products](../../cloud/portal/cloud-portal-products-tab#provisioning-a-new-product) and
18+
* **[The Home Tab](../../cloud/portal/cloud-portal-home-tab)**
19+
Use this tab to manage your account and assigned roles, and to view useful resources.
20+
21+
* **[The Products Tab](../../cloud/portal/cloud-portal-products-tab)**
22+
Use this tab to [provision new products](../../cloud/portal/cloud-portal-products-tab#provisioning-a-new-product) and
1323
[manage existing ones](../../cloud/portal/cloud-portal-products-tab#managing-an-existing-product).
14-
A **product** is a RavenDB server or cluster.
1524

1625
* **[The Backups Tab](../../cloud/portal/cloud-portal-backups-tab)**
17-
Use this tab to view and restore [mandatory database backups](../../cloud/cloud-backup-and-restore#the-mandatory-backup-routine)
18-
that your instances have created for you.
26+
Use this tab to view and restore [mandatory database backups](../../cloud/cloud-backup-and-restore#the-mandatory-backup-routine)
27+
that your instances have created for you.
1928

2029
* **[The Billing & Costs Tab](../../cloud/portal/cloud-portal-billing-tab)**
21-
Use the Billing & Costs tab to view your billing history and expected payments.
30+
Use the Billing & Costs tab to view your billing history and expected payments.
31+
32+
* **[The API Tab](../../cloud/portal/cloud-portal-api-tab)**
33+
Use the API tab to explore the RavenDB Cloud API and manage your API keys.
2234

2335
* **[The Support Tab](../../cloud/portal/cloud-portal-support-tab)**
24-
Use this tab to contact Support regarding [general issues](../../cloud/portal/cloud-portal-support-tab#submit-a-general-support-call),
25-
[product-specific issues](../../cloud/portal/cloud-portal-support-tab#submit-a-product-specific-support-call) and special requests.
36+
Use this tab to contact Support regarding [general issues](../../cloud/portal/cloud-portal-support-tab#submit-a-general-support-call),
37+
[product-specific issues](../../cloud/portal/cloud-portal-support-tab#submit-a-product-specific-support-call) and special requests.
2638

2739
* **[The Account Tab](../../cloud/portal/cloud-portal-account-tab)**
28-
Use the account tab to view and edit your invoices and credit card information.
40+
Use the account tab to view and edit your invoices and credit card information.
2941

30-
{NOTE/}
42+
* **[The Service Status Tab](https://status.ravendb.net/)**
43+
Use this tab to check the status of our system and view active and archived incidents.
44+
45+
{PANEL/}
3146

3247
##Related Articles
33-
48+
49+
[Overview](../../cloud/cloud-overview)
50+
3451
[The Products tab](../../cloud/portal/cloud-portal-products-tab)
3552
[The Backups Tab](../../cloud/portal/cloud-portal-backups-tab)
3653
[The Billing & Costs Tab](../../cloud/portal/cloud-portal-billing-tab)
37-
[The Support Tab](../../cloud/portal/cloud-portal-support-tab)
38-
[The Account Tab](../../cloud/portal/cloud-portal-account-tab)
39-
54+
[The Support Tab](../../cloud/portal/cloud-portal-support-tab)
55+
4056
**Links**
4157
[Register]( https://cloud.ravendb.net/user/register)
4258
[Login]( https://cloud.ravendb.net/user/login)
Loading
26.9 KB
Loading
16 KB
Loading

0 commit comments

Comments
 (0)