RESTful APIs

Less than 1 minute

RESTful APIs

RESTful APIs provided by the Gorse server are listed in this section. For more detailed information, please browse the interactive API document at:

http://<server_node_IP>:<server_node_port>/apidocs.

Authorization

By default, there is no authorization required for RESTful APIs. Authorization can be enabled by set api_key in the config file. The API key is passed through X-API-Key header.

curl -H "X-API-Key: *****"  http://127.0.0.1:8087/api/recommend/bob?n=10

Tips

The API key is defined in the configuration file:

[server]

# Secret key for RESTful APIs (SSL required).
api_key = ""

Users API

POST /api/user

Insert a user.

Request Body

{
  "Comment": "insect",
  "Labels": [
    "crocodilia",
    "cetacean",
    "horse"
  ],
  "Subscribe": [
    "fish",
    "dog",
    "lion"
  ],
  "UserId": "cat"
}

Response Body

{
  "RowAffected": 1
}

GET /api/user/{user-id}

Get a user.

Parameters

Name	Locate	Type	Description	Required
`user-id`	path	string	ID of the user to get	✅

Response Body

{
  "Comment": "insect",
  "Labels": [
    "crocodilia",
    "cetacean",
    "horse"
  ],
  "Subscribe": [
    "fish",
    "dog",
    "lion"
  ],
  "UserId": "cat"
}

DELETE /api/user/{user-id}

Delete a user and his or her feedback.

Parameters

Name	Locate	Type	Description	Required
`user-id`	path	string	ID of the user to delete	✅

Response Body

{
  "RowAffected": 1
}

PATCH /api/user/{user-id}

Modify a user.

Parameters

Name	Locate	Type	Description	Required
`user-id`	path	string	ID of the user to modify	✅

Request Body

{
  "Comment": "cow",
  "Labels": [
    "dog",
    "lion",
    "fish"
  ],
  "Subscribe": [
    "horse",
    "fish",
    "cat"
  ]
}

Response Body

{
  "RowAffected": 1
}

GET /api/users

Get users.

Parameters

Name	Locate	Type	Description	Required
`n`	query	integer	Number of returned users
`cursor`	query	string	Cursor for the next page

Response Body

{
  "Cursor": "cat",
  "Users": [
    {
      "Comment": "insect",
      "Labels": [
        "crocodilia",
        "cetacean",
        "horse"
      ],
      "Subscribe": [
        "fish",
        "dog",
        "lion"
      ],
      "UserId": "cat"
    },
    {
      "Comment": "insect",
      "Labels": [
        "crocodilia",
        "cetacean",
        "horse"
      ],
      "Subscribe": [
        "fish",
        "dog",
        "lion"
      ],
      "UserId": "cat"
    },
    {
      "Comment": "insect",
      "Labels": [
        "crocodilia",
        "cetacean",
        "horse"
      ],
      "Subscribe": [
        "fish",
        "dog",
        "lion"
      ],
      "UserId": "cat"
    }
  ]
}

POST /api/users

Insert users.

Request Body

[
  {
    "Comment": "insect",
    "Labels": [
      "crocodilia",
      "cetacean",
      "horse"
    ],
    "Subscribe": [
      "fish",
      "dog",
      "lion"
    ],
    "UserId": "cat"
  },
  {
    "Comment": "insect",
    "Labels": [
      "crocodilia",
      "cetacean",
      "horse"
    ],
    "Subscribe": [
      "fish",
      "dog",
      "lion"
    ],
    "UserId": "cat"
  },
  {
    "Comment": "insect",
    "Labels": [
      "crocodilia",
      "cetacean",
      "horse"
    ],
    "Subscribe": [
      "fish",
      "dog",
      "lion"
    ],
    "UserId": "cat"
  }
]

Response Body

{
  "RowAffected": 1
}

Items API

POST /api/item

Insert an item. Overwrite if the item exists.

Request Body

{
  "Categories": [
    "cetacean",
    "cow",
    "cow"
  ],
  "Comment": "lion",
  "IsHidden": false,
  "ItemId": "cetacean",
  "Labels": [
    "bear",
    "rabbit",
    "dog"
  ],
  "Timestamp": "2020-02-02T20:20:02.02Z"
}

