Skip to content

Commit 23702d2

Browse files
PFYasuPFYasu
committed
RDoc-2664 & RDoc-2663 Introduced Cloud API sections
1 parent 532eb8e commit 23702d2

File tree

33 files changed

+246
-2
lines changed

33 files changed

+246
-2
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
]

‎Documentation/4.2/Raven.Documentation.Pages/cloud/cloud-api.markdown

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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](../cloud/cloud-api#swagger-&-available-clients)
11+
* [API Keys expiration](../cloud/cloud-api#api-keys-expiration)
12+
13+
{NOTE/}
14+
15+
---
16+
17+
{PANEL: Swagger & available clients}
18+
19+
!["Figure X - Swagger UI"](images\cloud-api-swagger-ui-overview.png "Figure X - Swagger UI")
20+
21+
You can use [Swagger UI](https://api.cloud.ravendb.net/swagger/index.html) to perform the API calls directly from the website
22+
or use [Swagger JSON](https://api.cloud.ravendb.net/api/v1/swagger.json) to prepare your own API client.
23+
24+
Client libraries are available in the following languages:
25+
26+
[C#](https://www.nuget.org/packages/RavenDB.Cloud.Api.Client)
27+
[node.js](https://www.npmjs.com/package/ravendb-cloud)
28+
29+
{PANEL/}
30+
31+
{PANEL: API Keys expiration}
32+
33+
Max expiration period is *12 months* and cannot be longer than this period.
34+
35+
{WARNING: }
36+
RavenDB Cloud does not send reminders about upcoming API key expiration.
37+
{WARNING/}
38+
39+
You can change the expiration date or extend it for another 12 months.
40+
For more details, please check the [Edit API Key](../cloud/portal/cloud-portal-api-tab#edit-api-key) section.
41+
42+
{PANEL/}

‎Documentation/4.2/Raven.Documentation.Pages/cloud/images/cloud-api-swagger-ui-overview.png

76.3 KB
Loading

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@
2929
"DiscussionId": "62743f76-a49d-4b75-a0ca-fa1283729b65",
3030
"Mappings": []
3131
},
32+
{
33+
"Path": "cloud-portal-api-tab.markdown",
34+
"Name": "API Tab",
35+
"DiscussionId": "2c7b04b6-883f-471e-aae3-40a0a54ad66e",
36+
"Mappings": []
37+
},
3238
{
3339
"Path": "cloud-portal-support-tab.markdown",
3440
"Name": "Support Tab",

‎Documentation/4.2/Raven.Documentation.Pages/cloud/portal/cloud-portal-api-tab.markdown

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 - modal"](images\portal-api-tab-create-api-key-modal.png "Figure 3 - Create API Key - modal")
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 - 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")
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 - modal"](images\portal-api-tab-edit-api-key-modal.png "Figure 6 - Edit API Key - modal")
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 - modal"](images\portal-api-tab-deactivate-api-key-modal.png "Figure 8 - Deactivate API Key - modal")
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)

‎Documentation/4.2/Raven.Documentation.Pages/cloud/portal/cloud-portal-home-tab.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Use this tab to manage your account and assigned roles. You can also use it to v
66

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

1111
---
1212

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ takes you to your account's Portal, which gives you access to all the different
2929
* **[The Billing & Costs Tab](../../cloud/portal/cloud-portal-billing-tab)**
3030
Use the Billing & Costs tab to view your billing history and expected payments.
3131

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

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

‎Documentation/4.2/Raven.Documentation.Pages/cloud/portal/images/portal-api-tab-create-api-key-modal-copy-api-key.png

30.3 KB
Loading

‎Documentation/4.2/Raven.Documentation.Pages/cloud/portal/images/portal-api-tab-create-api-key-modal.png

26.9 KB
Loading

‎Documentation/4.2/Raven.Documentation.Pages/cloud/portal/images/portal-api-tab-deactivate-api-key-modal.png

16 KB
Loading

‎Documentation/4.2/Raven.Documentation.Pages/cloud/portal/images/portal-api-tab-edit-api-key-modal.png

24.2 KB
Loading

‎Documentation/4.2/Raven.Documentation.Pages/cloud/portal/images/portal-api-tab-empty-api-key-list.png

27.5 KB
Loading

‎Documentation/4.2/Raven.Documentation.Pages/cloud/portal/images/portal-api-tab-overview.png

118 KB
Loading

‎Documentation/4.2/Raven.Documentation.Pages/cloud/portal/images/portal-api-tab-with-api-keys-deactivate-api-key.png

60.6 KB
Loading

‎Documentation/4.2/Raven.Documentation.Pages/cloud/portal/images/portal-api-tab-with-api-keys-edit-api-key.png

60.6 KB
Loading

‎Documentation/5.0/Raven.Documentation.Pages/cloud/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,11 @@
4545
"Name": "Security",
4646
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
4747
"Mappings": []
48+
},
49+
{
50+
"Path": "cloud-api.markdown",
51+
"Name": "API",
52+
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
53+
"Mappings": []
4854
}
4955
]

‎Documentation/5.0/Raven.Documentation.Pages/cloud/portal/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@
2929
"DiscussionId": "62743f76-a49d-4b75-a0ca-fa1283729b65",
3030
"Mappings": []
3131
},
32+
{
33+
"Path": "cloud-portal-api-tab.markdown",
34+
"Name": "API Tab",
35+
"DiscussionId": "2c7b04b6-883f-471e-aae3-40a0a54ad66e",
36+
"Mappings": []
37+
},
3238
{
3339
"Path": "cloud-portal-support-tab.markdown",
3440
"Name": "Support Tab",

‎Documentation/5.1/Raven.Documentation.Pages/cloud/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,11 @@
4545
"Name": "Security",
4646
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
4747
"Mappings": []
48+
},
49+
{
50+
"Path": "cloud-api.markdown",
51+
"Name": "API",
52+
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
53+
"Mappings": []
4854
}
4955
]

‎Documentation/5.1/Raven.Documentation.Pages/cloud/portal/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@
2929
"DiscussionId": "62743f76-a49d-4b75-a0ca-fa1283729b65",
3030
"Mappings": []
3131
},
32+
{
33+
"Path": "cloud-portal-api-tab.markdown",
34+
"Name": "API Tab",
35+
"DiscussionId": "2c7b04b6-883f-471e-aae3-40a0a54ad66e",
36+
"Mappings": []
37+
},
3238
{
3339
"Path": "cloud-portal-support-tab.markdown",
3440
"Name": "Support Tab",

‎Documentation/5.2/Raven.Documentation.Pages/cloud/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,5 +51,11 @@
5151
"Name": "Settings",
5252
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
5353
"Mappings": []
54+
},
55+
{
56+
"Path": "cloud-api.markdown",
57+
"Name": "API",
58+
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
59+
"Mappings": []
5460
}
5561
]

