Commit 7cd9be65 authored by Professor Chaos's avatar Professor Chaos

remove api_docs

parent 1c7fdbb8
# IltapetoApi.ArticlesApi
All URIs are relative to *https://iltapeto-221419.appspot.com/iltapeto/1.0.0*
Method | HTTP request | Description
------------- | ------------- | -------------
[**updateArticles**](ArticlesApi.md#updateArticles) | **GET** /articles/update | Update application article data
<a name="updateArticles"></a>
# **updateArticles**
> updateArticles(opts)
Update application article data
Updates application article dataset
### Example
```javascript
var IltapetoApi = require('iltapeto_api');
var apiInstance = new IltapetoApi.ArticlesApi();
var opts = {
'limit': 10 // Number | Max number of articles to return
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.updateArticles(opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **Number**| Max number of articles to return | [optional] [default to 10]
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
# IltapetoApi.PreferenceResult
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**articles** | [**[PreferredItem]**](PreferredItem.md) | array of articles sorted by estimated user preference |
# IltapetoApi.PreferredItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**articleId** | **String** | Article id |
**headline** | **String** | Article title |
**lead** | **String** | Article subtitle | [optional]
**image** | **String** | Article feature image | [optional]
**preferenceValue** | **Number** | Computed value for user preference, max &#x3D; 1.0 (highly likely user prefers article), mid &#x3D; 0.0 (preference unknown), min &#x3D; -1.0 (highly unlikely user preffers article) | [optional]
# IltapetoApi.UserId
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**userId** | **Number** | |
# IltapetoApi.UserPreferenceRecord
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**userId** | **Number** | Current user id |
**articleId** | **String** | Article Id |
**likeValue** | **Boolean** | set &#x60;true&#x60; to like; set &#x60;false&#x60; to dislike |
# IltapetoApi.UsersApi
All URIs are relative to *https://iltapeto-221419.appspot.com/iltapeto/1.0.0*
Method | HTTP request | Description
------------- | ------------- | -------------
[**addArticlePreference**](UsersApi.md#addArticlePreference) | **POST** /user/preference | Set article preference as liked or disliked
[**getNewUserId**](UsersApi.md#getNewUserId) | **GET** /user/create | Create new application user
[**getRecommendedArticles**](UsersApi.md#getRecommendedArticles) | **GET** /user/articles | Get list of latest articles sorted by user preference value
[**retrainUserModel**](UsersApi.md#retrainUserModel) | **POST** /user/retrain | Retrain user model
<a name="addArticlePreference"></a>
# **addArticlePreference**
> addArticlePreference(opts)
Set article preference as liked or disliked
Set article as liked or disliked by specific user
### Example
```javascript
var IltapetoApi = require('iltapeto_api');
var apiInstance = new IltapetoApi.UsersApi();
var opts = {
'articlePreferenceItem': new IltapetoApi.UserPreferenceRecord() // UserPreferenceRecord | Article being rated
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.addArticlePreference(opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**articlePreferenceItem** | [**UserPreferenceRecord**](UserPreferenceRecord.md)| Article being rated | [optional]
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="getNewUserId"></a>
# **getNewUserId**
> UserId getNewUserId()
Create new application user
Get id for new user
### Example
```javascript
var IltapetoApi = require('iltapeto_api');
var apiInstance = new IltapetoApi.UsersApi();
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getNewUserId(callback);
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**UserId**](UserId.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="getRecommendedArticles"></a>
# **getRecommendedArticles**
> PreferenceResult getRecommendedArticles(userId, opts)
Get list of latest articles sorted by user preference value
Get list of recommended articles for specific user
### Example
```javascript
var IltapetoApi = require('iltapeto_api');
var apiInstance = new IltapetoApi.UsersApi();
var userId = 789; // Number | Id of current user
var opts = {
'limit': 10 // Number | Max number of articles to return
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getRecommendedArticles(userId, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**userId** | **Number**| Id of current user |
**limit** | **Number**| Max number of articles to return | [optional] [default to 10]
### Return type
[**PreferenceResult**](PreferenceResult.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="retrainUserModel"></a>
# **retrainUserModel**
> retrainUserModel(userId)
Retrain user model
Request retraining user classification model
### Example
```javascript
var IltapetoApi = require('iltapeto_api');
var apiInstance = new IltapetoApi.UsersApi();
var userId = 789; // Number | Id of current user
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.retrainUserModel(userId, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**userId** | **Number**| Id of current user |
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment