Skip to content

Commit 7579d2c

Browse files
Rustem Mussabekovgitbook-bot
authored andcommitted
GITBOOK-124: change request with no subject merged in GitBook
1 parent 91bb5a3 commit 7579d2c

File tree

3 files changed

+62
-30
lines changed

3 files changed

+62
-30
lines changed

SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
* [Tags](v1/tags.md)
2323
* [Filters](v1/filters.md)
2424
* [Import](v1/import.md)
25+
* [Export](v1/export.md)
2526
* [Backups](v1/backups.md)
2627

2728
## More

v1/export.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
description: Export all raindrops in specific format
3+
---
4+
5+
# Export
6+
7+
## Export in format
8+
9+
<mark style="color:green;">`GET`</mark> `https://api.raindrop.io/rest/v1/raindrops/{collectionId}/export.{format}`
10+
11+
**Path Parameters**
12+
13+
<table><thead><tr><th width="243">Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>collectionId</code><mark style="color:red;">*</mark></td><td>number</td><td>Collection ID. Specify <code>0</code> to get all raindrops</td></tr><tr><td><code>format</code><mark style="color:red;">*</mark></td><td>string</td><td><code>csv</code>, <code>html</code> or <code>zip</code></td></tr></tbody></table>
14+
15+
**Query Parameters**
16+
17+
<table><thead><tr><th width="243">Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>sort</code></td><td>string</td><td>Check <a href="https://developer.raindrop.io/v1/raindrops/multiple">https://developer.raindrop.io/v1/raindrops/multiple</a></td></tr><tr><td><code>search</code></td><td>string</td><td>Check <a href="https://developer.raindrop.io/v1/raindrops/multiple">https://developer.raindrop.io/v1/raindrops/multiple</a></td></tr></tbody></table>

v1/import.md

Lines changed: 44 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,20 @@ description: Handy methods to implement import functionality
44

55
# Import
66

7-
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/import/url/parse" method="get" summary="Parse URL" %}
8-
{% swagger-description %}
7+
## Parse URL
8+
9+
<mark style="color:blue;">`GET`</mark> `https://api.raindrop.io/rest/v1/import/url/parse`
10+
911
Parse and extract useful info from any URL
10-
{% endswagger-description %}
1112

12-
{% swagger-parameter in="query" name="url" type="string" %}
13-
URL
14-
{% endswagger-parameter %}
13+
#### Query Parameters
14+
15+
| Name | Type | Description |
16+
| ---- | ------ | ----------- |
17+
| url | string | URL |
1518

16-
{% swagger-response status="200" description="" %}
19+
{% tabs %}
20+
{% tab title="200 " %}
1721
```javascript
1822
//Success
1923
{
@@ -81,19 +85,23 @@ URL
8185
"result": true
8286
}
8387
```
84-
{% endswagger-response %}
85-
{% endswagger %}
88+
{% endtab %}
89+
{% endtabs %}
90+
91+
## Check URL(s) existence&#x20;
92+
93+
<mark style="color:green;">`POST`</mark> `https://api.raindrop.io/rest/v1/import/url/exists`
8694

87-
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/import/url/exists" method="post" summary="Check URL(s) existence " %}
88-
{% swagger-description %}
8995
Does specified URL's are already saved?
90-
{% endswagger-description %}
9196

92-
{% swagger-parameter in="body" name="urls" type="array" %}
93-
URL's
94-
{% endswagger-parameter %}
97+
#### Request Body
9598

96-
{% swagger-response status="200" description="ids array contains ID of existing bookmarks" %}
99+
| Name | Type | Description |
100+
| ---- | ----- | ----------- |
101+
| urls | array | URL's |
102+
103+
{% tabs %}
104+
{% tab title="200 ids array contains ID of existing bookmarks" %}
97105
```javascript
98106
//Found
99107
{
@@ -110,24 +118,30 @@ URL's
110118
"ids": []
111119
}
112120
```
113-
{% endswagger-response %}
114-
{% endswagger %}
121+
{% endtab %}
122+
{% endtabs %}
123+
124+
## Parse HTML import file
125+
126+
<mark style="color:green;">`POST`</mark> `https://api.raindrop.io/rest/v1/import/file`
115127

116-
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/import/file" method="post" summary="Parse HTML import file" %}
117-
{% swagger-description %}
118128
Convert HTML bookmark file to JSON. \
119129
Support Nestcape, Pocket and Instapaper file formats
120-
{% endswagger-description %}
121130

122-
{% swagger-parameter in="header" name="Content-Type" type="string" %}
123-
multipart/form-data
124-
{% endswagger-parameter %}
131+
#### Headers
132+
133+
| Name | Type | Description |
134+
| ------------ | ------ | ------------------- |
135+
| Content-Type | string | multipart/form-data |
136+
137+
#### Request Body
125138

126-
{% swagger-parameter in="body" name="import" type="string" %}
127-
File
128-
{% endswagger-parameter %}
139+
| Name | Type | Description |
140+
| ------ | ------ | ----------- |
141+
| import | string | File |
129142

130-
{% swagger-response status="200" description="" %}
143+
{% tabs %}
144+
{% tab title="200 " %}
131145
```javascript
132146
{
133147
"result": true,
@@ -181,5 +195,5 @@ File
181195
]
182196
}
183197
```
184-
{% endswagger-response %}
185-
{% endswagger %}
198+
{% endtab %}
199+
{% endtabs %}

0 commit comments

Comments
 (0)