‎Documentation/5.2/Raven.Documentation.Pages/cloud/portal/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@
2929
"DiscussionId": "62743f76-a49d-4b75-a0ca-fa1283729b65",
3030
"Mappings": []
3131
},
32+
{
33+
"Path": "cloud-portal-api-tab.markdown",
34+
"Name": "API Tab",
35+
"DiscussionId": "2c7b04b6-883f-471e-aae3-40a0a54ad66e",
36+
"Mappings": []
37+
},
3238
{
3339
"Path": "cloud-portal-support-tab.markdown",
3440
"Name": "Support Tab",

‎Documentation/5.3/Raven.Documentation.Pages/cloud/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,11 @@
4545
"Name": "Security",
4646
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
4747
"Mappings": []
48+
},
49+
{
50+
"Path": "cloud-api.markdown",
51+
"Name": "API",
52+
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
53+
"Mappings": []
4854
}
4955
]

‎Documentation/5.3/Raven.Documentation.Pages/cloud/portal/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@
2929
"DiscussionId": "62743f76-a49d-4b75-a0ca-fa1283729b65",
3030
"Mappings": []
3131
},
32+
{
33+
"Path": "cloud-portal-api-tab.markdown",
34+
"Name": "API Tab",
35+
"DiscussionId": "2c7b04b6-883f-471e-aae3-40a0a54ad66e",
36+
"Mappings": []
37+
},
3238
{
3339
"Path": "cloud-portal-support-tab.markdown",
3440
"Name": "Support Tab",

‎Documentation/5.4/Raven.Documentation.Pages/cloud/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,11 @@
4545
"Name": "Security",
4646
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
4747
"Mappings": []
48+
},
49+
{
50+
"Path": "cloud-api.markdown",
51+
"Name": "API",
52+
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
53+
"Mappings": []
4854
}
4955
]