Response Body

{
  "RowAffected": 1
}

GET /api/item/{item-id}

Get a item.

Parameters

Name	Locate	Type	Description	Required
`item-id`	path	string	ID of the item to get.	✅

Response Body

{
  "Categories": [
    "cetacean",
    "cow",
    "cow"
  ],
  "Comment": "lion",
  "IsHidden": false,
  "ItemId": "cetacean",
  "Labels": [
    "bear",
    "rabbit",
    "dog"
  ],
  "Timestamp": "2020-02-02T20:20:02.02Z"
}

DELETE /api/item/{item-id}

Delete an item and its feedback.

Parameters

Name	Locate	Type	Description	Required
`item-id`	path	string	ID of the item to delete	✅

Response Body

{
  "RowAffected": 1
}

PATCH /api/item/{item-id}

Modify an item.

Parameters

Name	Locate	Type	Description	Required
`item-id`	path	string	ID of the item to modify	✅

Request Body

{
  "Categories": [
    "horse",
    "bear",
    "lion"
  ],
  "Comment": "insect",
  "IsHidden": false,
  "Labels": [
    "fish",
    "fish",
    "insect"
  ],
  "Timestamp": "2020-02-02T20:20:02.02Z"
}

Response Body

{
  "RowAffected": 1
}

PUT /api/item/{item-id}/category/{category}

Insert a category for a item.

Parameters

Name	Locate	Type	Description	Required
`item-id`	path	string	ID of the item to insert category	✅
`category`	path	string	Category to insert	✅

Response Body

{
  "RowAffected": 1
}

DELETE /api/item/{item-id}/category/{category}

Delete a category from a item.

Parameters

Name	Locate	Type	Description	Required
`item-id`	path	string	ID of the item to delete categoryßßß	✅
`category`	path	string	Category to delete	✅

Response Body

{
  "RowAffected": 1
}

GET /api/items

Get items.

Parameters

Name	Locate	Type	Description	Required
`n`	query	integer	Number of returned items
`cursor`	query	string	Cursor for the next page

Response Body

{
  "Cursor": "fish",
  "Items": [
    {
      "Categories": [
        "cetacean",
        "cow",
        "cow"
      ],
      "Comment": "lion",
      "IsHidden": false,
      "ItemId": "cetacean",
      "Labels": [
        "bear",
        "rabbit",
        "dog"
      ],
      "Timestamp": "2020-02-02T20:20:02.02Z"
    },
    {
      "Categories": [
        "cetacean",
        "cow",
        "cow"
      ],
      "Comment": "lion",
      "IsHidden": false,
      "ItemId": "cetacean",
      "Labels": [
        "bear",
        "rabbit",
        "dog"
      ],
      "Timestamp": "2020-02-02T20:20:02.02Z"
    },
    {
      "Categories": [
        "cetacean",
        "cow",
        "cow"
      ],
      "Comment": "lion",
      "IsHidden": false,
      "ItemId": "cetacean",
      "Labels": [
        "bear",
        "rabbit",
        "dog"
      ],
      "Timestamp": "2020-02-02T20:20:02.02Z"
    }
  ]
}

POST /api/items

Insert items. Overwrite if items exist

Request Body

[
  {
    "Categories": [
      "cetacean",
      "cow",
      "cow"
    ],
    "Comment": "lion",
    "IsHidden": false,
    "ItemId": "cetacean",
    "Labels": [
      "bear",
      "rabbit",
      "dog"
    ],
    "Timestamp": "2020-02-02T20:20:02.02Z"
  },
  {
    "Categories": [
      "cetacean",
      "cow",
      "cow"
    ],
    "Comment": "lion",
    "IsHidden": false,
    "ItemId": "cetacean",
    "Labels": [
      "bear",
      "rabbit",
      "dog"
    ],
    "Timestamp": "2020-02-02T20:20:02.02Z"
  },
  {
    "Categories": [
      "cetacean",
      "cow",
      "cow"
    ],
    "Comment": "lion",
    "IsHidden": false,
    "ItemId": "cetacean",
    "Labels": [
      "bear",
      "rabbit",
      "dog"
    ],
    "Timestamp": "2020-02-02T20:20:02.02Z"
  }
]

