mirror of
https://github.com/raindropio/developer-site.git
synced 2026-11-04 10:03:46 +00:00
GitBook: [#105] No subject
This commit is contained in:
Rustem Mussabekov authored and 
gitbook-bot committed
1 parent
7a3516b6c9
commit
ac1f757a8c
11 files changed
+702
-1173
No files matched your search
+1
-1
@@ -16,7 +16,7 @@
|
||||
* [Raindrops](v1/raindrops/README.md)
|
||||
* [Single raindrop](v1/raindrops/single.md)
|
||||
* [Multiple raindrops](v1/raindrops/multiple.md)
|
||||
* [Highlights](v1/raindrops/highlights.md)
|
||||
* [Highlights](v1/highlights.md)
|
||||
* [User](v1/user/README.md)
|
||||
* [Authenticated user](v1/user/authenticated.md)
|
||||
* [Tags](v1/tags.md)
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
# Terms & Guidelines
|
||||
|
||||
### How may I use the API? <a id="how-may-i-use-the-api"></a>
|
||||
### How may I use the API? <a href="#how-may-i-use-the-api" id="how-may-i-use-the-api"></a>
|
||||
|
||||
#### DO <a id="do"></a>
|
||||
#### DO <a href="#do" id="do"></a>
|
||||
|
||||
I encourage you to build applications that **extend** Raindrop.io to platforms beyond the web and offer services that Raindrop.io does not.
|
||||
|
||||
#### DON’T <a id="dont"></a>
|
||||
#### DON’T <a href="#dont" id="dont"></a>
|
||||
|
||||
Don’t build what I'm building. I invested a lot of time, money and hard work in Raindrop.io. I rely on Raindrop.io for income. As such, do not build an application, website, product, or business that attempts to harm, or replace Raindrop.io, website, or services.
|
||||
|
||||
@@ -16,26 +16,24 @@ In particular, do not use the API, or any Raindrop.io data, to build the followi
|
||||
|
||||
I'll do the best to communicate fair use of the Raindrop.io API in this space and others, but the onus is on you to contact me and inquire whether your use of the API is permitted.
|
||||
|
||||
### Commercial Use <a id="commercial-use"></a>
|
||||
### Commercial Use <a href="#commercial-use" id="commercial-use"></a>
|
||||
|
||||
You are free to use the Raindrop.io API for commercial use, provided that you abide by these terms and do not build an application or business that attempts to harm, compete with or replace Raindrop.io, our website, or our services.
|
||||
|
||||
### Be Gentle <a id="be-gentle"></a>
|
||||
### Be Gentle <a href="#be-gentle" id="be-gentle"></a>
|
||||
|
||||
Don’t overburden our servers. We’ve published some specifics with regard to rate limiting, but we reserve the right to determine abuse or excessive usage of the API and throttle or block any service accordingly. Attempts to circumvent rate limiting, such as leveraging multiple applications or generating bogus user accounts, are strictly prohibited.
|
||||
|
||||
### Termination <a id="termination"></a>
|
||||
### Termination <a href="#termination" id="termination"></a>
|
||||
|
||||
Raindrop.io can refuse API access at any time for any reason. This is not a card we hope to play often, but it’s impossible to anticipate every situation. We reserve the right to decline any request for API usage and block access to the API.
|
||||
|
||||
### Liability <a id="liability"></a>
|
||||
### Liability <a href="#liability" id="liability"></a>
|
||||
|
||||
Raindrop.io is not liable for any direct, indirect, incidental, special, consequential or exemplary damages arising from your use of the API. These include, but are not limited to, damages for loss of profits, goodwill, use, data or other intangible losses, resulting from your API usage or third-party products that access data via the API.
|
||||
|
||||
Your use of the Raindrop.io API is at your own discretion and risk, and you will be solely responsible for any damage that results its use, including, but not limited to, any damage to computer systems or loss of data incurred by you, your users, or your customers.
|
||||
|
||||
### Terms Can Change <a id="terms-can-change"></a>
|
||||
|
||||
Raindrop.io reserves the right to update and change these terms at any time without notice.
|
||||
|
||||
### Terms Can Change <a href="#terms-can-change" id="terms-can-change"></a>
|
||||
|
||||
Raindrop.io reserves the right to update and change these terms at any time without notice.\
|
||||
+84
-110
@@ -10,43 +10,34 @@ If you just want to test your application, or do not plan to access any data exc
|
||||
Just go to [App Management Console](https://app.raindrop.io/settings/integrations) and open your application settings. Copy **Test token** and use it as described in [**Make authorized calls**](calls.md)**.**
|
||||
{% endhint %}
|
||||
|
||||
{% api-method method="get" host="https://raindrop.io" path="/oauth/authorize" %}
|
||||
{% api-method-summary %}
|
||||
Step 1: The authorization request
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://raindrop.io" path="/oauth/authorize" method="get" summary="Step 1: The authorization request" %}
|
||||
{% swagger-description %}
|
||||
Direct the user to our authorization URL with specified request parameters.
|
||||
|
||||
\
|
||||
|
||||
|
||||
— If the user is not logged in, they will be asked to log in
|
||||
|
||||
\
|
||||
|
||||
|
||||
{% api-method-description %}
|
||||
Direct the user to our authorization URL with specified request parameters.
|
||||
— If the user is not logged in, they will be asked to log in
|
||||
— The user will be asked if he would like to grant your application access to his Raindrop.io data
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-query-parameters %}
|
||||
{% api-method-parameter name="redirect\_uri" type="string" required=true %}
|
||||
{% swagger-parameter in="query" name="redirect_uri" type="string" %}
|
||||
Redirect URL configured in your application setting
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="client\_id" type="string" required=true %}
|
||||
{% swagger-parameter in="query" name="client_id" type="string" %}
|
||||
The unique Client ID of the Raindrop.io app that you registered
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-query-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=307 %}
|
||||
{% api-method-response-example-description %}
|
||||
Check details in Step 2
|
||||
{% endapi-method-response-example-description %}
|
||||
|
||||
```text
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="307" description="Check details in Step 2" %}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
```
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
|
||||
|
||||
@@ -64,57 +55,57 @@ The `code` parameter contains the authorization code that you will use to exchan
|
||||
|
||||
In case of error redirect request will come with `error` query parameter:
|
||||
|
||||
| Error | Description |
|
||||
| :--- | :--- |
|
||||
| access\_denied | When the user denies your authorization request |
|
||||
| Error | Description |
|
||||
| ---------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| access\_denied | When the user denies your authorization request |
|
||||
| invalid\_application\_status | When your application exceeds the maximum token limit or when your application is being suspended due to abuse |
|
||||
|
||||
{% api-method method="post" host="https://raindrop.io" path="/oauth/access\_token" %}
|
||||
{% api-method-summary %}
|
||||
Step 3: The token exchange
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://raindrop.io" path="/oauth/access_token" method="post" summary="Step 3: The token exchange" %}
|
||||
{% swagger-description %}
|
||||
Once you have the authorization
|
||||
|
||||
{% api-method-description %}
|
||||
Once you have the authorization `code`, you can exchange it for the `access_token` by doing a `POST` request with all required body parameters as JSON:
|
||||
{% endapi-method-description %}
|
||||
`code`
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-headers %}
|
||||
{% api-method-parameter name="Content-Type" type="string" required=true %}
|
||||
, you can exchange it for the
|
||||
|
||||
`access_token`
|
||||
|
||||
by doing a
|
||||
|
||||
`POST`
|
||||
|
||||
request with all required body parameters as JSON:
|
||||
{% endswagger-description %}
|
||||
|
||||
{% swagger-parameter in="header" name="Content-Type" type="string" %}
|
||||
application/json
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-headers %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-body-parameters %}
|
||||
{% api-method-parameter name="grant\_type" type="string" required=true %}
|
||||
**authorization\_code**
|
||||
{% endapi-method-parameter %}
|
||||
{% swagger-parameter in="body" name="grant_type" type="string" %}
|
||||
**authorization_code**
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="code" type="string" required=true %}
|
||||
{% swagger-parameter in="body" name="code" type="string" %}
|
||||
Code that you received in step 2
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="client\_id" type="string" required=true %}
|
||||
{% swagger-parameter in="body" name="client_id" type="string" %}
|
||||
The unique Client ID of the Raindrop.io app that you registered
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="client\_secret" type="string" required=true %}
|
||||
{% swagger-parameter in="body" name="client_secret" type="string" %}
|
||||
Client secret
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="redirect\_uri" type="string" required=true %}
|
||||
Same `redirect_uri` from step 1
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-body-parameters %}
|
||||
{% endapi-method-request %}
|
||||
{% swagger-parameter in="body" name="redirect_uri" type="string" %}
|
||||
Same
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
`redirect_uri`
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
from step 1
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"access_token": "ae261404-11r4-47c0-bce3-e18a423da828",
|
||||
@@ -124,20 +115,14 @@ Same `redirect_uri` from step 1
|
||||
"token_type": "Bearer"
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
|
||||
{% api-method-response-example httpCode=400 %}
|
||||
{% api-method-response-example-description %}
|
||||
Occurs when `code` parameter is invalid
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-response %}
|
||||
|
||||
{% swagger-response status="400" description="Occurs when code parameter is invalid" %}
|
||||
```javascript
|
||||
{"error": "bad_authorization_code"}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
Here an example CURL request:
|
||||
|
||||
@@ -153,48 +138,40 @@ curl -X "POST" "https://raindrop.io/oauth/access_token" \
|
||||
}'
|
||||
```
|
||||
|
||||
{% api-method method="post" host="https://raindrop.io" path="/oauth/access\_token" %}
|
||||
{% api-method-summary %}
|
||||
♻️ The access token refresh
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://raindrop.io" path="/oauth/access_token" method="post" summary="♻️ The access token refresh" %}
|
||||
{% swagger-description %}
|
||||
For security reasons access tokens (except "test tokens") will
|
||||
|
||||
{% api-method-description %}
|
||||
For security reasons access tokens \(except "test tokens"\) will **expire after two weeks**. In this case you should request the new one, by calling `POST` request with body parameters \(JSON\):
|
||||
{% endapi-method-description %}
|
||||
**expire after two weeks**
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-headers %}
|
||||
{% api-method-parameter name="Content-Type" type="string" required=true %}
|
||||
. In this case you should request the new one, by calling
|
||||
|
||||
`POST`
|
||||
|
||||
request with body parameters (JSON):
|
||||
{% endswagger-description %}
|
||||
|
||||
{% swagger-parameter in="header" name="Content-Type" type="string" %}
|
||||
application/json
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-headers %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-body-parameters %}
|
||||
{% api-method-parameter name="client\_id" type="string" required=true %}
|
||||
{% swagger-parameter in="body" name="client_id" type="string" %}
|
||||
The unique Client ID of your app that you registered
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="client\_secret" type="string" required=true %}
|
||||
{% swagger-parameter in="body" name="client_secret" type="string" %}
|
||||
Client secret of your app
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="grant\_type" type="string" required=true %}
|
||||
**refresh\_token**
|
||||
{% endapi-method-parameter %}
|
||||
{% swagger-parameter in="body" name="grant_type" type="string" %}
|
||||
**refresh_token**
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="refresh\_token" type="string" required=true %}
|
||||
{% swagger-parameter in="body" name="refresh_token" type="string" %}
|
||||
Refresh token that you get in step 3
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-body-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"access_token": "ae261404-18r4-47c0-bce3-e18a423da898",
|
||||
@@ -204,8 +181,5 @@ Refresh token that you get in step 3
|
||||
"token_type": "Bearer"
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
@@ -4,30 +4,16 @@ In your app you could easily make icon/cover selector from more than 10 000 icon
|
||||
|
||||
|
||||
|
||||
{% api-method method="get" host="https://api.raindrop.io" path="/rest/v1/collections/covers/{text}" %}
|
||||
{% api-method-summary %}
|
||||
Search for cover
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collections/covers/{text}" method="get" summary="Search for cover" %}
|
||||
{% swagger-description %}
|
||||
Search for specific cover (icon)
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-description %}
|
||||
Search for specific cover \(icon\)
|
||||
{% endapi-method-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="text" type="string" required=false %}
|
||||
{% swagger-parameter in="path" name="text" type="string" %}
|
||||
For example "pokemon"
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"items": [
|
||||
@@ -52,35 +38,19 @@ For example "pokemon"
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="get" host="https://api.raindrop.io" path="/rest/v1/collections/covers" %}
|
||||
{% api-method-summary %}
|
||||
Featured covers
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collections/covers" method="get" summary="Featured covers" %}
|
||||
{% swagger-description %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% endapi-method-description %}
|
||||
{% swagger-parameter in="path" name="" type="string" %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="" type="string" required=false %}
|
||||
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"items": [
|
||||
@@ -103,8 +73,5 @@ Featured covers
|
||||
]
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
+186
-370
@@ -1,23 +1,11 @@
|
||||
# Collection methods
|
||||
|
||||
{% api-method method="get" host="https://api.raindrop.io" path="/rest/v1/collections" %}
|
||||
{% api-method-summary %}
|
||||
Get root collections
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collections" method="get" summary="Get root collections" %}
|
||||
{% swagger-description %}
|
||||
Returns JSON-encoded array containing all root collections
|
||||
{% endapi-method-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
@@ -50,29 +38,19 @@ Returns JSON-encoded array containing all root collections
|
||||
]
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="get" host="https://api.raindrop.io" path="/rest/v1/collections/childrens" %}
|
||||
{% api-method-summary %}
|
||||
Get child collections
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collections/childrens" method="get" summary="Get child collections" %}
|
||||
{% swagger-description %}
|
||||
Returns JSON-encoded array containing all nested collections (that have positive
|
||||
|
||||
{% api-method-description %}
|
||||
Returns JSON-encoded array containing all nested collections \(that have positive `parent.$id`\)
|
||||
{% endapi-method-description %}
|
||||
`parent.$id`
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
)
|
||||
{% endswagger-description %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
@@ -106,35 +84,19 @@ Returns JSON-encoded array containing all nested collections \(that have positiv
|
||||
]
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="get" host="https://api.raindrop.io" path="/rest/v1/collection/{id}" %}
|
||||
{% api-method-summary %}
|
||||
Get collection
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collection/{id}" method="get" summary="Get collection" %}
|
||||
{% swagger-description %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% endapi-method-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="id" type="number" required=true %}
|
||||
{% swagger-parameter in="path" name="id" type="number" %}
|
||||
Collection ID
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
@@ -168,55 +130,41 @@ Collection ID
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="post" host="https://api.raindrop.io" path="/rest/v1/collection" %}
|
||||
{% api-method-summary %}
|
||||
Create collection
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collection" method="post" summary="Create collection" %}
|
||||
{% swagger-description %}
|
||||
Create a new collection
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-body-parameters %}
|
||||
{% api-method-parameter name="view" type="string" required=false %}
|
||||
{% swagger-parameter in="body" name="view" type="string" %}
|
||||
More details in "Fields"
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="title" type="string" required=false %}
|
||||
{% swagger-parameter in="body" name="title" type="string" %}
|
||||
Name of the collection
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="sort" type="number" required=false %}
|
||||
The order of collection \(descending\). Defines the position of the collection among all the collections with the same `parent.$id`
|
||||
{% endapi-method-parameter %}
|
||||
{% swagger-parameter in="body" name="sort" type="number" %}
|
||||
The order of collection (descending). Defines the position of the collection among all the collections with the same
|
||||
|
||||
{% api-method-parameter name="public" type="boolean" required=false %}
|
||||
`parent.$id`
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-parameter in="body" name="public" type="boolean" %}
|
||||
Collection and raindrops that it contains will be accessible without authentication?
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="parent.$id" type="integer" required=false %}
|
||||
{% swagger-parameter in="body" name="parent.$id" type="integer" %}
|
||||
The ID of parent collection. Empty for root collections
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="cover" type="array" required=false %}
|
||||
{% swagger-parameter in="body" name="cover" type="array" %}
|
||||
Collection cover url
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-body-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
@@ -225,13 +173,9 @@ Collection cover url
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
|
||||
{% api-method-response-example httpCode=400 %}
|
||||
{% api-method-response-example-description %}
|
||||
Incorrect 'view' field value
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-response %}
|
||||
|
||||
{% swagger-response status="400" description="Incorrect 'view' field value" %}
|
||||
```javascript
|
||||
{
|
||||
"result": false,
|
||||
@@ -239,65 +183,49 @@ Incorrect 'view' field value
|
||||
"errorMessage": "Collection validation failed: view: `bla` is not a valid enum value for path `view`."
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="put" host="https://api.raindrop.io" path="/rest/v1/collection/{id}" %}
|
||||
{% api-method-summary %}
|
||||
Update collection
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collection/{id}" method="put" summary="Update collection" %}
|
||||
{% swagger-description %}
|
||||
Update an existing collection
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="id" type="number" required=true %}
|
||||
{% swagger-parameter in="path" name="id" type="number" %}
|
||||
Existing collection id
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-body-parameters %}
|
||||
{% api-method-parameter name="expanded" type="boolean" required=false %}
|
||||
Whether the collection\`s sub-collections are expanded
|
||||
{% endapi-method-parameter %}
|
||||
{% swagger-parameter in="body" name="expanded" type="boolean" %}
|
||||
Whether the collection`s sub-collections are expanded
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="view" type="string" required=false %}
|
||||
{% swagger-parameter in="body" name="view" type="string" %}
|
||||
More details in "Fields"
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="title" type="string" required=false %}
|
||||
{% swagger-parameter in="body" name="title" type="string" %}
|
||||
Name of the collection
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="sort" type="number" required=false %}
|
||||
The order of collection \(descending\). Defines the position of the collection among all the collections with the same `parent.$id`
|
||||
{% endapi-method-parameter %}
|
||||
{% swagger-parameter in="body" name="sort" type="number" %}
|
||||
The order of collection (descending). Defines the position of the collection among all the collections with the same
|
||||
|
||||
{% api-method-parameter name="public" type="boolean" required=false %}
|
||||
`parent.$id`
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-parameter in="body" name="public" type="boolean" %}
|
||||
Collection and raindrops that it contains will be accessible without authentication?
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="parent.$id" type="integer" required=false %}
|
||||
{% swagger-parameter in="body" name="parent.$id" type="integer" %}
|
||||
The ID of parent collection. Empty for root collections
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="cover" type="array" required=false %}
|
||||
{% swagger-parameter in="body" name="cover" type="array" %}
|
||||
Collection cover url
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-body-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
@@ -306,47 +234,27 @@ Collection cover url
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="put" host="https://api.raindrop.io" path="/rest/v1/collection/{id}/cover" %}
|
||||
{% api-method-summary %}
|
||||
Upload cover
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collection/{id}/cover" method="put" summary="Upload cover" %}
|
||||
{% swagger-description %}
|
||||
It's possible to upload cover from desktop. PNG, GIF and JPEG supported
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="id" type="string" required=true %}
|
||||
{% swagger-parameter in="path" name="id" type="string" %}
|
||||
Existing collection ID
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-headers %}
|
||||
{% api-method-parameter name="Content-Type" type="string" required=true %}
|
||||
{% swagger-parameter in="header" name="Content-Type" type="string" %}
|
||||
multipart/form-data
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-headers %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-form-data-parameters %}
|
||||
{% api-method-parameter name="cover" type="object" required=true %}
|
||||
{% swagger-parameter in="body" name="cover" type="object" %}
|
||||
File
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-form-data-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
@@ -355,263 +263,175 @@ File
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collection/{id}" method="delete" summary="Remove collection" %}
|
||||
{% swagger-description %}
|
||||
Remove an existing collection and all its descendants.
|
||||
|
||||
\
|
||||
|
||||
{% api-method method="delete" host="https://api.raindrop.io" path="/rest/v1/collection/{id}" %}
|
||||
{% api-method-summary %}
|
||||
Remove collection
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
Remove an existing collection and all its descendants.
|
||||
Raindrops will be moved to "Trash" collection
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="id" type="number" required=true %}
|
||||
{% swagger-parameter in="path" name="id" type="number" %}
|
||||
Existing collection ID
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="delete" host="https://api.raindrop.io" path="/rest/v1/collections" %}
|
||||
{% api-method-summary %}
|
||||
Remove multiple collections
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collections" method="delete" summary="Remove multiple collections" %}
|
||||
{% swagger-description %}
|
||||
Remove multiple collections at once.
|
||||
|
||||
{% api-method-description %}
|
||||
Remove multiple collections at once.
|
||||
Nested collections are ignored \(include ID's in `ids` array to remove them\)
|
||||
{% endapi-method-description %}
|
||||
\
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-body-parameters %}
|
||||
{% api-method-parameter name="ids" type="array" required=true %}
|
||||
|
||||
Nested collections are ignored (include ID's in
|
||||
|
||||
`ids`
|
||||
|
||||
array to remove them)
|
||||
{% endswagger-description %}
|
||||
|
||||
{% swagger-parameter in="body" name="ids" type="array" %}
|
||||
Array of collection ID
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-body-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```
|
||||
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="put" host="https://api.raindrop.io" path="/rest/v1/collections" %}
|
||||
{% api-method-summary %}
|
||||
Reorder all collections
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collections" method="put" summary="Reorder all collections" %}
|
||||
{% swagger-description %}
|
||||
Updates order of all collections
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% swagger-parameter in="body" name="sort" type="string" %}
|
||||
Change order of all collections.
|
||||
|
||||
\
|
||||
|
||||
|
||||
Possible values:
|
||||
|
||||
\
|
||||
|
||||
|
||||
"title" - sort alphabetically ascending
|
||||
|
||||
\
|
||||
|
||||
|
||||
"-title" - sort alphabetically descending
|
||||
|
||||
\
|
||||
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-body-parameters %}
|
||||
{% api-method-parameter name="sort" type="string" required=true %}
|
||||
Change order of all collections.
|
||||
Possible values:
|
||||
"title" - sort alphabetically ascending
|
||||
"-title" - sort alphabetically descending
|
||||
"-count" - sort by raindrops count descending
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-body-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="put" host="https://api.raindrop.io" path="/rest/v1/collections" %}
|
||||
{% api-method-summary %}
|
||||
Expand/collapse all collections
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collections" method="put" summary="Expand/collapse all collections" %}
|
||||
{% swagger-description %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% swagger-parameter in="path" name="expanded" type="boolean" %}
|
||||
TRUE = expand all
|
||||
|
||||
\
|
||||
|
||||
{% endapi-method-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="expanded" type="boolean" required=true %}
|
||||
TRUE = expand all
|
||||
FALSE = collapse all
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="put" host="https://api.raindrop.io" path="/rest/v1/collections/merge" %}
|
||||
{% api-method-summary %}
|
||||
Merge collections
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collections/merge" method="put" summary="Merge collections" %}
|
||||
{% swagger-description %}
|
||||
Merge multiple collections
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-body-parameters %}
|
||||
{% api-method-parameter name="to" type="number" required=false %}
|
||||
Collection ID where listed collection `ids` will be merged
|
||||
{% endapi-method-parameter %}
|
||||
{% swagger-parameter in="body" name="to" type="number" %}
|
||||
Collection ID where listed collection
|
||||
|
||||
{% api-method-parameter name="ids" type="array" required=false %}
|
||||
`ids`
|
||||
|
||||
will be merged
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-parameter in="body" name="ids" type="array" %}
|
||||
Collection ID's
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-body-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```
|
||||
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="put" host="https://api.raindrop.io" path="/rest/v1/collections/clean" %}
|
||||
{% api-method-summary %}
|
||||
Remove all empty collections
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collections/clean" method="put" summary="Remove all empty collections" %}
|
||||
{% swagger-description %}
|
||||
|
||||
{% api-method-description %}
|
||||
|
||||
{% endapi-method-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
"count": 3
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="delete" host="https://api.raindrop.io" path="/rest/v1/collection/-99" %}
|
||||
{% api-method-summary %}
|
||||
Empty Trash
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collection/-99" method="delete" summary="Empty Trash" %}
|
||||
{% swagger-description %}
|
||||
|
||||
{% api-method-description %}
|
||||
|
||||
{% endapi-method-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="get" host="https://api.raindrop.io" path="/rest/v1/user/stats" %}
|
||||
{% api-method-summary %}
|
||||
Get system collections count
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/user/stats" method="get" summary="Get system collections count" %}
|
||||
{% swagger-description %}
|
||||
|
||||
{% api-method-description %}
|
||||
|
||||
{% endapi-method-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"items": [
|
||||
@@ -642,10 +462,6 @@ Get system collections count
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
|
||||
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
+114
-223
@@ -11,81 +11,51 @@ description: >-
|
||||
|
||||
Every user who shares at least one collection with another user, has a collaborators record in the API response. The record contains a restricted subset of user-specific fields.
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="text-align:left">Field</th>
|
||||
<th style="text-align:left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="text-align:left">_id</td>
|
||||
<td style="text-align:left">User ID of the collaborator</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align:left">email</td>
|
||||
<td style="text-align:left">
|
||||
<p>Email of the collaborator</p>
|
||||
<p>Empty when authorized user have read-only access</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align:left">email_MD5</td>
|
||||
<td style="text-align:left">MD5 hash of collaborator email. Useful for using with Gravatar for example</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align:left">fullName</td>
|
||||
<td style="text-align:left">Full name of the collaborator</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align:left">role</td>
|
||||
<td style="text-align:left">
|
||||
<p>Access level:</p>
|
||||
<p><b><code>member</code></b> have write access and can invite more users</p>
|
||||
<p><b><code>viewer</code></b> read-only access</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
| Field | Description |
|
||||
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| \_id | User ID of the collaborator |
|
||||
| email | <p>Email of the collaborator</p><p>Empty when authorized user have read-only access</p> |
|
||||
| email\_MD5 | MD5 hash of collaborator email. Useful for using with Gravatar for example |
|
||||
| fullName | Full name of the collaborator |
|
||||
| role | <p>Access level:</p><p><strong><code>member</code></strong> have write access and can invite more users</p><p><strong><code>viewer</code></strong> read-only access</p> |
|
||||
|
||||
{% api-method method="post" host="https://api.raindrop.io" path="/rest/v1/collection/{id}/sharing" %}
|
||||
{% api-method-summary %}
|
||||
Share collection
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collection/{id}/sharing" method="post" summary="Share collection" %}
|
||||
{% swagger-description %}
|
||||
Share collection with another user(s). As result invitation(s) will be send to specified email(s) with link to join collection.
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-description %}
|
||||
Share collection with another user\(s\). As result invitation\(s\) will be send to specified email\(s\) with link to join collection.
|
||||
{% endapi-method-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="id" type="number" required=true %}
|
||||
{% swagger-parameter in="path" name="id" type="number" %}
|
||||
Existing collection ID
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-parameter in="body" name="role" type="string" %}
|
||||
Access level. Possible values:
|
||||
|
||||
\
|
||||
|
||||
|
||||
|
||||
|
||||
**`member`**
|
||||
|
||||
\
|
||||
|
||||
|
||||
|
||||
|
||||
{% api-method-body-parameters %}
|
||||
{% api-method-parameter name="role" type="string" required=true %}
|
||||
Access level. Possible values:
|
||||
**`member`**
|
||||
**`viewer`**
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-parameter in="body" name="emails" type="array" %}
|
||||
The user email(s) with whom to share the project.
|
||||
|
||||
\
|
||||
|
||||
|
||||
{% api-method-parameter name="emails" type="array" required=true %}
|
||||
The user email\(s\) with whom to share the project.
|
||||
Maximum 10
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-body-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
@@ -95,13 +65,9 @@ Maximum 10
|
||||
]
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
|
||||
{% api-method-response-example httpCode=400 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-response %}
|
||||
|
||||
{% swagger-response status="400" description="" %}
|
||||
```javascript
|
||||
//'emails' array is empty
|
||||
{
|
||||
@@ -115,13 +81,9 @@ Maximum 10
|
||||
"errorMessage": "you cant send more than 10 invites at once"
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
|
||||
{% api-method-response-example httpCode=403 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-response %}
|
||||
|
||||
{% swagger-response status="403" description="" %}
|
||||
```javascript
|
||||
//When user have more than 100 pending invitations:
|
||||
{
|
||||
@@ -135,35 +97,19 @@ Maximum 10
|
||||
"errorMessage": "you dont have permissions to invite more people"
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="get" host="https://api.raindrop.io" path="/rest/v1/collection/{id}/sharing" %}
|
||||
{% api-method-summary %}
|
||||
Get collaborators list of collection
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collection/{id}/sharing" method="get" summary="Get collaborators list of collection" %}
|
||||
{% swagger-description %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% endapi-method-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="id" type="number" required=true %}
|
||||
{% swagger-parameter in="path" name="id" type="number" %}
|
||||
Existing collection ID
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"items": [
|
||||
@@ -179,172 +125,120 @@ Existing collection ID
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="delete" host="https://api.raindrop.io" path="/rest/v1/collection/{id}/sharing" %}
|
||||
{% api-method-summary %}
|
||||
Unshare or leave collection
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collection/{id}/sharing" method="delete" summary="Unshare or leave collection" %}
|
||||
{% swagger-description %}
|
||||
There two possible results of calling this method, depends on who authenticated user is:
|
||||
|
||||
{% api-method-description %}
|
||||
There two possible results of calling this method, depends on who authenticated user is:
|
||||
- **Owner**: collection will be unshared and all collaborators will be removed
|
||||
- **Member or viewer**: authenticated user will be removed from collaborators list
|
||||
{% endapi-method-description %}
|
||||
\
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="id" type="number" required=true %}
|
||||
|
||||
\-
|
||||
|
||||
**Owner**
|
||||
|
||||
: collection will be unshared and all collaborators will be removed
|
||||
|
||||
\
|
||||
|
||||
|
||||
\-
|
||||
|
||||
**Member or viewer**
|
||||
|
||||
: authenticated user will be removed from collaborators list
|
||||
{% endswagger-description %}
|
||||
|
||||
{% swagger-parameter in="path" name="id" type="number" %}
|
||||
Existing collection ID
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="put" host="https://api.raindrop.io" path="/rest/v1/collection/{id}/sharing/{userId}" %}
|
||||
{% api-method-summary %}
|
||||
Change access level of collaborator
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collection/{id}/sharing/{userId}" method="put" summary="Change access level of collaborator" %}
|
||||
{% swagger-description %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% endapi-method-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="userId" type="number" required=false %}
|
||||
{% swagger-parameter in="path" name="userId" type="number" %}
|
||||
User ID of collaborator
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="id" type="number" required=true %}
|
||||
{% swagger-parameter in="path" name="id" type="number" %}
|
||||
Existing collection ID
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-body-parameters %}
|
||||
{% api-method-parameter name="role" type="string" required=true %}
|
||||
**`member`** or **`viewer`**
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-body-parameters %}
|
||||
{% endapi-method-request %}
|
||||
{% swagger-parameter in="body" name="role" type="string" %}
|
||||
**`member`**
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
or
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
**`viewer`**
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="delete" host="https://api.raindrop.io" path="/rest/v1/collection/{id}/sharing/{userId}" %}
|
||||
{% api-method-summary %}
|
||||
Delete a collaborator
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collection/{id}/sharing/{userId}" method="delete" summary="Delete a collaborator" %}
|
||||
{% swagger-description %}
|
||||
Remove an user from shared collection
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="userId" type="number" required=false %}
|
||||
{% swagger-parameter in="path" name="userId" type="number" %}
|
||||
User ID of collaborator
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="id" type="number" required=true %}
|
||||
{% swagger-parameter in="path" name="id" type="number" %}
|
||||
Existing collection ID
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="post" host="https://api.raindrop.io" path="/rest/v1/collection/{id}/join" %}
|
||||
{% api-method-summary %}
|
||||
Accept an invitation
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/collection/{id}/join" method="post" summary="Accept an invitation" %}
|
||||
{% swagger-description %}
|
||||
Accept an invitation to join a shared collection
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="id" type="number" required=true %}
|
||||
{% swagger-parameter in="path" name="id" type="number" %}
|
||||
Existing collection ID
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-body-parameters %}
|
||||
{% api-method-parameter name="token" type="string" required=true %}
|
||||
{% swagger-parameter in="body" name="token" type="string" %}
|
||||
Secret token from email
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-body-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
"role": "member"
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
|
||||
{% api-method-response-example httpCode=403 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-response %}
|
||||
|
||||
{% swagger-response status="403" description="" %}
|
||||
```javascript
|
||||
//Incorrect token
|
||||
{
|
||||
@@ -366,8 +260,5 @@ Secret token from email
|
||||
"errorMessage": "You already owner of this collection"
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
+48
-47
@@ -2,59 +2,63 @@
|
||||
|
||||
To help users easily find their content you can suggest context aware filters like we have in Raindrop.io app
|
||||
|
||||
|
||||
.png>)
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Description |
|
||||
| :--- | :--- | :--- |
|
||||
| broken | `Object` | |
|
||||
| broken.count | `Integer` | Broken links count |
|
||||
| duplicates | `Object` | |
|
||||
| duplicates.count | `Integer` | Duplicate links count |
|
||||
| important | `Object` | |
|
||||
| important.count | `Integer` | Count of raindrops that marked as "favorite" |
|
||||
| notag | `Object` | |
|
||||
| notag.count | `Integer` | Count of raindrops without any tag |
|
||||
| tags | `Array<Object>` | List of tags in format `{"_id": "tag name", "count": 1}` |
|
||||
| types | `Array<Object>` | List of types in format `{"_id": "type", "count": 1}` |
|
||||
| Field | Type | Description |
|
||||
| ---------------- | --------------- | -------------------------------------------------------- |
|
||||
| broken | `Object` | |
|
||||
| broken.count | `Integer` | Broken links count |
|
||||
| duplicates | `Object` | |
|
||||
| duplicates.count | `Integer` | Duplicate links count |
|
||||
| important | `Object` | |
|
||||
| important.count | `Integer` | Count of raindrops that marked as "favorite" |
|
||||
| notag | `Object` | |
|
||||
| notag.count | `Integer` | Count of raindrops without any tag |
|
||||
| tags | `Array<Object>` | List of tags in format `{"_id": "tag name", "count": 1}` |
|
||||
| types | `Array<Object>` | List of types in format `{"_id": "type", "count": 1}` |
|
||||
|
||||
{% api-method method="get" host="https://api.raindrop.io" path="/rest/v1/raindrops/{collectionId}/filters" %}
|
||||
{% api-method-summary %}
|
||||
Get filters
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/raindrops/{collectionId}/filters" method="get" summary="Get filters" %}
|
||||
{% swagger-description %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% endapi-method-description %}
|
||||
{% swagger-parameter in="path" name="collectionId" type="string" %}
|
||||
Collection ID.
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="collectionId" type="string" required=true %}
|
||||
Collection ID. `0` for all
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
`0`
|
||||
|
||||
{% api-method-query-parameters %}
|
||||
{% api-method-parameter name="tagsSort" type="string" required=false %}
|
||||
Sort tags by:
|
||||
**`-count`** by count, default
|
||||
**`_id`** by name
|
||||
{% endapi-method-parameter %}
|
||||
for all
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="search" type="string" required=false %}
|
||||
{% swagger-parameter in="query" name="tagsSort" type="string" %}
|
||||
Sort tags by:
|
||||
|
||||
\
|
||||
|
||||
|
||||
|
||||
|
||||
**`-count`**
|
||||
|
||||
by count, default
|
||||
|
||||
\
|
||||
|
||||
|
||||
|
||||
|
||||
**`_id`**
|
||||
|
||||
by name
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-parameter in="query" name="search" type="string" %}
|
||||
Check "raindrops" documentation for more details
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-query-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
@@ -100,8 +104,5 @@ Check "raindrops" documentation for more details
|
||||
]
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
@@ -1,6 +1,58 @@
|
||||
# Highlights
|
||||
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/raindrop/{id}" method="get" summary="Get highlights of existing raindrop" %}
|
||||
Single `highlight` object:
|
||||
|
||||
| Field | Type | Description |
|
||||
| ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| \_id | `String` | Unique id of highlight |
|
||||
| text | `String` | Text of highlight (required) |
|
||||
| color | `String` | <p>Color of highlight. <br>Default <code>yellow</code><br><br>Can be <code>blue</code>, <code>brown</code>, <code>cyan</code>, <code>gray</code>, <code>green</code>, <code>indigo</code>, <code>orange</code>, <code>pink</code>, <code>purple</code>, <code>red</code>, <code>teal</code>, <code>yellow</code></p> |
|
||||
| note | `String` | Optional note for highlight |
|
||||
| created | `String` | Creation date of highlight |
|
||||
|
||||
{% swagger method="get" path="/rest/v1/highlights" baseUrl="https://api.raindrop.io" summary="Get all highlights" %}
|
||||
{% swagger-description %}
|
||||
|
||||
{% endswagger-description %}
|
||||
|
||||
{% swagger-parameter in="query" name="page" type="Number" %}
|
||||
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-parameter in="query" name="perpage" type="Number" %}
|
||||
How many highlights per page. 50 max. Default 25
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200: OK" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
"items": [
|
||||
{
|
||||
"note": "Trully native macOS app",
|
||||
"color": "red",
|
||||
"text": "Orion is the new WebKit-based browser for Mac",
|
||||
"created": "2022-03-21T14:41:34.059Z",
|
||||
"tags": ["tag1", "tag2"],
|
||||
"_id": "62388e9e48b63606f41e44a6",
|
||||
"raindropRef": 123
|
||||
},
|
||||
{
|
||||
"note": "",
|
||||
"color": "green",
|
||||
"text": "Built on WebKit, Orion gives you a fast, smooth and lightweight browsing experience",
|
||||
"created": "2022-03-21T15:13:21.128Z",
|
||||
"tags": ["tag1", "tag2"],
|
||||
"_id": "62389611058af151c840f667",
|
||||
"raindropRef": 123
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/raindrop/{id}" method="get" summary="Get highlights of raindrop" %}
|
||||
{% swagger-description %}
|
||||
|
||||
{% endswagger-description %}
|
||||
@@ -39,7 +91,7 @@ Existing raindrop ID
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/raindrop/{id}" method="put" summary="Add highlight to existing raindrop" %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/raindrop/{id}" method="put" summary="Add highlight" %}
|
||||
{% swagger-description %}
|
||||
Just specify a `highlights` array in body with `object` for each highlight
|
||||
|
||||
@@ -98,7 +150,7 @@ Existing raindrop ID
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/raindrop/{id}" method="put" summary="Update highlight of existing raindrop" %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/raindrop/{id}" method="put" summary="Update highlight" %}
|
||||
{% swagger-description %}
|
||||
Just specify a `highlights` array in body with `object` containing particular `_id` of highlight you want to update and all other fields you want to change.
|
||||
|
||||
@@ -159,7 +211,7 @@ Should be empty string
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/raindrop/{id}" method="put" summary="Remove highlight from existing raindrop" %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/raindrop/{id}" method="put" summary="Remove highlight" %}
|
||||
{% swagger-description %}
|
||||
Just specify a `highlights` array in body with `object` containing particular `_id` of highlight you want to remove and empty string for `text` field.
|
||||
|
||||
+30
-77
@@ -4,30 +4,16 @@ description: Handy methods to implement import functionality
|
||||
|
||||
# Import
|
||||
|
||||
{% api-method method="get" host="https://api.raindrop.io" path="/rest/v1/import/url/parse" %}
|
||||
{% api-method-summary %}
|
||||
Parse URL
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/import/url/parse" method="get" summary="Parse URL" %}
|
||||
{% swagger-description %}
|
||||
Parse and extract useful info from any URL
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-query-parameters %}
|
||||
{% api-method-parameter name="url" type="string" required=true %}
|
||||
{% swagger-parameter in="query" name="url" type="string" %}
|
||||
URL
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-query-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
//Success
|
||||
{
|
||||
@@ -95,35 +81,19 @@ URL
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="post" host="https://api.raindrop.io" path="/rest/v1/import/url/exists" %}
|
||||
{% api-method-summary %}
|
||||
Check URL\(s\) existence
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/import/url/exists" method="post" summary="Check URL(s) existence " %}
|
||||
{% swagger-description %}
|
||||
Does specified URL's are already saved?
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-body-parameters %}
|
||||
{% api-method-parameter name="urls" type="array" required=true %}
|
||||
{% swagger-parameter in="body" name="urls" type="array" %}
|
||||
URL's
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-body-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
ids array contains ID of existing bookmarks
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="ids array contains ID of existing bookmarks" %}
|
||||
```javascript
|
||||
//Found
|
||||
{
|
||||
@@ -140,42 +110,28 @@ ids array contains ID of existing bookmarks
|
||||
"ids": []
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/import/file" method="post" summary="Parse HTML import file" %}
|
||||
{% swagger-description %}
|
||||
Convert HTML bookmark file to JSON.
|
||||
|
||||
\
|
||||
|
||||
{% api-method method="post" host="https://api.raindrop.io" path="/rest/v1/import/file" %}
|
||||
{% api-method-summary %}
|
||||
Parse HTML import file
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
Convert HTML bookmark file to JSON.
|
||||
Support Nestcape, Pocket and Instapaper file formats
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-headers %}
|
||||
{% api-method-parameter name="Content-Type" type="string" required=true %}
|
||||
{% swagger-parameter in="header" name="Content-Type" type="string" %}
|
||||
multipart/form-data
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-headers %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-form-data-parameters %}
|
||||
{% api-method-parameter name="import" type="string" required=true %}
|
||||
{% swagger-parameter in="body" name="import" type="string" %}
|
||||
File
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-form-data-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
@@ -229,8 +185,5 @@ File
|
||||
]
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
+65
-136
@@ -1,29 +1,15 @@
|
||||
# Tags
|
||||
|
||||
{% api-method method="get" host="https://api.raindrop.io" path="/rest/v1/tags/{collectionId}" %}
|
||||
{% api-method-summary %}
|
||||
Get tags
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/tags/{collectionId}" method="get" summary="Get tags" %}
|
||||
{% swagger-description %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% endapi-method-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="collectionId" type="number" required=false %}
|
||||
{% swagger-parameter in="path" name="collectionId" type="number" %}
|
||||
Optional collection ID, when not specified all tags from all collections will be retrieved
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
@@ -35,163 +21,109 @@ Optional collection ID, when not specified all tags from all collections will be
|
||||
]
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="put" host="https://api.raindrop.io" path="/rest/v1/tags/{collectionId}" %}
|
||||
{% api-method-summary %}
|
||||
Rename tag
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/tags/{collectionId}" method="put" summary="Rename tag" %}
|
||||
{% swagger-description %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% endapi-method-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="collectionId" type="number" required=false %}
|
||||
{% swagger-parameter in="path" name="collectionId" type="number" %}
|
||||
It's possible to restrict rename action to just one collection. It's optional
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-body-parameters %}
|
||||
{% api-method-parameter name="replace" type="string" required=true %}
|
||||
{% swagger-parameter in="body" name="replace" type="string" %}
|
||||
New name
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="tags" type="array" required=true %}
|
||||
Specify **array** with **only one** string \(name of a tag\)
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-body-parameters %}
|
||||
{% endapi-method-request %}
|
||||
{% swagger-parameter in="body" name="tags" type="array" %}
|
||||
Specify
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
**array**
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
with
|
||||
|
||||
**only one**
|
||||
|
||||
string (name of a tag)
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="put" host="https://api.raindrop.io" path="/rest/v1/tags/{collectionId}" %}
|
||||
{% api-method-summary %}
|
||||
Merge tags
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/tags/{collectionId}" method="put" summary="Merge tags" %}
|
||||
{% swagger-description %}
|
||||
Basically this action rename bunch of
|
||||
|
||||
{% api-method-description %}
|
||||
Basically this action rename bunch of `tags` to new name \(`replace` field\)
|
||||
{% endapi-method-description %}
|
||||
`tags`
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="collectionId" type="string" required=false %}
|
||||
to new name (
|
||||
|
||||
`replace`
|
||||
|
||||
field)
|
||||
{% endswagger-description %}
|
||||
|
||||
{% swagger-parameter in="path" name="collectionId" type="string" %}
|
||||
It's possible to restrict merge action to just one collection. It's optional
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-body-parameters %}
|
||||
{% api-method-parameter name="replace" type="string" required=true %}
|
||||
{% swagger-parameter in="body" name="replace" type="string" %}
|
||||
New name
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="tags" type="array" required=true %}
|
||||
{% swagger-parameter in="body" name="tags" type="array" %}
|
||||
List of tags
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-body-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="delete" host="https://api.raindrop.io" path="/rest/v1/tags/{collectionId}" %}
|
||||
{% api-method-summary %}
|
||||
Remove tag\(s\)
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/tags/{collectionId}" method="delete" summary="Remove tag(s)" %}
|
||||
{% swagger-description %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% endapi-method-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="collectionId" type="string" required=false %}
|
||||
{% swagger-parameter in="path" name="collectionId" type="string" %}
|
||||
It's possible to restrict remove action to just one collection. It's optional
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-body-parameters %}
|
||||
{% api-method-parameter name="tags" type="array" required=true %}
|
||||
{% swagger-parameter in="body" name="tags" type="array" %}
|
||||
List of tags
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-body-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="get" host="https://api.raindrop.io" path="/rest/v1/tags/suggest/{raindropId}" %}
|
||||
{% api-method-summary %}
|
||||
Suggest tags
|
||||
{% endapi-method-summary %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/tags/suggest/{raindropId}" method="get" summary="Suggest tags" %}
|
||||
{% swagger-description %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% endapi-method-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="raindropId" type="number" required=true %}
|
||||
{% swagger-parameter in="path" name="raindropId" type="number" %}
|
||||
Raindrop ID
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
@@ -201,8 +133,5 @@ Raindrop ID
|
||||
]
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
+92
-144
@@ -1,23 +1,11 @@
|
||||
# Authenticated user
|
||||
|
||||
{% api-method method="get" host="https://api.raindrop.io" path="/rest/v1/user" %}
|
||||
{% api-method-summary %}
|
||||
Get user
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/user" method="get" summary="Get user" %}
|
||||
{% swagger-description %}
|
||||
Get currently authenticated user details
|
||||
{% endapi-method-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
@@ -65,45 +53,25 @@ Get currently authenticated user details
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
|
||||
{% api-method-response-example httpCode=401 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-response %}
|
||||
|
||||
{% swagger-response status="401" description="" %}
|
||||
```http
|
||||
Unauthorized
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="get" host="https://api.raindrop.io" path="/rest/v1/user/{id}" %}
|
||||
{% api-method-summary %}
|
||||
Get user by ID
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/user/{id}" method="get" summary="Get user by ID" %}
|
||||
{% swagger-description %}
|
||||
Get's publicly available user details
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="id" type="number" required=true %}
|
||||
{% swagger-parameter in="path" name="id" type="number" %}
|
||||
User ID
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
@@ -116,13 +84,9 @@ User ID
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
|
||||
{% api-method-response-example httpCode=404 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-response %}
|
||||
|
||||
{% swagger-response status="404" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"error": -1,
|
||||
@@ -130,55 +94,39 @@ User ID
|
||||
"result": false
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="put" host="https://api.raindrop.io" path="/rest/v1/user" %}
|
||||
{% api-method-summary %}
|
||||
Update user
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/user" method="put" summary="Update user" %}
|
||||
{% swagger-description %}
|
||||
To change email, config, password, etc... you can do it from single endpoint
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-body-parameters %}
|
||||
{% api-method-parameter name="groups" type="array" required=false %}
|
||||
{% swagger-parameter in="body" name="groups" type="array" %}
|
||||
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="config" type="object" required=false %}
|
||||
{% swagger-parameter in="body" name="config" type="object" %}
|
||||
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="newpassword" type="string" required=false %}
|
||||
{% swagger-parameter in="body" name="newpassword" type="string" %}
|
||||
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="oldpassword" type="string" required=false %}
|
||||
{% swagger-parameter in="body" name="oldpassword" type="string" %}
|
||||
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="fullName" type="string" required=false %}
|
||||
{% swagger-parameter in="body" name="fullName" type="string" %}
|
||||
|
||||
{% endapi-method-parameter %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% api-method-parameter name="email" type="string" required=false %}
|
||||
{% swagger-parameter in="body" name="email" type="string" %}
|
||||
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-body-parameters %}
|
||||
{% endapi-method-request %}
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```javascript
|
||||
{
|
||||
"result": true,
|
||||
@@ -187,13 +135,9 @@ To change email, config, password, etc... you can do it from single endpoint
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
|
||||
{% api-method-response-example httpCode=400 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
{% endswagger-response %}
|
||||
|
||||
{% swagger-response status="400" description="" %}
|
||||
```javascript
|
||||
//email specified but empty
|
||||
{
|
||||
@@ -223,72 +167,76 @@ To change email, config, password, etc... you can do it from single endpoint
|
||||
"errorMessage": "User validation failed: config.raindrops_sort: `1` is not a valid enum value for path `raindrops_sort`., config: Validation failed: raindrops_sort: `1` is not a valid enum value for path `raindrops_sort`."
|
||||
}
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="get" host="https://api.raindrop.io" path="/rest/v1/user/connect/{provider}" %}
|
||||
{% api-method-summary %}
|
||||
Connect social network account
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/user/connect/{provider}" method="get" summary="Connect social network account" %}
|
||||
{% swagger-description %}
|
||||
Connect social network account as sign in authentication option
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="provider" type="string" required=false %}
|
||||
`facebook` `google` `twitter` `vkontakte` `dropbox` or `gdrive`
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endapi-method-request %}
|
||||
{% swagger-parameter in="path" name="provider" type="string" %}
|
||||
`facebook`
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=307 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
`google`
|
||||
|
||||
|
||||
|
||||
`twitter`
|
||||
|
||||
|
||||
|
||||
`vkontakte`
|
||||
|
||||
|
||||
|
||||
`dropbox`
|
||||
|
||||
or
|
||||
|
||||
`gdrive`
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="307" description="" %}
|
||||
```http
|
||||
Location: https://some.com/...
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
|
||||
{% api-method method="get" host="https://api.raindrop.io" path="/rest/v1/user/connect/{provider}/revoke" %}
|
||||
{% api-method-summary %}
|
||||
Disconnect social network account
|
||||
{% endapi-method-summary %}
|
||||
|
||||
{% api-method-description %}
|
||||
{% swagger baseUrl="https://api.raindrop.io" path="/rest/v1/user/connect/{provider}/revoke" method="get" summary="Disconnect social network account" %}
|
||||
{% swagger-description %}
|
||||
Disconnect social network account from available authentication options
|
||||
{% endapi-method-description %}
|
||||
{% endswagger-description %}
|
||||
|
||||
{% api-method-spec %}
|
||||
{% api-method-request %}
|
||||
{% api-method-path-parameters %}
|
||||
{% api-method-parameter name="provider" type="string" required=false %}
|
||||
`facebook` `google` `twitter` `vkontakte` `dropbox` or `gdrive`
|
||||
{% endapi-method-parameter %}
|
||||
{% endapi-method-path-parameters %}
|
||||
{% endapi-method-request %}
|
||||
{% swagger-parameter in="path" name="provider" type="string" %}
|
||||
`facebook`
|
||||
|
||||
{% api-method-response %}
|
||||
{% api-method-response-example httpCode=200 %}
|
||||
{% api-method-response-example-description %}
|
||||
|
||||
|
||||
{% endapi-method-response-example-description %}
|
||||
`google`
|
||||
|
||||
|
||||
|
||||
`twitter`
|
||||
|
||||
|
||||
|
||||
`vkontakte`
|
||||
|
||||
|
||||
|
||||
`dropbox`
|
||||
|
||||
or
|
||||
|
||||
`gdrive`
|
||||
{% endswagger-parameter %}
|
||||
|
||||
{% swagger-response status="200" description="" %}
|
||||
```
|
||||
|
||||
```
|
||||
{% endapi-method-response-example %}
|
||||
{% endapi-method-response %}
|
||||
{% endapi-method-spec %}
|
||||
{% endapi-method %}
|
||||
|
||||
{% endswagger-response %}
|
||||
{% endswagger %}
|
||||
Reference in new issue
Block a user