‎Documentation/5.4/Raven.Documentation.Pages/cloud/portal/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@
2828
"Name": "Billing & Costs Tab",
2929
"DiscussionId": "62743f76-a49d-4b75-a0ca-fa1283729b65",
3030
"Mappings": []
31+
},
32+
{
33+
"Path": "cloud-portal-api-tab.markdown",
34+
"Name": "API Tab",
35+
"DiscussionId": "2c7b04b6-883f-471e-aae3-40a0a54ad66e",
36+
"Mappings": []
3137
},
3238
{
3339
"Path": "cloud-portal-support-tab.markdown",

‎Documentation/6.0/Raven.Documentation.Pages/cloud/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,5 +51,11 @@
5151
"Name": "Product Features",
5252
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
5353
"Mappings": []
54+
},
55+
{
56+
"Path": "cloud-api.markdown",
57+
"Name": "API",
58+
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
59+
"Mappings": []
5460
}
5561
]

‎Documentation/6.0/Raven.Documentation.Pages/cloud/portal/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@
2929
"DiscussionId": "62743f76-a49d-4b75-a0ca-fa1283729b65",
3030
"Mappings": []
3131
},
32+
{
33+
"Path": "cloud-portal-api-tab.markdown",
34+
"Name": "API Tab",
35+
"DiscussionId": "2c7b04b6-883f-471e-aae3-40a0a54ad66e",
36+
"Mappings": []
37+
},
3238
{
3339
"Path": "cloud-portal-support-tab.markdown",
3440
"Name": "Support Tab",

‎Documentation/6.2/Raven.Documentation.Pages/cloud/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,11 @@
4545
"Name": "Security",
4646
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
4747
"Mappings": []
48+
},
49+
{
50+
"Path": "cloud-api.markdown",
51+
"Name": "API",
52+
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
53+
"Mappings": []
4854
}
4955
]

‎Documentation/6.2/Raven.Documentation.Pages/cloud/portal/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@
2929
"DiscussionId": "62743f76-a49d-4b75-a0ca-fa1283729b65",
3030
"Mappings": []
3131
},
32+
{
33+
"Path": "cloud-portal-api-tab.markdown",
34+
"Name": "API Tab",
35+
"DiscussionId": "2c7b04b6-883f-471e-aae3-40a0a54ad66e",
36+
"Mappings": []
37+
},
3238
{
3339
"Path": "cloud-portal-support-tab.markdown",
3440
"Name": "Support Tab",

‎Documentation/7.0/Raven.Documentation.Pages/cloud/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,11 @@
4545
"Name": "Security",
4646
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
4747
"Mappings": []
48+
},
49+
{
50+
"Path": "cloud-api.markdown",
51+
"Name": "API",
52+
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
53+
"Mappings": []
4854
}
4955
]

‎Documentation/7.0/Raven.Documentation.Pages/cloud/portal/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@
2828
"Name": "Billing & Costs Tab",
2929
"DiscussionId": "62743f76-a49d-4b75-a0ca-fa1283729b65",
3030
"Mappings": []
31+
},
32+
{
33+
"Path": "cloud-portal-api-tab.markdown",
34+
"Name": "API Tab",
35+
"DiscussionId": "2c7b04b6-883f-471e-aae3-40a0a54ad66e",
36+
"Mappings": []
3137
},
3238
{
3339
"Path": "cloud-portal-support-tab.markdown",

‎Documentation/7.1/Raven.Documentation.Pages/cloud/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,11 @@
4545
"Name": "Security",
4646
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
4747
"Mappings": []
48+
},
49+
{
50+
"Path": "cloud-api.markdown",
51+
"Name": "API",
52+
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
53+
"Mappings": []
4854
}
4955
]

‎Documentation/7.1/Raven.Documentation.Pages/cloud/portal/.docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@
2929
"DiscussionId": "62743f76-a49d-4b75-a0ca-fa1283729b65",
3030
"Mappings": []
3131
},
32+
{
33+
"Path": "cloud-portal-api-tab.markdown",
34+
"Name": "API Tab",
35+
"DiscussionId": "2c7b04b6-883f-471e-aae3-40a0a54ad66e",
36+
"Mappings": []
37+
},
3238
{
3339
"Path": "cloud-portal-support-tab.markdown",
3440
"Name": "Support Tab",

0 commit comments

Comments
 (0)