Response Body

{
  "RowAffected": 1
}

Feedback API

GET /api/feedback

Get feedbacks.

Parameters

Name	Locate	Type	Description	Required
`cursor`	query	string	Cursor for the next page
`n`	query	integer	Number of returned feedback

Response Body

{
  "Cursor": "fish",
  "Feedback": [
    {
      "Comment": "crocodilia",
      "FeedbackType": "bird",
      "ItemId": "fish",
      "Timestamp": "2020-02-02T20:20:02.02Z",
      "UserId": "crocodilia"
    },
    {
      "Comment": "crocodilia",
      "FeedbackType": "bird",
      "ItemId": "fish",
      "Timestamp": "2020-02-02T20:20:02.02Z",
      "UserId": "crocodilia"
    },
    {
      "Comment": "crocodilia",
      "FeedbackType": "bird",
      "ItemId": "fish",
      "Timestamp": "2020-02-02T20:20:02.02Z",
      "UserId": "crocodilia"
    }
  ]
}

PUT /api/feedback

Insert feedbacks. Existed feedback will be overwritten.

Request Body

[
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  }
]

Response Body

{
  "RowAffected": 1
}

POST /api/feedback

Insert feedbacks. Ignore insertion if feedback exists.

Request Body

[
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  }
]

Response Body

{
  "RowAffected": 1
}

GET /api/feedback/{feedback-type}

Get feedbacks with feedback type.

Parameters

Name	Locate	Type	Description	Required
`feedback-type`	path	string	Type of returned feedbacks	✅
`cursor`	query	string	Cursor for the next page
`n`	query	integer	Number of returned feedbacks

Response Body

{
  "Cursor": "fish",
  "Feedback": [
    {
      "Comment": "crocodilia",
      "FeedbackType": "bird",
      "ItemId": "fish",
      "Timestamp": "2020-02-02T20:20:02.02Z",
      "UserId": "crocodilia"
    },
    {
      "Comment": "crocodilia",
      "FeedbackType": "bird",
      "ItemId": "fish",
      "Timestamp": "2020-02-02T20:20:02.02Z",
      "UserId": "crocodilia"
    },
    {
      "Comment": "crocodilia",
      "FeedbackType": "bird",
      "ItemId": "fish",
      "Timestamp": "2020-02-02T20:20:02.02Z",
      "UserId": "crocodilia"
    }
  ]
}

GET /api/feedback/{feedback-type}/{user-id}/{item-id}

Get feedbacks between a user and a item with feedback type.

Parameters

Name	Locate	Type	Description	Required
`feedback-type`	path	string	Type of returned feedbacks	✅
`user-id`	path	string	User ID of returned feedbacks	✅
`item-id`	path	string	Item ID of returned feedbacks	✅

Response Body

{
  "Comment": "crocodilia",
  "FeedbackType": "bird",
  "ItemId": "fish",
  "Timestamp": "2020-02-02T20:20:02.02Z",
  "UserId": "crocodilia"
}

DELETE /api/feedback/{feedback-type}/{user-id}/{item-id}

Delete feedbacks between a user and a item with feedback type.

Parameters

Name	Locate	Type	Description	Required
`feedback-type`	path	string	Type of returned feedbacks	✅
`user-id`	path	string	User ID of returned feedbacks	✅
`item-id`	path	string	Item ID of returned feedbacks	✅

Response Body

{
  "Comment": "crocodilia",
  "FeedbackType": "bird",
  "ItemId": "fish",
  "Timestamp": "2020-02-02T20:20:02.02Z",
  "UserId": "crocodilia"
}

GET /api/feedback/{user-id}/{item-id}

Get feedbacks between a user and a item.

Parameters

