docsapiprod.libreto.space
Open in
urlscan Pro
104.21.15.212
Public Scan
URL:
https://docsapiprod.libreto.space/
Submission: On March 21 via api from US — Scanned from US
Submission: On March 21 via api from US — Scanned from US
Form analysis 0 forms found in the DOM
Text Content
* API Summary
* API Methods - Default
* authRegister
* authSignIn
* dislikePost
* friendsAdd
* friendsList
* friendsRemove
* getCountry
* getFeedByOthers
* getMyFeed
* getMyProfile
* getPostById
* getProfile
* likstPost
* listCountries
* patchMyProfile
* ping
* submitPost
* updatePassword
PULSE API
API AND SDK DOCUMENTATION
Version: 1.0
--------------------------------------------------------------------------------
No description provided (generated by Swagger Codegen
https://github.com/swagger-api/swagger-codegen)
DEFAULT
AUTHREGISTER
Регистрация нового пользователя
Используется для регистрации нового пользователя по логину и паролю.
/auth/register
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost:8080/api/auth/register"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
Auth_register_body body = ; // Auth_register_body | Данные для регистрации пользователя.
try {
inline_response_201 result = apiInstance.authRegister(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#authRegister");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
Auth_register_body body = ; // Auth_register_body | Данные для регистрации пользователя.
try {
inline_response_201 result = apiInstance.authRegister(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#authRegister");
e.printStackTrace();
}
}
}
Auth_register_body *body = ; // Данные для регистрации пользователя.
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Регистрация нового пользователя
[apiInstance authRegisterWith:body
completionHandler: ^(inline_response_201 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var api = new PulseApi.DefaultApi()
var body = ; // {{Auth_register_body}} Данные для регистрации пользователя.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.authRegister(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class authRegisterExample
{
public void main()
{
var apiInstance = new DefaultApi();
var body = new Auth_register_body(); // Auth_register_body | Данные для регистрации пользователя.
try
{
// Регистрация нового пользователя
inline_response_201 result = apiInstance.authRegister(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.authRegister: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // Auth_register_body | Данные для регистрации пользователя.
try {
$result = $api_instance->authRegister($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->authRegister: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::Auth_register_body->new(); # Auth_register_body | Данные для регистрации пользователя.
eval {
my $result = $api_instance->authRegister(body => $body);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->authRegister: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
body = # Auth_register_body | Данные для регистрации пользователя.
try:
# Регистрация нового пользователя
api_response = api_instance.auth_register(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->authRegister: %s\n" % e)
PARAMETERS
Body parameters
Name Description body *
{
Required: countryCode,email,isPublic,login,password
login:
string maxLength:30
Логин пользователя
Pattern: [a-zA-Z0-9-]+
example: yellowMonkey
email:
string minLength:1 maxLength:50
E-mail пользователя
example: yellowstone1980@you.ru
password:
string minLength:6 maxLength:100
Пароль пользователя, к которому предъявляются следующие требования:
* Длина пароля не менее 6 символов.
* Присутствуют латинские символы в нижнем и верхнем регистре.
* Присутствует минимум одна цифра.
example: $aba4821FWfew01#.fewA$
countryCode:
string maxLength:2
Двухбуквенный код, уникально идентифицирующий страну
Pattern: [a-zA-Z]{2}
example: RU
isPublic:
boolean
Является ли данный профиль публичным.
Публичные профили доступны другим пользователям: если профиль публичный, любой
пользователь платформы сможет получить информацию о пользователе.
example: true
phone:
string maxLength:20
Номер телефона пользователя в формате +123456789
Pattern: \+[\d]+
example: +74951239922
image:
string minLength:1 maxLength:200
Ссылка на фото для аватара пользователя
example: https://http.cat/images/100.jpg
}
RESPONSES
STATUS: 201 - В СЛУЧАЕ УСПЕХА ВОЗВРАЩАЕТСЯ ПРОФИЛЬ ЗАРЕГИСТРИРОВАННОГО
ПОЛЬЗОВАТЕЛЯ
* Schema
{
Required: profile
profile:
{
Информация о профиле пользователя
Required: countryCode,email,isPublic,login
login:
string maxLength:30
Логин пользователя
Pattern: [a-zA-Z0-9-]+
example: yellowMonkey
email:
string minLength:1 maxLength:50
E-mail пользователя
example: yellowstone1980@you.ru
countryCode:
string maxLength:2
Двухбуквенный код, уникально идентифицирующий страну
Pattern: [a-zA-Z]{2}
example: RU
isPublic:
boolean
Является ли данный профиль публичным.
Публичные профили доступны другим пользователям: если профиль публичный, любой
пользователь платформы сможет получить информацию о пользователе.
example: true
phone:
string maxLength:20
Номер телефона пользователя в формате +123456789
Pattern: \+[\d]+
example: +74951239922
image:
string minLength:1 maxLength:200
Ссылка на фото для аватара пользователя
example: https://http.cat/images/100.jpg
}
}
STATUS: 400 - РЕГИСТРАЦИОННЫЕ ДАННЫЕ НЕ СООТВЕТСТВУЮТ ОЖИДАЕМОМУ ФОРМАТУ И
ТРЕБОВАНИЯМ. НАПРИМЕР, ДАННУЮ ОШИБКУ НЕОБХОДИМО ВОЗВРАЩАТЬ В СЛЕДУЮЩИХ СИТУАЦИЯХ
(ЭТО НЕ ПОЛНЫЙ СПИСОК): - НЕДОСТАТОЧНО "НАДЕЖНЫЙ" ПАРОЛЬ. - СТРАНА С УКАЗАННЫМ
КОДОМ НЕ НАЙДЕНА. - ДЛИНА ССЫЛКИ НА АВАТАР ПОЛЬЗОВАТЕЛЯ ПРЕВЫШАЕТ ДОПУСТИМЫЙ
ЛИМИТ. ДЛЯ ОЗНАКОМЛЕНИЯ С ФОРМАТОМ И ТРЕБОВАНИЯМИ К РЕГИСТРАЦИОННЫМ ДАННЫМ
ОБРАТИТЕ ВНИМАНИЕ НА ОПИСАНИЕ МОДЕЛЕЙ В OPEN API СПЕЦИФИКАЦИИ.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
STATUS: 409 - НАРУШЕНО ТРЕБОВАНИЕ НА УНИКАЛЬНОСТЬ АВТОРИЗАЦИОННЫХ ДАННЫХ
ПОЛЬЗОВАТЕЛЕЙ. ДАННЫЙ КОД ОТВЕТА ДОЛЖЕН ИСПОЛЬЗОВАТЬСЯ, ЕСЛИ ПОЛЬЗОВАТЕЛЬ С
ТАКИМ E-MAIL, НОМЕРОМ ТЕЛЕФОНА ИЛИ ЛОГИНОМ УЖЕ ЗАРЕГИСТРИРОВАН.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
AUTHSIGNIN
Аутентификация для получения токена
Процедура аутентификации по логину и паролю позволяет получить токен, который в
дальнейшем будет использоваться пользователем для выполнения операций, требующих
авторизацию.
Сервер должен генерировать уникальные токены, имеющие время жизни (на усмотрение
разработчика, от 1 до 24 часов). После истечения времени действия токен должен
быть недействительным и не может использоваться для аутентификации.
Токен является уникальным строковым значением с высокой энтропией (злоумышленник
не сможет его "подобрать" перебором). При каждой новой аутентификации
генерируется новый уникальный токен, который ранее не был использован. Можно
использовать JWT.
В дальнейшем полученный токен будет использоваться для авторизации
пользовательских запросов. Значение токена будет подставляться в заголовок
Authorization в формате Bearer {token}. Следовательно, сервер должен уметь
идентифицировать пользователя по токену.
/auth/sign-in
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost:8080/api/auth/sign-in"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
Auth_signin_body body = ; // Auth_signin_body | Данные для аутентификации пользователя.
try {
inline_response_200 result = apiInstance.authSignIn(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#authSignIn");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
Auth_signin_body body = ; // Auth_signin_body | Данные для аутентификации пользователя.
try {
inline_response_200 result = apiInstance.authSignIn(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#authSignIn");
e.printStackTrace();
}
}
}
Auth_signin_body *body = ; // Данные для аутентификации пользователя.
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Аутентификация для получения токена
[apiInstance authSignInWith:body
completionHandler: ^(inline_response_200 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var api = new PulseApi.DefaultApi()
var body = ; // {{Auth_signin_body}} Данные для аутентификации пользователя.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.authSignIn(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class authSignInExample
{
public void main()
{
var apiInstance = new DefaultApi();
var body = new Auth_signin_body(); // Auth_signin_body | Данные для аутентификации пользователя.
try
{
// Аутентификация для получения токена
inline_response_200 result = apiInstance.authSignIn(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.authSignIn: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // Auth_signin_body | Данные для аутентификации пользователя.
try {
$result = $api_instance->authSignIn($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->authSignIn: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::Auth_signin_body->new(); # Auth_signin_body | Данные для аутентификации пользователя.
eval {
my $result = $api_instance->authSignIn(body => $body);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->authSignIn: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
body = # Auth_signin_body | Данные для аутентификации пользователя.
try:
# Аутентификация для получения токена
api_response = api_instance.auth_sign_in(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->authSignIn: %s\n" % e)
PARAMETERS
Body parameters
Name Description body *
{
Required: login,password
login:
string maxLength:30
Логин пользователя
Pattern: [a-zA-Z0-9-]+
example: yellowMonkey
password:
string minLength:6 maxLength:100
Пароль пользователя, к которому предъявляются следующие требования:
* Длина пароля не менее 6 символов.
* Присутствуют латинские символы в нижнем и верхнем регистре.
* Присутствует минимум одна цифра.
example: $aba4821FWfew01#.fewA$
}
RESPONSES
STATUS: 200 - УСПЕШНАЯ АУТЕНТИФИКАЦИЯ
* Schema
{
Required: token
token:
string minLength:20
Сгенерированный токен пользователя
example:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
}
STATUS: 401 - ПОЛЬЗОВАТЕЛЬ С УКАЗАННЫМ ЛОГИНОМ И ПАРОЛЕМ НЕ НАЙДЕН
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
DISLIKEPOST
Дизлайк поста
Дизлайк поста.
Сервер должен идентифицировать пользователя по переданному токену. Значение
токена будет подставляться в заголовок Authorization в формате Bearer {token}.
/posts/{postId}/dislike
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X POST\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"http://localhost:8080/api/posts/{postId}/dislike"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
DefaultApi apiInstance = new DefaultApi();
postId postId = ; // postId | ID публикации.
try {
post result = apiInstance.dislikePost(postId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#dislikePost");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
postId postId = ; // postId | ID публикации.
try {
post result = apiInstance.dislikePost(postId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#dislikePost");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
postId *postId = ; // ID публикации.
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Дизлайк поста
[apiInstance dislikePostWith:postId
completionHandler: ^(post output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var defaultClient = PulseApi.ApiClient.instance;
var api = new PulseApi.DefaultApi()
var postId = ; // {{postId}} ID публикации.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.dislikePost(postId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class dislikePostExample
{
public void main()
{
var apiInstance = new DefaultApi();
var postId = new postId(); // postId | ID публикации.
try
{
// Дизлайк поста
post result = apiInstance.dislikePost(postId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.dislikePost: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$postId = ; // postId | ID публикации.
try {
$result = $api_instance->dislikePost($postId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->dislikePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $postId = ; # postId | ID публикации.
eval {
my $result = $api_instance->dislikePost(postId => $postId);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->dislikePost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
postId = # postId | ID публикации.
try:
# Дизлайк поста
api_response = api_instance.dislike_post(postId)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->dislikePost: %s\n" % e)
PARAMETERS
Path parameters
Name Description postId*
postId
ID публикации.
Required
RESPONSES
STATUS: 200 - РЕАКЦИЯ ЗАСЧИТАНА, ВОЗВРАЩАЙТЕ ПУБИКАЦИЮ С АКТУАЛЬНЫМ ЧИСЛОМ
ЛАЙКОВ И ДИЗЛАЙКОВ.
* Schema
{
Пользовательская публикация.
Required: author,content,createdAt,dislikesCount,id,likesCount,tags
id:
string maxLength:100
Уникальный идентификатор публикации, присвоенный сервером.
example: 550e8400-e29b-41d4-a716-446655440000
content:
string maxLength:1000
Текст публикации.
example: Свеча на 400! Покупаем, докупаем и фиксируем прибыль.
author:
string maxLength:30
Логин пользователя
Pattern: [a-zA-Z0-9-]+
example: yellowMonkey
tags:
[
Список тегов публикации.
string maxLength:20
Значение тега.
example: тинькофф
]
example: тинькофф,спббиржа,moex
createdAt:
string
Серверная дата и время в момент, когда пользователь отправил данную публикацию.
Передается в формате RFC3339.
example: 2006-01-02T15:04:05Z07:00
likesCount:
integer
Число лайков, набранное публикацией.
dislikesCount:
integer
Число дизлайков, набранное публикацией.
}
STATUS: 401 - ПЕРЕДАННЫЙ ТОКЕН НЕ СУЩЕСТВУЕТ ЛИБО НЕКОРРЕКТЕН.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
STATUS: 404 - УКАЗАННЫЙ ПОСТ НЕ НАЙДЕН ЛИБО К НЕМУ НЕТ ДОСТУПА.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
FRIENDSADD
Добавить пользователя в друзья
Позволяет добавить другого пользователя к себе в друзья.
Если указанный пользователь уже добавлен в друзья, верните успешный ответ. Если
пользователь добавляет в друзья самого себя, верните успешный ответ (добавлять в
друзья при этом не нужно).
Сервер должен идентифицировать пользователя по переданному токену. Значение
токена будет подставляться в заголовок Authorization в формате Bearer {token}.
/friends/add
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X POST\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost:8080/api/friends/add"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
DefaultApi apiInstance = new DefaultApi();
Friends_add_body body = ; // Friends_add_body | В теле запроса передается логин пользователя.
try {
inline_response_200_1 result = apiInstance.friendsAdd(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#friendsAdd");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
Friends_add_body body = ; // Friends_add_body | В теле запроса передается логин пользователя.
try {
inline_response_200_1 result = apiInstance.friendsAdd(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#friendsAdd");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
Friends_add_body *body = ; // В теле запроса передается логин пользователя.
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Добавить пользователя в друзья
[apiInstance friendsAddWith:body
completionHandler: ^(inline_response_200_1 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var defaultClient = PulseApi.ApiClient.instance;
var api = new PulseApi.DefaultApi()
var body = ; // {{Friends_add_body}} В теле запроса передается логин пользователя.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.friendsAdd(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class friendsAddExample
{
public void main()
{
var apiInstance = new DefaultApi();
var body = new Friends_add_body(); // Friends_add_body | В теле запроса передается логин пользователя.
try
{
// Добавить пользователя в друзья
inline_response_200_1 result = apiInstance.friendsAdd(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.friendsAdd: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // Friends_add_body | В теле запроса передается логин пользователя.
try {
$result = $api_instance->friendsAdd($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->friendsAdd: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::Friends_add_body->new(); # Friends_add_body | В теле запроса передается логин пользователя.
eval {
my $result = $api_instance->friendsAdd(body => $body);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->friendsAdd: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
body = # Friends_add_body | В теле запроса передается логин пользователя.
try:
# Добавить пользователя в друзья
api_response = api_instance.friends_add(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->friendsAdd: %s\n" % e)
PARAMETERS
Body parameters
Name Description body *
{
Required: login
login:
string maxLength:30
Логин пользователя
Pattern: [a-zA-Z0-9-]+
example: yellowMonkey
}
RESPONSES
STATUS: 200 - ОПЕРАЦИЯ ЗАВЕРШИЛАСЬ УСПЕШНО.
* Schema
{
Required: status
status:
string
Должно принимать значение ok.
example: ok
}
STATUS: 401 - ПЕРЕДАННЫЙ ТОКЕН НЕ СУЩЕСТВУЕТ ЛИБО НЕКОРРЕКТЕН.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
STATUS: 404 - ПОЛЬЗОВАТЕЛЬ С УКАЗАННЫМ ЛОГИНОМ НЕ НАЙДЕН.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
FRIENDSLIST
Получение списка друзей
Используется для получения списка своих друзей (пользователей, кого инициатор
запроса добавил в друзья).
Для плавной работы приложения используется пагинация.
Сервер должен идентифицировать пользователя по переданному токену. Значение
токена будет подставляться в заголовок Authorization в формате Bearer {token}.
/friends
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X GET\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"http://localhost:8080/api/friends?limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
DefaultApi apiInstance = new DefaultApi();
Integer limit = 56; // Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
Integer offset = 56; // Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
try {
array[inline_response_200_2] result = apiInstance.friendsList(limit, offset);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#friendsList");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
Integer limit = 56; // Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
Integer offset = 56; // Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
try {
array[inline_response_200_2] result = apiInstance.friendsList(limit, offset);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#friendsList");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *limit = 56; // Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
(optional) (default to 5)
Integer *offset = 56; // Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
(optional) (default to 0)
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Получение списка друзей
[apiInstance friendsListWith:limit
offset:offset
completionHandler: ^(array[inline_response_200_2] output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var defaultClient = PulseApi.ApiClient.instance;
var api = new PulseApi.DefaultApi()
var opts = {
'limit': 56, // {{Integer}} Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
'offset': 56 // {{Integer}} Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.friendsList(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class friendsListExample
{
public void main()
{
var apiInstance = new DefaultApi();
var limit = 56; // Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
(optional) (default to 5)
var offset = 56; // Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
(optional) (default to 0)
try
{
// Получение списка друзей
array[inline_response_200_2] result = apiInstance.friendsList(limit, offset);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.friendsList: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$limit = 56; // Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
$offset = 56; // Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
try {
$result = $api_instance->friendsList($limit, $offset);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->friendsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $limit = 56; # Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
my $offset = 56; # Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
eval {
my $result = $api_instance->friendsList(limit => $limit, offset => $offset);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->friendsList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
limit = 56 # Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
(optional) (default to 5)
offset = 56 # Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
(optional) (default to 0)
try:
# Получение списка друзей
api_response = api_instance.friends_list(limit=limit, offset=offset)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->friendsList: %s\n" % e)
PARAMETERS
Query parameters
Name Description limit
Integer (int32)
Максимальное число возвращаемых объектов. Используется для запросов с
пагинацией. Сервер должен возвращать максимальное допустимое число объектов.
offset
Integer (int32)
Какое количество объектов должно быть пропущено с начала. Используется для
запросов с пагинацией.
RESPONSES
STATUS: 200 - СПИСОК ДРУЗЕЙ ПОЛЬЗОВАТЕЛЯ, ОТСОРТИРОВАННЫЙ ПО УБЫВАНИЮ ПО ДАТЕ
ПОСЛЕДНЕГО ДОБАВЛЕНИЯ В ДРУЗЬЯ. В НАЧАЛЕ ИДУТ ДРУЗЬЯ, КОТОРЫЕ БЫЛИ ДОБАВЛЕНЫ
СОВСЕМ НЕДАВНО.
* Schema
[
{
Описание друга.
Required: addedAt,login
login:
string maxLength:30
Логин пользователя
Pattern: [a-zA-Z0-9-]+
example: yellowMonkey
addedAt:
string
Время и дата, когда данный пользователь был добавлен в друзья в последний раз.
Передается в формате RFC3339.
example: 2006-01-02T15:04:05Z07:00
}
]
STATUS: 401 - ПЕРЕДАННЫЙ ТОКЕН НЕ СУЩЕСТВУЕТ ЛИБО НЕКОРРЕКТЕН.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
FRIENDSREMOVE
Удалить пользователя из друзей
Позволяет удалить пользователя из друзей.
Если указанного пользователя нет в друзьях, верните успешный ответ.
Сервер должен идентифицировать пользователя по переданному токену. Значение
токена будет подставляться в заголовок Authorization в формате Bearer {token}.
/friends/remove
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X POST\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost:8080/api/friends/remove"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
DefaultApi apiInstance = new DefaultApi();
Friends_remove_body body = ; // Friends_remove_body | В теле запроса передается логин пользователя.
try {
inline_response_200_1 result = apiInstance.friendsRemove(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#friendsRemove");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
Friends_remove_body body = ; // Friends_remove_body | В теле запроса передается логин пользователя.
try {
inline_response_200_1 result = apiInstance.friendsRemove(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#friendsRemove");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
Friends_remove_body *body = ; // В теле запроса передается логин пользователя.
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Удалить пользователя из друзей
[apiInstance friendsRemoveWith:body
completionHandler: ^(inline_response_200_1 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var defaultClient = PulseApi.ApiClient.instance;
var api = new PulseApi.DefaultApi()
var body = ; // {{Friends_remove_body}} В теле запроса передается логин пользователя.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.friendsRemove(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class friendsRemoveExample
{
public void main()
{
var apiInstance = new DefaultApi();
var body = new Friends_remove_body(); // Friends_remove_body | В теле запроса передается логин пользователя.
try
{
// Удалить пользователя из друзей
inline_response_200_1 result = apiInstance.friendsRemove(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.friendsRemove: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // Friends_remove_body | В теле запроса передается логин пользователя.
try {
$result = $api_instance->friendsRemove($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->friendsRemove: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::Friends_remove_body->new(); # Friends_remove_body | В теле запроса передается логин пользователя.
eval {
my $result = $api_instance->friendsRemove(body => $body);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->friendsRemove: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
body = # Friends_remove_body | В теле запроса передается логин пользователя.
try:
# Удалить пользователя из друзей
api_response = api_instance.friends_remove(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->friendsRemove: %s\n" % e)
PARAMETERS
Body parameters
Name Description body *
{
Required: login
login:
string maxLength:30
Логин пользователя
Pattern: [a-zA-Z0-9-]+
example: yellowMonkey
}
RESPONSES
STATUS: 200 - ОПЕРАЦИЯ ЗАВЕРШИЛАСЬ УСПЕШНО.
* Schema
{
Required: status
status:
string
Должно принимать значение ok.
example: ok
}
STATUS: 401 - ПЕРЕДАННЫЙ ТОКЕН НЕ СУЩЕСТВУЕТ ЛИБО НЕКОРРЕКТЕН.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
GETCOUNTRY
Получить страну по alpha2 коду
Получение одной страны по её уникальному двухбуквенному коду.
Используется для получения информации по определенной стране.
/countries/{alpha2}
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X GET\
-H "Accept: application/json"\
"http://localhost:8080/api/countries/{alpha2}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
countryAlpha2 alpha2 = ; // countryAlpha2 | Возвращаемая страна должна иметь указанный alpha2 код.
try {
country result = apiInstance.getCountry(alpha2);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getCountry");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
countryAlpha2 alpha2 = ; // countryAlpha2 | Возвращаемая страна должна иметь указанный alpha2 код.
try {
country result = apiInstance.getCountry(alpha2);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getCountry");
e.printStackTrace();
}
}
}
countryAlpha2 *alpha2 = ; // Возвращаемая страна должна иметь указанный alpha2 код.
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Получить страну по alpha2 коду
[apiInstance getCountryWith:alpha2
completionHandler: ^(country output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var api = new PulseApi.DefaultApi()
var alpha2 = ; // {{countryAlpha2}} Возвращаемая страна должна иметь указанный alpha2 код.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getCountry(alpha2, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getCountryExample
{
public void main()
{
var apiInstance = new DefaultApi();
var alpha2 = new countryAlpha2(); // countryAlpha2 | Возвращаемая страна должна иметь указанный alpha2 код.
try
{
// Получить страну по alpha2 коду
country result = apiInstance.getCountry(alpha2);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.getCountry: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$alpha2 = ; // countryAlpha2 | Возвращаемая страна должна иметь указанный alpha2 код.
try {
$result = $api_instance->getCountry($alpha2);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->getCountry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $alpha2 = ; # countryAlpha2 | Возвращаемая страна должна иметь указанный alpha2 код.
eval {
my $result = $api_instance->getCountry(alpha2 => $alpha2);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->getCountry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
alpha2 = # countryAlpha2 | Возвращаемая страна должна иметь указанный alpha2 код.
try:
# Получить страну по alpha2 коду
api_response = api_instance.get_country(alpha2)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->getCountry: %s\n" % e)
PARAMETERS
Path parameters
Name Description alpha2*
countryAlpha2
Возвращаемая страна должна иметь указанный alpha2 код.
Required
RESPONSES
STATUS: 200 - СТРАНА, НАЙДЕННАЯ ПО УКАЗАННОМУ КОДУ.
* Schema
{
Информация о стране из стандарта ISO 3166
Required: alpha2,alpha3,name
name:
string maxLength:100
Полное название страны
alpha2:
string maxLength:2
Двухбуквенный код, уникально идентифицирующий страну
Pattern: [a-zA-Z]{2}
example: RU
alpha3:
string maxLength:3
Трехбуквенный код страны
Pattern: [a-zA-Z]{3}
region:
string
Географический регион, к которому относится страна
Enum: Europe, Africa, Americas, Oceania, Asia
}
example: [object Object]
STATUS: 404 - СТРАНА С УКАЗАННЫМ КОДОМ НЕ НАЙДЕНА.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
GETFEEDBYOTHERS
Получить ленту с постами другого пользователя
Используется для получения списка публикаций другого пользователя.
Если профиль пользователя открыт, его посты доступны всем. Если профиль
пользователя закрыт, его посты доступны самому пользователю и пользователям,
кого он добавил в друзья.
Для плавной работы приложения используется пагинация.
Сервер должен идентифицировать пользователя по переданному токену. Значение
токена будет подставляться в заголовок Authorization в формате Bearer {token}.
/posts/feed/{login}
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X GET\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"http://localhost:8080/api/posts/feed/{login}?limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
DefaultApi apiInstance = new DefaultApi();
userLogin login = ; // userLogin | Логин пользователя.
Integer limit = 56; // Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
Integer offset = 56; // Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
try {
array[post] result = apiInstance.getFeedByOthers(login, limit, offset);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getFeedByOthers");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
userLogin login = ; // userLogin | Логин пользователя.
Integer limit = 56; // Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
Integer offset = 56; // Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
try {
array[post] result = apiInstance.getFeedByOthers(login, limit, offset);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getFeedByOthers");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
userLogin *login = ; // Логин пользователя.
Integer *limit = 56; // Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
(optional) (default to 5)
Integer *offset = 56; // Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
(optional) (default to 0)
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Получить ленту с постами другого пользователя
[apiInstance getFeedByOthersWith:login
limit:limit
offset:offset
completionHandler: ^(array[post] output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var defaultClient = PulseApi.ApiClient.instance;
var api = new PulseApi.DefaultApi()
var login = ; // {{userLogin}} Логин пользователя.
var opts = {
'limit': 56, // {{Integer}} Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
'offset': 56 // {{Integer}} Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getFeedByOthers(login, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getFeedByOthersExample
{
public void main()
{
var apiInstance = new DefaultApi();
var login = new userLogin(); // userLogin | Логин пользователя.
var limit = 56; // Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
(optional) (default to 5)
var offset = 56; // Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
(optional) (default to 0)
try
{
// Получить ленту с постами другого пользователя
array[post] result = apiInstance.getFeedByOthers(login, limit, offset);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.getFeedByOthers: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$login = ; // userLogin | Логин пользователя.
$limit = 56; // Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
$offset = 56; // Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
try {
$result = $api_instance->getFeedByOthers($login, $limit, $offset);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->getFeedByOthers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $login = ; # userLogin | Логин пользователя.
my $limit = 56; # Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
my $offset = 56; # Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
eval {
my $result = $api_instance->getFeedByOthers(login => $login, limit => $limit, offset => $offset);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->getFeedByOthers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
login = # userLogin | Логин пользователя.
limit = 56 # Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
(optional) (default to 5)
offset = 56 # Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
(optional) (default to 0)
try:
# Получить ленту с постами другого пользователя
api_response = api_instance.get_feed_by_others(login, limit=limit, offset=offset)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->getFeedByOthers: %s\n" % e)
PARAMETERS
Path parameters
Name Description login*
userLogin
Логин пользователя.
Required
Query parameters
Name Description limit
Integer (int32)
Максимальное число возвращаемых объектов. Используется для запросов с
пагинацией. Сервер должен возвращать максимальное допустимое число объектов.
offset
Integer (int32)
Какое количество объектов должно быть пропущено с начала. Используется для
запросов с пагинацией.
RESPONSES
STATUS: 200 - СПИСОК ПУБЛИКАЦИЙ ПОЛЬЗОВАТЕЛЯ, ОТСОРТИРОВАННЫХ ПО УБЫВАНИЮ ПО
ДАТЕ ПУБЛИКАЦИИ. В НАЧАЛЕ ИДУТ ПУБЛИКАЦИИ, КОТОРЫЕ БЫЛИ ДОБАВЛЕНЫ СОВСЕМ
НЕДАВНО.
* Schema
[
{
Пользовательская публикация.
Required: author,content,createdAt,dislikesCount,id,likesCount,tags
id:
string maxLength:100
Уникальный идентификатор публикации, присвоенный сервером.
example: 550e8400-e29b-41d4-a716-446655440000
content:
string maxLength:1000
Текст публикации.
example: Свеча на 400! Покупаем, докупаем и фиксируем прибыль.
author:
string maxLength:30
Логин пользователя
Pattern: [a-zA-Z0-9-]+
example: yellowMonkey
tags:
[
Список тегов публикации.
string maxLength:20
Значение тега.
example: тинькофф
]
example: тинькофф,спббиржа,moex
createdAt:
string
Серверная дата и время в момент, когда пользователь отправил данную публикацию.
Передается в формате RFC3339.
example: 2006-01-02T15:04:05Z07:00
likesCount:
integer
Число лайков, набранное публикацией.
dislikesCount:
integer
Число дизлайков, набранное публикацией.
}
]
STATUS: 401 - ПЕРЕДАННЫЙ ТОКЕН НЕ СУЩЕСТВУЕТ ЛИБО НЕКОРРЕКТЕН.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
STATUS: 404 - ПОЛЬЗОВАТЕЛЬ НЕ НАЙДЕН ЛИБО К НЕМУ НЕТ ДОСТУПА.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
GETMYFEED
Получить ленту со своими постами
Используется для получения списка своих постов.
Для плавной работы приложения используется пагинация.
Можете считать, что пользователей с логином my не будет.
Сервер должен идентифицировать пользователя по переданному токену. Значение
токена будет подставляться в заголовок Authorization в формате Bearer {token}.
/posts/feed/my
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X GET\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"http://localhost:8080/api/posts/feed/my?limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
DefaultApi apiInstance = new DefaultApi();
Integer limit = 56; // Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
Integer offset = 56; // Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
try {
array[post] result = apiInstance.getMyFeed(limit, offset);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getMyFeed");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
Integer limit = 56; // Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
Integer offset = 56; // Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
try {
array[post] result = apiInstance.getMyFeed(limit, offset);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getMyFeed");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *limit = 56; // Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
(optional) (default to 5)
Integer *offset = 56; // Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
(optional) (default to 0)
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Получить ленту со своими постами
[apiInstance getMyFeedWith:limit
offset:offset
completionHandler: ^(array[post] output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var defaultClient = PulseApi.ApiClient.instance;
var api = new PulseApi.DefaultApi()
var opts = {
'limit': 56, // {{Integer}} Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
'offset': 56 // {{Integer}} Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getMyFeed(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getMyFeedExample
{
public void main()
{
var apiInstance = new DefaultApi();
var limit = 56; // Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
(optional) (default to 5)
var offset = 56; // Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
(optional) (default to 0)
try
{
// Получить ленту со своими постами
array[post] result = apiInstance.getMyFeed(limit, offset);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.getMyFeed: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$limit = 56; // Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
$offset = 56; // Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
try {
$result = $api_instance->getMyFeed($limit, $offset);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->getMyFeed: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $limit = 56; # Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
my $offset = 56; # Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
eval {
my $result = $api_instance->getMyFeed(limit => $limit, offset => $offset);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->getMyFeed: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
limit = 56 # Integer | Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
(optional) (default to 5)
offset = 56 # Integer | Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
(optional) (default to 0)
try:
# Получить ленту со своими постами
api_response = api_instance.get_my_feed(limit=limit, offset=offset)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->getMyFeed: %s\n" % e)
PARAMETERS
Query parameters
Name Description limit
Integer (int32)
Максимальное число возвращаемых объектов. Используется для запросов с
пагинацией. Сервер должен возвращать максимальное допустимое число объектов.
offset
Integer (int32)
Какое количество объектов должно быть пропущено с начала. Используется для
запросов с пагинацией.
RESPONSES
STATUS: 200 - СПИСОК ПУБЛИКАЦИЙ ПОЛЬЗОВАТЕЛЯ, ОТСОРТИРОВАННЫХ ПО УБЫВАНИЮ ПО
ДАТЕ ПУБЛИКАЦИИ. В НАЧАЛЕ ИДУТ ПУБЛИКАЦИИ, КОТОРЫЕ БЫЛИ ДОБАВЛЕНЫ СОВСЕМ
НЕДАВНО.
* Schema
[
{
Пользовательская публикация.
Required: author,content,createdAt,dislikesCount,id,likesCount,tags
id:
string maxLength:100
Уникальный идентификатор публикации, присвоенный сервером.
example: 550e8400-e29b-41d4-a716-446655440000
content:
string maxLength:1000
Текст публикации.
example: Свеча на 400! Покупаем, докупаем и фиксируем прибыль.
author:
string maxLength:30
Логин пользователя
Pattern: [a-zA-Z0-9-]+
example: yellowMonkey
tags:
[
Список тегов публикации.
string maxLength:20
Значение тега.
example: тинькофф
]
example: тинькофф,спббиржа,moex
createdAt:
string
Серверная дата и время в момент, когда пользователь отправил данную публикацию.
Передается в формате RFC3339.
example: 2006-01-02T15:04:05Z07:00
likesCount:
integer
Число лайков, набранное публикацией.
dislikesCount:
integer
Число дизлайков, набранное публикацией.
}
]
STATUS: 401 - ПЕРЕДАННЫЙ ТОКЕН НЕ СУЩЕСТВУЕТ ЛИБО НЕКОРРЕКТЕН.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
GETMYPROFILE
Получение собственного профиля
Используется для получения пользователем его собственного профиля.
Сервер должен идентифицировать пользователя по переданному токену. Значение
токена будет подставляться в заголовок Authorization в формате Bearer {token}.
/me/profile
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X GET\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"http://localhost:8080/api/me/profile"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
DefaultApi apiInstance = new DefaultApi();
try {
userProfile result = apiInstance.getMyProfile();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getMyProfile");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
try {
userProfile result = apiInstance.getMyProfile();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getMyProfile");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Получение собственного профиля
[apiInstance getMyProfileWithCompletionHandler:
^(userProfile output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var defaultClient = PulseApi.ApiClient.instance;
var api = new PulseApi.DefaultApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getMyProfile(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getMyProfileExample
{
public void main()
{
var apiInstance = new DefaultApi();
try
{
// Получение собственного профиля
userProfile result = apiInstance.getMyProfile();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.getMyProfile: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
try {
$result = $api_instance->getMyProfile();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->getMyProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
eval {
my $result = $api_instance->getMyProfile();
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->getMyProfile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
try:
# Получение собственного профиля
api_response = api_instance.get_my_profile()
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->getMyProfile: %s\n" % e)
PARAMETERS
RESPONSES
STATUS: 200 - ПЕРЕДАН ДЕЙСТВИТЕЛЬНЫЙ ТОКЕН, В ОТВЕТЕ ВОЗВРАЩАЕТСЯ ПРОФИЛЬ
ПОЛЬЗОВАТЕЛЯ.
* Schema
{
Информация о профиле пользователя
Required: countryCode,email,isPublic,login
login:
string maxLength:30
Логин пользователя
Pattern: [a-zA-Z0-9-]+
example: yellowMonkey
email:
string minLength:1 maxLength:50
E-mail пользователя
example: yellowstone1980@you.ru
countryCode:
string maxLength:2
Двухбуквенный код, уникально идентифицирующий страну
Pattern: [a-zA-Z]{2}
example: RU
isPublic:
boolean
Является ли данный профиль публичным.
Публичные профили доступны другим пользователям: если профиль публичный, любой
пользователь платформы сможет получить информацию о пользователе.
example: true
phone:
string maxLength:20
Номер телефона пользователя в формате +123456789
Pattern: \+[\d]+
example: +74951239922
image:
string minLength:1 maxLength:200
Ссылка на фото для аватара пользователя
example: https://http.cat/images/100.jpg
}
STATUS: 401 - ПЕРЕДАННЫЙ ТОКЕН НЕ СУЩЕСТВУЕТ ЛИБО НЕКОРРЕКТЕН.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
GETPOSTBYID
Получить публикацию по ID
Используется для получения публикации по её идентификатору.
Если публикация принадлежит пользователю с публичным профилем, её может получить
любой другой аутентифицированный пользователь.
Если профиль автора закрыт, она доступна автору и пользователям, кого автор
добавил в друзья.
Сервер должен идентифицировать пользователя по переданному токену. Значение
токена будет подставляться в заголовок Authorization в формате Bearer {token}.
/posts/{postId}
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X GET\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"http://localhost:8080/api/posts/{postId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
DefaultApi apiInstance = new DefaultApi();
postId postId = ; // postId | ID публикации.
try {
post result = apiInstance.getPostById(postId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getPostById");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
postId postId = ; // postId | ID публикации.
try {
post result = apiInstance.getPostById(postId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getPostById");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
postId *postId = ; // ID публикации.
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Получить публикацию по ID
[apiInstance getPostByIdWith:postId
completionHandler: ^(post output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var defaultClient = PulseApi.ApiClient.instance;
var api = new PulseApi.DefaultApi()
var postId = ; // {{postId}} ID публикации.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getPostById(postId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getPostByIdExample
{
public void main()
{
var apiInstance = new DefaultApi();
var postId = new postId(); // postId | ID публикации.
try
{
// Получить публикацию по ID
post result = apiInstance.getPostById(postId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.getPostById: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$postId = ; // postId | ID публикации.
try {
$result = $api_instance->getPostById($postId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->getPostById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $postId = ; # postId | ID публикации.
eval {
my $result = $api_instance->getPostById(postId => $postId);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->getPostById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
postId = # postId | ID публикации.
try:
# Получить публикацию по ID
api_response = api_instance.get_post_by_id(postId)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->getPostById: %s\n" % e)
PARAMETERS
Path parameters
Name Description postId*
postId
ID публикации.
Required
RESPONSES
STATUS: 200 - ПУБЛИКАЦИЯ НАЙДЕНА.
* Schema
{
Пользовательская публикация.
Required: author,content,createdAt,dislikesCount,id,likesCount,tags
id:
string maxLength:100
Уникальный идентификатор публикации, присвоенный сервером.
example: 550e8400-e29b-41d4-a716-446655440000
content:
string maxLength:1000
Текст публикации.
example: Свеча на 400! Покупаем, докупаем и фиксируем прибыль.
author:
string maxLength:30
Логин пользователя
Pattern: [a-zA-Z0-9-]+
example: yellowMonkey
tags:
[
Список тегов публикации.
string maxLength:20
Значение тега.
example: тинькофф
]
example: тинькофф,спббиржа,moex
createdAt:
string
Серверная дата и время в момент, когда пользователь отправил данную публикацию.
Передается в формате RFC3339.
example: 2006-01-02T15:04:05Z07:00
likesCount:
integer
Число лайков, набранное публикацией.
dislikesCount:
integer
Число дизлайков, набранное публикацией.
}
STATUS: 401 - ПЕРЕДАННЫЙ ТОКЕН НЕ СУЩЕСТВУЕТ ЛИБО НЕКОРРЕКТЕН.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
STATUS: 404 - УКАЗАННЫЙ ПОСТ НЕ НАЙДЕН ЛИБО К НЕМУ НЕТ ДОСТУПА.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
GETPROFILE
Получение профиля пользователя по логину
Используется для получения профиля другого пользователя по логину.
Если профиль пользователя публичен (isPublic: true), его может получить любой
другой пользователь. Если профиль пользователя закрыт, его могут получить
пользователи, которых данный пользователь добавил в друзья.
При этом собственный профиль пользователь может получить всегда. Сервер должен
идентифицировать пользователя по переданному токену в заголовке Authorization.
/profiles/{login}
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X GET\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"http://localhost:8080/api/profiles/{login}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
DefaultApi apiInstance = new DefaultApi();
userLogin login = ; // userLogin | Логин пользователя, чей профиль необходимо получить.
try {
userProfile result = apiInstance.getProfile(login);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getProfile");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
userLogin login = ; // userLogin | Логин пользователя, чей профиль необходимо получить.
try {
userProfile result = apiInstance.getProfile(login);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getProfile");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
userLogin *login = ; // Логин пользователя, чей профиль необходимо получить.
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Получение профиля пользователя по логину
[apiInstance getProfileWith:login
completionHandler: ^(userProfile output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var defaultClient = PulseApi.ApiClient.instance;
var api = new PulseApi.DefaultApi()
var login = ; // {{userLogin}} Логин пользователя, чей профиль необходимо получить.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getProfile(login, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getProfileExample
{
public void main()
{
var apiInstance = new DefaultApi();
var login = new userLogin(); // userLogin | Логин пользователя, чей профиль необходимо получить.
try
{
// Получение профиля пользователя по логину
userProfile result = apiInstance.getProfile(login);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.getProfile: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$login = ; // userLogin | Логин пользователя, чей профиль необходимо получить.
try {
$result = $api_instance->getProfile($login);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->getProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $login = ; # userLogin | Логин пользователя, чей профиль необходимо получить.
eval {
my $result = $api_instance->getProfile(login => $login);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->getProfile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
login = # userLogin | Логин пользователя, чей профиль необходимо получить.
try:
# Получение профиля пользователя по логину
api_response = api_instance.get_profile(login)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->getProfile: %s\n" % e)
PARAMETERS
Path parameters
Name Description login*
userLogin
Логин пользователя, чей профиль необходимо получить.
Required
RESPONSES
STATUS: 200 - ПОЛЬЗОВАТЕЛЬ С УКАЗАННЫМ ЛОГИНОМ СУЩЕСТВУЕТ И ЕГО ПРОФИЛЬ МОЖЕТ
БЫТЬ ПОЛУЧЕН ПОЛЬЗОВАТЕЛЕМ, ОСУЩЕСТВИВШИМ ЗАПРОС.
* Schema
{
Информация о профиле пользователя
Required: countryCode,email,isPublic,login
login:
string maxLength:30
Логин пользователя
Pattern: [a-zA-Z0-9-]+
example: yellowMonkey
email:
string minLength:1 maxLength:50
E-mail пользователя
example: yellowstone1980@you.ru
countryCode:
string maxLength:2
Двухбуквенный код, уникально идентифицирующий страну
Pattern: [a-zA-Z]{2}
example: RU
isPublic:
boolean
Является ли данный профиль публичным.
Публичные профили доступны другим пользователям: если профиль публичный, любой
пользователь платформы сможет получить информацию о пользователе.
example: true
phone:
string maxLength:20
Номер телефона пользователя в формате +123456789
Pattern: \+[\d]+
example: +74951239922
image:
string minLength:1 maxLength:200
Ссылка на фото для аватара пользователя
example: https://http.cat/images/100.jpg
}
STATUS: 401 - ПЕРЕДАННЫЙ ТОКЕН НЕ СУЩЕСТВУЕТ ЛИБО НЕКОРРЕКТЕН.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
STATUS: 403 - ПРОФИЛЬ НЕ МОЖЕТ БЫТЬ ПОЛУЧЕН: ЛИБО ПОЛЬЗОВАТЕЛЬ С УКАЗАННЫМ
ЛОГИНОМ НЕ СУЩЕСТВУЕТ, ЛИБО У ОТПРАВИТЕЛЯ ЗАПРОСА НЕТ ДОСТУПА К ЗАПРАШИВАЕМОМУ
ПРОФИЛЮ.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
LIKSTPOST
Лайк поста
Лайк поста.
Сервер должен идентифицировать пользователя по переданному токену. Значение
токена будет подставляться в заголовок Authorization в формате Bearer {token}.
/posts/{postId}/like
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X POST\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"http://localhost:8080/api/posts/{postId}/like"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
DefaultApi apiInstance = new DefaultApi();
postId postId = ; // postId | ID публикации.
try {
post result = apiInstance.likstPost(postId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#likstPost");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
postId postId = ; // postId | ID публикации.
try {
post result = apiInstance.likstPost(postId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#likstPost");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
postId *postId = ; // ID публикации.
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Лайк поста
[apiInstance likstPostWith:postId
completionHandler: ^(post output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var defaultClient = PulseApi.ApiClient.instance;
var api = new PulseApi.DefaultApi()
var postId = ; // {{postId}} ID публикации.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.likstPost(postId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class likstPostExample
{
public void main()
{
var apiInstance = new DefaultApi();
var postId = new postId(); // postId | ID публикации.
try
{
// Лайк поста
post result = apiInstance.likstPost(postId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.likstPost: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$postId = ; // postId | ID публикации.
try {
$result = $api_instance->likstPost($postId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->likstPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $postId = ; # postId | ID публикации.
eval {
my $result = $api_instance->likstPost(postId => $postId);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->likstPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
postId = # postId | ID публикации.
try:
# Лайк поста
api_response = api_instance.likst_post(postId)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->likstPost: %s\n" % e)
PARAMETERS
Path parameters
Name Description postId*
postId
ID публикации.
Required
RESPONSES
STATUS: 200 - РЕАКЦИЯ ЗАСЧИТАНА, ВОЗВРАЩАЙТЕ ПУБИКАЦИЮ С АКТУАЛЬНЫМ ЧИСЛОМ
ЛАЙКОВ И ДИЗЛАЙКОВ.
* Schema
{
Пользовательская публикация.
Required: author,content,createdAt,dislikesCount,id,likesCount,tags
id:
string maxLength:100
Уникальный идентификатор публикации, присвоенный сервером.
example: 550e8400-e29b-41d4-a716-446655440000
content:
string maxLength:1000
Текст публикации.
example: Свеча на 400! Покупаем, докупаем и фиксируем прибыль.
author:
string maxLength:30
Логин пользователя
Pattern: [a-zA-Z0-9-]+
example: yellowMonkey
tags:
[
Список тегов публикации.
string maxLength:20
Значение тега.
example: тинькофф
]
example: тинькофф,спббиржа,moex
createdAt:
string
Серверная дата и время в момент, когда пользователь отправил данную публикацию.
Передается в формате RFC3339.
example: 2006-01-02T15:04:05Z07:00
likesCount:
integer
Число лайков, набранное публикацией.
dislikesCount:
integer
Число дизлайков, набранное публикацией.
}
STATUS: 401 - ПЕРЕДАННЫЙ ТОКЕН НЕ СУЩЕСТВУЕТ ЛИБО НЕКОРРЕКТЕН.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
STATUS: 404 - УКАЗАННЫЙ ПОСТ НЕ НАЙДЕН ЛИБО К НЕМУ НЕТ ДОСТУПА.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
LISTCOUNTRIES
Получить список стран
Получение списка стран с возможной фильтрацией.
Используется на странице регистрации для предоставления возможности выбора
страны, к которой относится пользователь. Если хотя бы один переданный регион
является некорректным, весь запрос считается некорректным.
Если никакие из фильтров не переданы, необходимо вернуть все страны.
/countries
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X GET\
-H "Accept: application/json"\
"http://localhost:8080/api/countries?region="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
array[countryRegion] region = ; // array[countryRegion] | Возвращаемые страны должны относиться только к тем регионам, которые переданы в данном списке.
Если передан пустой список, считайте, что фильтр по региону отсутствует.
try {
array[country] result = apiInstance.listCountries(region);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#listCountries");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
array[countryRegion] region = ; // array[countryRegion] | Возвращаемые страны должны относиться только к тем регионам, которые переданы в данном списке.
Если передан пустой список, считайте, что фильтр по региону отсутствует.
try {
array[country] result = apiInstance.listCountries(region);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#listCountries");
e.printStackTrace();
}
}
}
array[countryRegion] *region = ; // Возвращаемые страны должны относиться только к тем регионам, которые переданы в данном списке.
Если передан пустой список, считайте, что фильтр по региону отсутствует.
(optional)
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Получить список стран
[apiInstance listCountriesWith:region
completionHandler: ^(array[country] output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var api = new PulseApi.DefaultApi()
var opts = {
'region': // {{array[countryRegion]}} Возвращаемые страны должны относиться только к тем регионам, которые переданы в данном списке.
Если передан пустой список, считайте, что фильтр по региону отсутствует.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.listCountries(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class listCountriesExample
{
public void main()
{
var apiInstance = new DefaultApi();
var region = new array[countryRegion](); // array[countryRegion] | Возвращаемые страны должны относиться только к тем регионам, которые переданы в данном списке.
Если передан пустой список, считайте, что фильтр по региону отсутствует.
(optional)
try
{
// Получить список стран
array[country] result = apiInstance.listCountries(region);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.listCountries: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$region = ; // array[countryRegion] | Возвращаемые страны должны относиться только к тем регионам, которые переданы в данном списке.
Если передан пустой список, считайте, что фильтр по региону отсутствует.
try {
$result = $api_instance->listCountries($region);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->listCountries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $region = []; # array[countryRegion] | Возвращаемые страны должны относиться только к тем регионам, которые переданы в данном списке.
Если передан пустой список, считайте, что фильтр по региону отсутствует.
eval {
my $result = $api_instance->listCountries(region => $region);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->listCountries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
region = # array[countryRegion] | Возвращаемые страны должны относиться только к тем регионам, которые переданы в данном списке.
Если передан пустой список, считайте, что фильтр по региону отсутствует.
(optional)
try:
# Получить список стран
api_response = api_instance.list_countries(region=region)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->listCountries: %s\n" % e)
PARAMETERS
Query parameters
Name Description region
array[countryRegion]
Возвращаемые страны должны относиться только к тем регионам, которые переданы в
данном списке. Если передан пустой список, считайте, что фильтр по региону
отсутствует.
RESPONSES
STATUS: 200 - СПИСОК СТРАН, СООТВЕТСТВУЮЩИХ УКАЗАННОМУ ФИЛЬТРУ. СТРАНЫ ДОЛЖНЫ
БЫТЬ ОТСОРТИРОВАНЫ ЛЕКСИКОГРАФИЧЕСКИ ПО ДВУХБУКВЕННОМУ КОДУ.
* Schema
[
{
Информация о стране из стандарта ISO 3166
Required: alpha2,alpha3,name
name:
string maxLength:100
Полное название страны
alpha2:
string maxLength:2
Двухбуквенный код, уникально идентифицирующий страну
Pattern: [a-zA-Z]{2}
example: RU
alpha3:
string maxLength:3
Трехбуквенный код страны
Pattern: [a-zA-Z]{3}
region:
string
Географический регион, к которому относится страна
Enum: Europe, Africa, Americas, Oceania, Asia
}
example: [object Object]
]
STATUS: 400 - ФОРМАТ ВХОДНОГО ЗАПРОСА НЕ СООТВЕТСТВУЕТ ФОРМАТУ ЛИБО ПЕРЕДАНЫ
НЕВЕРНЫЕ ЗНАЧЕНИЯ.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
PATCHMYPROFILE
Редактирование собственного профиля
Используется для редактирования параметров профиля пользователя.
Сервер должен идентифицировать пользователя по переданному токену. Значение
токена будет подставляться в заголовок Authorization в формате Bearer {token}.
/me/profile
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X PATCH\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost:8080/api/me/profile"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
DefaultApi apiInstance = new DefaultApi();
Me_profile_body body = ; // Me_profile_body | В теле запроса перечисляются названия параметров, которые необходимо обновить, и новые значения.
Если значение передано, данное изменение должно быть отражено в профиле пользователя.
Если значение не передано, необходимо оставить прежнее значение параметра.
Если передана пустая структура, ничего изменять не требуется, возвращается успешный ответ.
try {
userProfile result = apiInstance.patchMyProfile(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#patchMyProfile");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
Me_profile_body body = ; // Me_profile_body | В теле запроса перечисляются названия параметров, которые необходимо обновить, и новые значения.
Если значение передано, данное изменение должно быть отражено в профиле пользователя.
Если значение не передано, необходимо оставить прежнее значение параметра.
Если передана пустая структура, ничего изменять не требуется, возвращается успешный ответ.
try {
userProfile result = apiInstance.patchMyProfile(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#patchMyProfile");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
Me_profile_body *body = ; // В теле запроса перечисляются названия параметров, которые необходимо обновить, и новые значения.
Если значение передано, данное изменение должно быть отражено в профиле пользователя.
Если значение не передано, необходимо оставить прежнее значение параметра.
Если передана пустая структура, ничего изменять не требуется, возвращается успешный ответ.
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Редактирование собственного профиля
[apiInstance patchMyProfileWith:body
completionHandler: ^(userProfile output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var defaultClient = PulseApi.ApiClient.instance;
var api = new PulseApi.DefaultApi()
var body = ; // {{Me_profile_body}} В теле запроса перечисляются названия параметров, которые необходимо обновить, и новые значения.
Если значение передано, данное изменение должно быть отражено в профиле пользователя.
Если значение не передано, необходимо оставить прежнее значение параметра.
Если передана пустая структура, ничего изменять не требуется, возвращается успешный ответ.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.patchMyProfile(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class patchMyProfileExample
{
public void main()
{
var apiInstance = new DefaultApi();
var body = new Me_profile_body(); // Me_profile_body | В теле запроса перечисляются названия параметров, которые необходимо обновить, и новые значения.
Если значение передано, данное изменение должно быть отражено в профиле пользователя.
Если значение не передано, необходимо оставить прежнее значение параметра.
Если передана пустая структура, ничего изменять не требуется, возвращается успешный ответ.
try
{
// Редактирование собственного профиля
userProfile result = apiInstance.patchMyProfile(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.patchMyProfile: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // Me_profile_body | В теле запроса перечисляются названия параметров, которые необходимо обновить, и новые значения.
Если значение передано, данное изменение должно быть отражено в профиле пользователя.
Если значение не передано, необходимо оставить прежнее значение параметра.
Если передана пустая структура, ничего изменять не требуется, возвращается успешный ответ.
try {
$result = $api_instance->patchMyProfile($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->patchMyProfile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::Me_profile_body->new(); # Me_profile_body | В теле запроса перечисляются названия параметров, которые необходимо обновить, и новые значения.
Если значение передано, данное изменение должно быть отражено в профиле пользователя.
Если значение не передано, необходимо оставить прежнее значение параметра.
Если передана пустая структура, ничего изменять не требуется, возвращается успешный ответ.
eval {
my $result = $api_instance->patchMyProfile(body => $body);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->patchMyProfile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
body = # Me_profile_body | В теле запроса перечисляются названия параметров, которые необходимо обновить, и новые значения.
Если значение передано, данное изменение должно быть отражено в профиле пользователя.
Если значение не передано, необходимо оставить прежнее значение параметра.
Если передана пустая структура, ничего изменять не требуется, возвращается успешный ответ.
try:
# Редактирование собственного профиля
api_response = api_instance.patch_my_profile(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->patchMyProfile: %s\n" % e)
PARAMETERS
Body parameters
Name Description body *
{
countryCode:
string maxLength:2
Двухбуквенный код, уникально идентифицирующий страну
Pattern: [a-zA-Z]{2}
example: RU
isPublic:
boolean
Является ли данный профиль публичным.
Публичные профили доступны другим пользователям: если профиль публичный, любой
пользователь платформы сможет получить информацию о пользователе.
example: true
phone:
string maxLength:20
Номер телефона пользователя в формате +123456789
Pattern: \+[\d]+
example: +74951239922
image:
string minLength:1 maxLength:200
Ссылка на фото для аватара пользователя
example: https://http.cat/images/100.jpg
}
RESPONSES
STATUS: 200 - ПЕРЕДАН ДЕЙСТВИТЕЛЬНЫЙ ТОКЕН, В ОТВЕТЕ ВОЗВРАЩАЕТСЯ ПРОФИЛЬ
ПОЛЬЗОВАТЕЛЯ С ПРИМЕНЕННЫМИ ИЗМЕНЕНИЯМИ.
* Schema
{
Информация о профиле пользователя
Required: countryCode,email,isPublic,login
login:
string maxLength:30
Логин пользователя
Pattern: [a-zA-Z0-9-]+
example: yellowMonkey
email:
string minLength:1 maxLength:50
E-mail пользователя
example: yellowstone1980@you.ru
countryCode:
string maxLength:2
Двухбуквенный код, уникально идентифицирующий страну
Pattern: [a-zA-Z]{2}
example: RU
isPublic:
boolean
Является ли данный профиль публичным.
Публичные профили доступны другим пользователям: если профиль публичный, любой
пользователь платформы сможет получить информацию о пользователе.
example: true
phone:
string maxLength:20
Номер телефона пользователя в формате +123456789
Pattern: \+[\d]+
example: +74951239922
image:
string minLength:1 maxLength:200
Ссылка на фото для аватара пользователя
example: https://http.cat/images/100.jpg
}
STATUS: 400 - ДАННЫЕ НЕ СООТВЕТСТВУЮТ ОЖИДАЕМОМУ ФОРМАТУ И ТРЕБОВАНИЯМ.
НАПРИМЕР, ДАННУЮ ОШИБКУ НЕОБХОДИМО ВОЗВРАЩАТЬ В СЛЕДУЮЩИХ СИТУАЦИЯХ (ЭТО НЕ
ПОЛНЫЙ СПИСОК): - СТРАНА С УКАЗАННЫМ КОДОМ НЕ НАЙДЕНА. - ДЛИНА ССЫЛКИ НА АВАТАР
ПОЛЬЗОВАТЕЛЯ ПРЕВЫШАЕТ ДОПУСТИМЫЙ ЛИМИТ. ДЛЯ ОЗНАКОМЛЕНИЯ С ФОРМАТОМ И
ТРЕБОВАНИЯМИ К РЕГИСТРАЦИОННЫМ ДАННЫМ ОБРАТИТЕ ВНИМАНИЕ НА ОПИСАНИЕ МОДЕЛЕЙ В
OPEN API СПЕЦИФИКАЦИИ.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
STATUS: 401 - ПЕРЕДАННЫЙ ТОКЕН НЕ СУЩЕСТВУЕТ ЛИБО НЕКОРРЕКТЕН.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
STATUS: 409 - НАРУШЕНО ТРЕБОВАНИЕ НА УНИКАЛЬНОСТЬ АВТОРИЗАЦИОННЫХ ДАННЫХ
ПОЛЬЗОВАТЕЛЕЙ. ДАННЫЙ КОД ОТВЕТА ДОЛЖЕН ИСПОЛЬЗОВАТЬСЯ, ЕСЛИ УКАЗАННЫЙ НОМЕР
ТЕЛЕФОНА ЗАНЯТ ДРУГИМ ПОЛЬЗОВАТЕЛЕМ.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
PING
Проверка сервера на готовность принимать запросы
Данный эндпоинт позволяет понять, что сервер готов принимать входящие запросы.
Программа-чекер будет дожидаться первого успешного ответа от сервера на данный
эндпоинт, после чего будет запускать проверку тестовый сценариев.
/ping
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X GET\
-H "Accept: text/plain"\
"http://localhost:8080/api/ping"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
try {
'String' result = apiInstance.ping();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#ping");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
try {
'String' result = apiInstance.ping();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#ping");
e.printStackTrace();
}
}
}
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Проверка сервера на готовность принимать запросы
[apiInstance pingWithCompletionHandler:
^('String' output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var api = new PulseApi.DefaultApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.ping(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class pingExample
{
public void main()
{
var apiInstance = new DefaultApi();
try
{
// Проверка сервера на готовность принимать запросы
'String' result = apiInstance.ping();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.ping: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
try {
$result = $api_instance->ping();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->ping: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
eval {
my $result = $api_instance->ping();
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->ping: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
try:
# Проверка сервера на готовность принимать запросы
api_response = api_instance.ping()
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->ping: %s\n" % e)
PARAMETERS
RESPONSES
STATUS: 200 - ЕСЛИ СЕРВЕР УСПЕШНО ОТВЕЧАЕТ НА ДАННЫЙ ЗАПРОС, СЧИТАЕТСЯ, ЧТО ОН
ГОТОВ ОБРАБАТЫВАТЬ ВХОДЯЩИЕ ЗАПРОСЫ В API. СОДЕРЖИМОЕ ОТВЕТА ПРИ ЭТОМ НЕ
ВАЛИДИРУЕТСЯ, МОЖНО ВОЗВРАЩАТЬ "OK".
* Schema
string
example: ok
STATUS: 500 - ЕСЛИ СЕРВЕР ОТВЕЧАЕТ ЛЮБЫМ ОТЛИЧНЫМ ОТ 200 КОДОМ ОТВЕТА,
СЧИТАЕТСЯ, ЧТО ОН НЕ ГОТОВ ПРИНИМАТЬ ЗАПРОСЫ.
--------------------------------------------------------------------------------
SUBMITPOST
Отправить публикацию
Используется для отправки публикации в ленту.
Сервер должен идентифицировать пользователя по переданному токену. Значение
токена будет подставляться в заголовок Authorization в формате Bearer {token}.
/posts/new
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X POST\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost:8080/api/posts/new"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
DefaultApi apiInstance = new DefaultApi();
Posts_new_body body = ; // Posts_new_body | Информация о публикации.
try {
post result = apiInstance.submitPost(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#submitPost");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
Posts_new_body body = ; // Posts_new_body | Информация о публикации.
try {
post result = apiInstance.submitPost(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#submitPost");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
Posts_new_body *body = ; // Информация о публикации.
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Отправить публикацию
[apiInstance submitPostWith:body
completionHandler: ^(post output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var defaultClient = PulseApi.ApiClient.instance;
var api = new PulseApi.DefaultApi()
var body = ; // {{Posts_new_body}} Информация о публикации.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.submitPost(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class submitPostExample
{
public void main()
{
var apiInstance = new DefaultApi();
var body = new Posts_new_body(); // Posts_new_body | Информация о публикации.
try
{
// Отправить публикацию
post result = apiInstance.submitPost(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.submitPost: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // Posts_new_body | Информация о публикации.
try {
$result = $api_instance->submitPost($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->submitPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::Posts_new_body->new(); # Posts_new_body | Информация о публикации.
eval {
my $result = $api_instance->submitPost(body => $body);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->submitPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
body = # Posts_new_body | Информация о публикации.
try:
# Отправить публикацию
api_response = api_instance.submit_post(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->submitPost: %s\n" % e)
PARAMETERS
Body parameters
Name Description body *
{
Required: content,tags
content:
string maxLength:1000
Текст публикации.
example: Свеча на 400! Покупаем, докупаем и фиксируем прибыль.
tags:
[
Список тегов публикации.
string maxLength:20
Значение тега.
example: тинькофф
]
example: тинькофф,спббиржа,moex
}
RESPONSES
STATUS: 200 - ПУБЛИКАЦИЯ СОХРАНЕНА. СЕРВЕР НАЗНАЧАЕТ УНИКАЛЬНЫЙ ИДЕНТИФИКАТОР И
ВРЕМЯ СОЗДАНИЯ ПУБЛИКАЦИИ.
* Schema
{
Пользовательская публикация.
Required: author,content,createdAt,dislikesCount,id,likesCount,tags
id:
string maxLength:100
Уникальный идентификатор публикации, присвоенный сервером.
example: 550e8400-e29b-41d4-a716-446655440000
content:
string maxLength:1000
Текст публикации.
example: Свеча на 400! Покупаем, докупаем и фиксируем прибыль.
author:
string maxLength:30
Логин пользователя
Pattern: [a-zA-Z0-9-]+
example: yellowMonkey
tags:
[
Список тегов публикации.
string maxLength:20
Значение тега.
example: тинькофф
]
example: тинькофф,спббиржа,moex
createdAt:
string
Серверная дата и время в момент, когда пользователь отправил данную публикацию.
Передается в формате RFC3339.
example: 2006-01-02T15:04:05Z07:00
likesCount:
integer
Число лайков, набранное публикацией.
dislikesCount:
integer
Число дизлайков, набранное публикацией.
}
STATUS: 401 - ПЕРЕДАННЫЙ ТОКЕН НЕ СУЩЕСТВУЕТ ЛИБО НЕКОРРЕКТЕН.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
UPDATEPASSWORD
Обновление пароля
Используется для обновления пароля.
Сервер должен идентифицировать пользователя по переданному токену. Значение
токена будет подставляться в заголовок Authorization в формате Bearer {token}.
Важно: после успешного обновления пароля ранее выписанные токены должны быть
деактивированы. Как только сервер вернет успешный ответ на данный запрос,
пользователь не сможет совершить какие-либо операции с ранее созданными токенами
(запросы со старыми токенами должны получать соответствующий ошибочный статус
код).
/me/updatePassword
USAGE AND SDK SAMPLES
* Curl
* Java
* Android
* Obj-C
* JavaScript
* C#
* PHP
* Perl
* Python
curl -X POST\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost:8080/api/me/updatePassword"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
DefaultApi apiInstance = new DefaultApi();
Me_updatePassword_body body = ; // Me_updatePassword_body | В теле запроса передается старый и новый пароли. Пароль может быть обновлен только в случае передачи правильного значения старого пароля.
try {
inline_response_200_1 result = apiInstance.updatePassword(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#updatePassword");
e.printStackTrace();
}
}
}
import io.swagger.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
Me_updatePassword_body body = ; // Me_updatePassword_body | В теле запроса передается старый и новый пароли. Пароль может быть обновлен только в случае передачи правильного значения старого пароля.
try {
inline_response_200_1 result = apiInstance.updatePassword(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#updatePassword");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
Me_updatePassword_body *body = ; // В теле запроса передается старый и новый пароли. Пароль может быть обновлен только в случае передачи правильного значения старого пароля.
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Обновление пароля
[apiInstance updatePasswordWith:body
completionHandler: ^(inline_response_200_1 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var PulseApi = require('pulse_api');
var defaultClient = PulseApi.ApiClient.instance;
var api = new PulseApi.DefaultApi()
var body = ; // {{Me_updatePassword_body}} В теле запроса передается старый и новый пароли. Пароль может быть обновлен только в случае передачи правильного значения старого пароля.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.updatePassword(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class updatePasswordExample
{
public void main()
{
var apiInstance = new DefaultApi();
var body = new Me_updatePassword_body(); // Me_updatePassword_body | В теле запроса передается старый и новый пароли. Пароль может быть обновлен только в случае передачи правильного значения старого пароля.
try
{
// Обновление пароля
inline_response_200_1 result = apiInstance.updatePassword(body);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.updatePassword: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiDefaultApi();
$body = ; // Me_updatePassword_body | В теле запроса передается старый и новый пароли. Пароль может быть обновлен только в случае передачи правильного значения старого пароля.
try {
$result = $api_instance->updatePassword($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->updatePassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;
my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $body = WWW::SwaggerClient::Object::Me_updatePassword_body->new(); # Me_updatePassword_body | В теле запроса передается старый и новый пароли. Пароль может быть обновлен только в случае передачи правильного значения старого пароля.
eval {
my $result = $api_instance->updatePassword(body => $body);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->updatePassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.DefaultApi()
body = # Me_updatePassword_body | В теле запроса передается старый и новый пароли. Пароль может быть обновлен только в случае передачи правильного значения старого пароля.
try:
# Обновление пароля
api_response = api_instance.update_password(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->updatePassword: %s\n" % e)
PARAMETERS
Body parameters
Name Description body *
{
Required: newPassword,oldPassword
oldPassword:
string minLength:6 maxLength:100
Пароль пользователя, к которому предъявляются следующие требования:
* Длина пароля не менее 6 символов.
* Присутствуют латинские символы в нижнем и верхнем регистре.
* Присутствует минимум одна цифра.
example: $aba4821FWfew01#.fewA$
newPassword:
string minLength:6 maxLength:100
Пароль пользователя, к которому предъявляются следующие требования:
* Длина пароля не менее 6 символов.
* Присутствуют латинские символы в нижнем и верхнем регистре.
* Присутствует минимум одна цифра.
example: $aba4821FWfew01#.fewA$
}
RESPONSES
STATUS: 200 - ПАРОЛЬ УСПЕШНО ОБНОВЛЕН И РАНЕЕ ВЫПУЩЕННЫЕ ТОКЕНЫ ОТОЗВАНЫ.
* Schema
{
Required: status
status:
string
Должно принимать значение ok.
example: ok
}
STATUS: 400 - НОВЫЙ ПАРОЛЬ НЕ СООТВЕТСТВУЕТ ТРЕБОВАНИЯМ БЕЗОПАСНОСТИ.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
STATUS: 401 - ПЕРЕДАННЫЙ ТОКЕН НЕ СУЩЕСТВУЕТ ЛИБО НЕКОРРЕКТЕН.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
STATUS: 403 - УКАЗАННЫЙ ПАРОЛЬ НЕ СОВПАДАЕТ С ДЕЙСТВИТЕЛЬНЫМ.
* Schema
{
Используется для возвращения ошибки пользователю
Required: reason
reason:
string minLength:5
Описание ошибки в свободной форме
}
example: [object Object]
--------------------------------------------------------------------------------
Suggestions, contact, support and error reporting;
Information URL: https://helloreverb.com
Contact Info: hello@helloreverb.com
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html