Skip to content

RDoc-3378 & RDoc-3379 & RDoc-2664 & RDoc-2663 Described Cloud Portal Home Page & Described Cloud Portal API Page #2055

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

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
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
6 changes: 6 additions & 0 deletions Documentation/4.2/Raven.Documentation.Pages/cloud/.docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -81,5 +81,11 @@
"Name": "Product Features",
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
"Mappings": []
},
{
"Path": "cloud-api.markdown",
"Name": "API",
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
"Mappings": []
}
]
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Cloud: API
---

{NOTE: }

*RavenDB Cloud API* provides client libraries that allow you to perform API operations.
The API is defined using the OpenAPI 3.0 standard.

* In this page:
* [Swagger & available clients](../cloud/cloud-api#swagger-&-available-clients)
* [API Keys expiration](../cloud/cloud-api#api-keys-expiration)

{NOTE/}

---

{PANEL: Swagger & available clients}

!["Figure X - Swagger UI"](images\cloud-api-swagger-ui-overview.png "Figure X - Swagger UI")

You can use [Swagger UI](https://api.cloud.ravendb.net/swagger/index.html) to perform the API calls directly from the website
or use [Swagger JSON](https://api.cloud.ravendb.net/api/v1/swagger.json) to prepare your own API client.

Client libraries are available in the following languages:

[C#](https://www.nuget.org/packages/RavenDB.Cloud.Api.Client)
[node.js](https://www.npmjs.com/package/ravendb-cloud)

{PANEL/}

{PANEL: API Keys expiration}

Max expiration period is *12 months* and cannot be longer than this period.

{WARNING: }
RavenDB Cloud does not send reminders about upcoming API key expiration.
{WARNING/}

You can change the expiration date or extend it for another 12 months.
For more details, please check the [Edit API Key](../cloud/portal/cloud-portal-api-tab#edit-api-key) section.

{PANEL/}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
"DiscussionId": "3c97190a-8168-4315-b7b9-09e923616c25",
"Mappings": []
},
{
"Path": "cloud-portal-home-tab.markdown",
"Name": "Home Tab",
"DiscussionId": "7a99aa88-f94e-4d4c-8ecf-4e2c1547cd5d",
"Mappings": []
},
{
"Path": "cloud-portal-products-tab.markdown",
"Name": "Products Tab",
Expand All @@ -23,6 +29,12 @@
"DiscussionId": "62743f76-a49d-4b75-a0ca-fa1283729b65",
"Mappings": []
},
{
"Path": "cloud-portal-api-tab.markdown",
"Name": "API Tab",
"DiscussionId": "2c7b04b6-883f-471e-aae3-40a0a54ad66e",
"Mappings": []
},
{
"Path": "cloud-portal-support-tab.markdown",
"Name": "Support Tab",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Cloud Portal: The API Tab

{NOTE: }

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.

* In this page:
* [The API Tab](../../cloud/portal/cloud-portal-api-tab#the-api-tab)
* [Create API Key](../../cloud/portal/cloud-portal-api-tab#create-api-key)
* [Edit API Key](../../cloud/portal/cloud-portal-api-tab#edit-api-key)
* [Deactivate API Key](../../cloud/portal/cloud-portal-api-tab#deactivate-api-key)
{NOTE/}

---

{PANEL: The API Tab}

!["Figure 1 - The API Tab"](images\portal-api-tab-overview.png "Figure 1 - The API Tab")

You can read more about the *RavenDB Cloud API* in the [API](../../cloud/cloud-api) page.

---

### Create API Key

!["Figure 2 - Create API Key"](images\portal-api-tab-empty-api-key-list.png "Figure 2 - Create API Key")

**1**. Click the *Add API Key* button.

!["Figure 3 - Create API Key - modal"](images\portal-api-tab-create-api-key-modal.png "Figure 3 - Create API Key - modal")

**2**. Enter an API Key description.
**3**. Select an API Key expiration date.
**4**. Click the *Create* button.

!["Figure 4 - Create API Key - modal with API Key"](images\portal-api-tab-create-api-key-modal-copy-api-key.png "Figure 4 - Create API Key - modal with API Key")

**5**. Copy your API Key.
**6**. Click the *Close* button.

---

### Edit API Key

!["Figure 5 - Edit API Key"](images\portal-api-tab-with-api-keys-edit-api-key.png "Figure 5 - Edit API Key")

**1**. Click the *Edit* button.

!["Figure 6 - Edit API Key - modal"](images\portal-api-tab-edit-api-key-modal.png "Figure 6 - Edit API Key - modal")

**2**. Enter an API Key description.
**3**. Select an API Key expiration date.
**4**. Click the *Save* button.

---

### Deactivate API Key

!["Figure 7 - Deactivate API Key"](images\portal-api-tab-with-api-keys-deactivate-api-key.png "Figure 7 - Deactivate API Key")

**1**. Click the *Deactivate* button.

!["Figure 8 - Deactivate API Key - modal"](images\portal-api-tab-deactivate-api-key-modal.png "Figure 8 - Deactivate API Key - modal")

**2**. Click the *Deactivate* button.

---

{PANEL/}

##Related Articles

[Overview](../../cloud/cloud-overview)

[The Products tab](../../cloud/portal/cloud-portal-products-tab)
[The Backups Tab](../../cloud/portal/cloud-portal-backups-tab)
[The Billing & Costs Tab](../../cloud/portal/cloud-portal-billing-tab)
[The Support Tab](../../cloud/portal/cloud-portal-support-tab)

**Links**
[Register]( https://cloud.ravendb.net/user/register)
[Login]( https://cloud.ravendb.net/user/login)
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Cloud Portal: The Home Tab

{NOTE: }

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.

* In this page:
* [The Home Tab](../../cloud/portal/cloud-portal-home-tab#the-home-tab)
{NOTE/}

---

{PANEL: The Home Tab}

!["Figure 1 - The Home Tab"](images\portal-home-tab-overview.png "Figure 1 - The Home Tab")

In the **Your profile** section, you can check your 2FA settings and the date of your last login.

In the **Assigned roles** section, you can view your defined roles.

In the **Documentation** section, you can explore important topics.

In the **Connect & learn** section, you can connect with developers and ask questions.

{PANEL/}

##Related Articles

[Overview](../../cloud/cloud-overview)

[The Products tab](../../cloud/portal/cloud-portal-products-tab)
[The Backups Tab](../../cloud/portal/cloud-portal-backups-tab)
[The Billing & Costs Tab](../../cloud/portal/cloud-portal-billing-tab)
[The Support Tab](../../cloud/portal/cloud-portal-support-tab)

**Links**
[Register]( https://cloud.ravendb.net/user/register)
[Login]( https://cloud.ravendb.net/user/login)
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,57 @@

{NOTE: }

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

!["Account Portal"](images\portal-tabs.png "Account Portal")
* In this page:
* [Cloud Portal overview](../../cloud/portal/cloud-portal#cloud-portal-overview)
{NOTE/}

---

{PANEL: Cloud Portal overview}

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

* **[The Products tab](../../cloud/portal/cloud-portal-products-tab)**
Use this tab to [provision new products](../../cloud/portal/cloud-portal-products-tab#provisioning-a-new-product) and
* **[The Home Tab](../../cloud/portal/cloud-portal-home-tab)**
Use this tab to manage your account and assigned roles, and to view useful resources.

* **[The Products Tab](../../cloud/portal/cloud-portal-products-tab)**
Use this tab to [provision new products](../../cloud/portal/cloud-portal-products-tab#provisioning-a-new-product) and
[manage existing ones](../../cloud/portal/cloud-portal-products-tab#managing-an-existing-product).
A **product** is a RavenDB server or cluster.

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

* **[The Billing & Costs Tab](../../cloud/portal/cloud-portal-billing-tab)**
Use the Billing & Costs tab to view your billing history and expected payments.
Use the Billing & Costs tab to view your billing history and expected payments.

* **[The API Tab](../../cloud/portal/cloud-portal-api-tab)**
Use the API tab to explore the RavenDB Cloud API and manage your API keys.

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

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

{NOTE/}
* **[The Service Status Tab](https://status.ravendb.net/)**
Use this tab to check the status of our system and view active and archived incidents.

{PANEL/}

##Related Articles


[Overview](../../cloud/cloud-overview)

[The Products tab](../../cloud/portal/cloud-portal-products-tab)
[The Backups Tab](../../cloud/portal/cloud-portal-backups-tab)
[The Billing & Costs Tab](../../cloud/portal/cloud-portal-billing-tab)
[The Support Tab](../../cloud/portal/cloud-portal-support-tab)
[The Account Tab](../../cloud/portal/cloud-portal-account-tab)

[The Support Tab](../../cloud/portal/cloud-portal-support-tab)

**Links**
[Register]( https://cloud.ravendb.net/user/register)
[Login]( https://cloud.ravendb.net/user/login)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions Documentation/5.0/Raven.Documentation.Pages/cloud/.docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,11 @@
"Name": "Security",
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
"Mappings": []
},
{
"Path": "cloud-api.markdown",
"Name": "API",
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
"Mappings": []
}
]
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
"DiscussionId": "3c97190a-8168-4315-b7b9-09e923616c25",
"Mappings": []
},
{
"Path": "cloud-portal-home-tab.markdown",
"Name": "Home Tab",
"DiscussionId": "7a99aa88-f94e-4d4c-8ecf-4e2c1547cd5d",
"Mappings": []
},
{
"Path": "cloud-portal-products-tab.markdown",
"Name": "Products Tab",
Expand All @@ -23,6 +29,12 @@
"DiscussionId": "62743f76-a49d-4b75-a0ca-fa1283729b65",
"Mappings": []
},
{
"Path": "cloud-portal-api-tab.markdown",
"Name": "API Tab",
"DiscussionId": "2c7b04b6-883f-471e-aae3-40a0a54ad66e",
"Mappings": []
},
{
"Path": "cloud-portal-support-tab.markdown",
"Name": "Support Tab",
Expand Down
6 changes: 6 additions & 0 deletions Documentation/5.1/Raven.Documentation.Pages/cloud/.docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,11 @@
"Name": "Security",
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
"Mappings": []
},
{
"Path": "cloud-api.markdown",
"Name": "API",
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
"Mappings": []
}
]
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
"DiscussionId": "3c97190a-8168-4315-b7b9-09e923616c25",
"Mappings": []
},
{
"Path": "cloud-portal-home-tab.markdown",
"Name": "Home Tab",
"DiscussionId": "7a99aa88-f94e-4d4c-8ecf-4e2c1547cd5d",
"Mappings": []
},
{
"Path": "cloud-portal-products-tab.markdown",
"Name": "Products Tab",
Expand All @@ -23,6 +29,12 @@
"DiscussionId": "62743f76-a49d-4b75-a0ca-fa1283729b65",
"Mappings": []
},
{
"Path": "cloud-portal-api-tab.markdown",
"Name": "API Tab",
"DiscussionId": "2c7b04b6-883f-471e-aae3-40a0a54ad66e",
"Mappings": []
},
{
"Path": "cloud-portal-support-tab.markdown",
"Name": "Support Tab",
Expand Down
6 changes: 6 additions & 0 deletions Documentation/5.2/Raven.Documentation.Pages/cloud/.docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,11 @@
"Name": "Settings",
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
"Mappings": []
},
{
"Path": "cloud-api.markdown",
"Name": "API",
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
"Mappings": []
}
]
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
"DiscussionId": "3c97190a-8168-4315-b7b9-09e923616c25",
"Mappings": []
},
{
"Path": "cloud-portal-home-tab.markdown",
"Name": "Home Tab",
"DiscussionId": "7a99aa88-f94e-4d4c-8ecf-4e2c1547cd5d",
"Mappings": []
},
{
"Path": "cloud-portal-products-tab.markdown",
"Name": "Products Tab",
Expand All @@ -23,6 +29,12 @@
"DiscussionId": "62743f76-a49d-4b75-a0ca-fa1283729b65",
"Mappings": []
},
{
"Path": "cloud-portal-api-tab.markdown",
"Name": "API Tab",
"DiscussionId": "2c7b04b6-883f-471e-aae3-40a0a54ad66e",
"Mappings": []
},
{
"Path": "cloud-portal-support-tab.markdown",
"Name": "Support Tab",
Expand Down
Loading
Loading