Name	Locate	Type	Description	Required
`user-id`	path	string	User ID of returned feedbacks	✅
`item-id`	path	string	Item ID of returned feedbacks	✅

Response Body

[
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  }
]

DELETE /api/feedback/{user-id}/{item-id}

Delete feedbacks between a user and a item.

Parameters

Name	Locate	Type	Description	Required
`user-id`	path	string	User ID of returned feedbacks	✅
`item-id`	path	string	Item ID of returned feedbacks	✅

Response Body

[
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  }
]

GET /api/item/{item-id}/feedback

Get feedbacks by item id.

Parameters

Name	Locate	Type	Description	Required
`item-id`	path	string	Item ID of returned feedbacks	✅

Response Body

[
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  }
]

GET /api/item/{item-id}/feedback/{feedback-type}

Get feedbacks by item id with feedback type.

Parameters

Name	Locate	Type	Description	Required
`item-id`	path	string	Item ID of returned feedbacks	✅
`feedback-type`	path	string	Type of returned feedbacks	✅

Response Body

[
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  }
]

GET /api/user/{user-id}/feedback

Get feedbacks by user id.

Parameters

Name	Locate	Type	Description	Required
`user-id`	path	string	User ID of returned feedbacks	✅

Response Body

[
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  }
]

GET /api/user/{user-id}/feedback/{feedback-type}

Get feedbacks by user id with feedback type.

Parameters

Name	Locate	Type	Description	Required
`user-id`	path	string	User ID of returned feedbacks	✅
`feedback-type`	path	string	Type of returned feedbacks	✅

Response Body

[
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  },
  {
    "Comment": "crocodilia",
    "FeedbackType": "bird",
    "ItemId": "fish",
    "Timestamp": "2020-02-02T20:20:02.02Z",
    "UserId": "crocodilia"
  }
]

Recommendation API

GET /api/item/{item-id}/neighbors

get neighbors of a item

Parameters

Name	Locate	Type	Description	Required
`item-id`	path	string	ID of the item to get neighbors	✅
`n`	query	integer	Number of returned items
`offset`	query	integer	Offset of returned items

Response Body

[
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  }
]

GET /api/item/{item-id}/neighbors/{category}

Get neighbors of a item in category.

Parameters

Name	Locate	Type	Description	Required
`item-id`	path	string	ID of the item to get neighbors	✅
`category`	path	string	Category of returned items	✅
`n`	query	integer	Number of returned items
`offset`	query	integer	Offset of returned items

Response Body

[
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  }
]

GET /api/latest

Get the latest items.

Parameters

Name	Locate	Type	Description
`n`	query	integer	Number of returned items
`offset`	query	integer	Offset of returned items
`user-id`	query	string	Remove read items of a user

Response Body

[
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  }
]

GET /api/latest/{category}

Get the latest items in category.

Parameters

Name	Locate	Type	Description	Required
`category`	path	string	Category of returned items.	✅
`n`	query	integer	Number of returned items
`offset`	query	integer	Offset of returned items
`user-id`	query	string	Remove read items of a user

Response Body

[
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  }
]

GET /api/popular

Get popular items.

Parameters

Name	Locate	Type	Description
`n`	query	integer	Number of returned recommendations
`offset`	query	integer	Offset of returned recommendations
`user-id`	query	string	Remove read items of a user

Response Body

[
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  }
]

GET /api/popular/{category}

Get popular items in category.

Parameters

Name	Locate	Type	Description	Required
`category`	path	string	Category of returned items.	✅
`n`	query	integer	Number of returned items
`offset`	query	integer	Offset of returned items
`user-id`	query	string	Remove read items of a user

Response Body

[
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  }
]

GET /api/recommend/{user-id}

Get recommendation for user.

Parameters

Name	Locate	Type	Description	Required
`user-id`	path	string	ID of the user to get recommendation	✅
`write-back-type`	query	string	Type of write back feedback
`write-back-delay`	query	string	Timestamp delay of write back feedback (format 0h0m0s)
`n`	query	integer	Number of returned items
`offset`	query	integer	Offset of returned items

Response Body

[
  "bird",
  "cow",
  "crocodilia"
]

GET /api/recommend/{user-id}/{category}

Get recommendation for user.

Parameters

Name	Locate	Type	Description	Required
`user-id`	path	string	ID of the user to get recommendation	✅
`category`	path	string	Category of the returned items	✅
`write-back-type`	query	string	Type of write back feedback
`write-back-delay`	query	string	Timestamp delay of write back feedback (format 0h0m0s)
`n`	query	integer	Number of returned items
`offset`	query	integer	Offset of returned items

Response Body

[
  "cat",
  "insect",
  "horse"
]

POST /api/session/recommend

Get recommendation for session.

Parameters

Name	Locate	Type	Description	Required
`n`	query	integer	Number of returned items
`offset`	query	integer	Offset of returned items

Request Body

[
  {
    "Comment": "rabbit",
    "FeedbackType": "rabbit",
    "ItemId": "horse",
    "Timestamp": "insect",
    "UserId": "fish"
  },
  {
    "Comment": "rabbit",
    "FeedbackType": "rabbit",
    "ItemId": "horse",
    "Timestamp": "insect",
    "UserId": "fish"
  },
  {
    "Comment": "rabbit",
    "FeedbackType": "rabbit",
    "ItemId": "horse",
    "Timestamp": "insect",
    "UserId": "fish"
  }
]

Response Body

[
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  }
]

POST /api/session/recommend/{category}

Get recommendation for session.

Parameters

Name	Locate	Type	Description	Required
`category`	path	string	Category of the returned items	✅
`n`	query	integer	Number of returned items
`offset`	query	integer	Offset of returned items

Request Body

[
  {
    "Comment": "rabbit",
    "FeedbackType": "rabbit",
    "ItemId": "horse",
    "Timestamp": "insect",
    "UserId": "fish"
  },
  {
    "Comment": "rabbit",
    "FeedbackType": "rabbit",
    "ItemId": "horse",
    "Timestamp": "insect",
    "UserId": "fish"
  },
  {
    "Comment": "rabbit",
    "FeedbackType": "rabbit",
    "ItemId": "horse",
    "Timestamp": "insect",
    "UserId": "fish"
  }
]

Response Body

[
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  }
]

GET /api/user/{user-id}/neighbors

Get neighbors of a user.

Parameters

Name	Locate	Type	Description	Required
`user-id`	path	string	ID of the user to get neighbors	✅
`n`	query	integer	Number of returned users
`offset`	query	integer	Offset of returned users

Response Body

[
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  },
  {
    "Id": "crocodilia",
    "Score": 3.1415926
  }
]

Health API

GET /api/health/live

Probe the liveness of this node. Return OK once the server starts.

Response Body

{
  "CacheStoreConnected": false,
  "CacheStoreError": "Nothing's Gonna Stop Us Now",
  "DataStoreConnected": false,
  "DataStoreError": "I Fall to Pieces",
  "Ready": false
}

GET /api/health/ready

Probe the readiness of this node. Return OK if the server is able to handle requests.

Response Body

{
  "CacheStoreConnected": false,
  "CacheStoreError": "Nothing's Gonna Stop Us Now",
  "DataStoreConnected": false,
  "DataStoreError": "I Fall to Pieces",
  "Ready": false
}

RESTful APIs

# RESTful APIs

# Authorization

# Users API

# Request Body

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Request Body

# Response Body

# Parameters

# Response Body

# Request Body

# Response Body

# Items API

# Request Body

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Request Body

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Request Body

# Response Body

# Feedback API

# Parameters

# Response Body

# Request Body

# Response Body

# Request Body

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Recommendation API

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Response Body

# Parameters

# Request Body

# Response Body

RESTful APIs

Authorization

Users API

Request Body

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Request Body

Response Body

Parameters

Response Body

Request Body

Response Body

Items API

Request Body

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Request Body

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Response Body

Request Body

Response Body

Feedback API

Parameters

Response Body

Request Body

Response Body

Request Body

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Response Body

Recommendation API

Parameters

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Response Body

Parameters

Request Body

Response Body

Parameters