{"openapi":"3.0.0","servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/ZOLKINAN/1WAY/1.0.0"},{"description":"Dev server","url":"https://back1.1way.market/board/hs/v1"}],"info":{"version":"1.0.0","title":"1WAY-api","description":"The API for 1way.market"},"tags":[{"name":"Валюты"},{"name":"Языки"},{"name":"Перечисления"},{"name":"Категории"},{"name":"Объявления"},{"name":"Картинки"},{"name":"Пользователи"},{"name":"Сообщения"}],"paths":{"/currency":{"get":{"tags":["Валюты"],"summary":"получение списка всех валют","operationId":"getCurrency","responses":{"200":{"description":"Валюты найдены","content":{"application/json":{"schema":{"$ref":"#/components/schemas/currency"}}}},"501":{"description":"не найдена валюта"}}}},"/getExchangeRates":{"get":{"tags":["Валюты"],"summary":"получение курсов валют на сегодня","operationId":"getExchangeRates","responses":{"200":{"description":"Валюты найдены","content":{"application/json":{"schema":{"$ref":"#/components/schemas/currencyExchangeRates"}}}},"404":{"description":"Not Found"}}}},"/langs":{"get":{"tags":["Языки"],"summary":"получение списка всех языков","operationId":"getLangs","responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/langs"}}}},"501":{"description":"не найден язык"}}}},"/categories":{"get":{"tags":["Категории"],"summary":"получение списка всех категорий","operationId":"getCategories","responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/categories"}}}},"501":{"description":"не найдены категории"}}}},"/category/{category_id}":{"get":{"tags":["Категории"],"summary":"получение категории по идентификатору","operationId":"getCategoryByID","parameters":[{"name":"category_id","in":"path","required":true,"description":"идентификатор категории","schema":{"type":"string"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/categories"}}}},"404":{"description":"категория не найдена"}}}},"/img/{img_id}":{"get":{"tags":["Картинки"],"summary":"получение картинки по идентификатору","description":"возвращает двоичные данные картинки","operationId":"getImgByID","parameters":[{"name":"img_id","in":"path","required":true,"description":"идентификатор картинки","schema":{"type":"string"}}],"responses":{"200":{"description":"ok","content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"картинка не найдена"}}}},"/img_low/{img_id}":{"get":{"tags":["Картинки"],"summary":"получение маленькой картинки по идентификатору","description":"возвращает двоичные данные маленькой картинки","operationId":"getImgLowByID","parameters":[{"name":"img_id","in":"path","required":true,"description":"идентификатор картинки","schema":{"type":"string"}}],"responses":{"200":{"description":"ok","content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"картинка не найдена"}}}},"/img":{"post":{"tags":["Картинки"],"summary":"добавление картинки","operationId":"postImg","requestBody":{"required":true,"description":"информация о картинке","content":{"application/json":{"schema":{"$ref":"#/components/schemas/img"}}}},"responses":{"200":{"description":"ok","content":{"text/plain":{"schema":{"type":"string","description":"возвращает гуид разрешения для использования в методе put","example":"bnhgddiuytrewqop12poi"}}}},"500":{"description":"Ошибка при вызове метода контекста"},"501":{"description":"Не достаточно прав на выполнение запроса"}}},"patch":{"tags":["Картинки"],"summary":"проверка существования картинки","operationId":"getIDImg","requestBody":{"required":true,"description":"url картинки","content":{"text/plain":{"schema":{"type":"string","example":"https://back1.1way.market/board/hs/v1/img/1428057"}}}},"responses":{"200":{"description":"ok","content":{"text/plain":{"schema":{"description":"возвращает идентификатор картинки","example":1428057}}}},"404":{"description":"картинка не найдена"},"405":{"description":"метод не допустим"},"500":{"description":"Ошибка при вызове метода контекста"},"501":{"description":"Не достаточно прав на выполнение запроса"}}}},"/img/{permission_id}":{"put":{"tags":["Картинки"],"summary":"загружает двоичные данные картинки","operationId":"putImg","parameters":[{"name":"permission_id","in":"path","required":true,"description":"гуид разрешения из метода post","schema":{"type":"string","example":"bnhgddiuytrewqop12poi"}}],"requestBody":{"required":true,"description":"двоичные данные картинки","content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"ok","content":{"text/plain":{"schema":{"description":"возвращает идентификатор созданной картинки","example":1428057}}}},"400":{"description":"неверные параметры запроса"},"501":{"description":"Не достаточно прав на выполнение запроса"}}}},"/img/name_exis":{"post":{"tags":["Картинки"],"summary":"проверяет, что картинка с таким именем существует","operationId":"name_exis","requestBody":{"required":true,"description":"имя картинки","content":{"text/plain":{"schema":{"type":"string","example":"telega_12345_6789"}}}},"responses":{"200":{"description":"ok","content":{"text/plain":{"schema":{"description":"возвращает идентификатор картинки","example":1428057}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"description":"ошибка","example":{"Error":"not exis"}}}}},"501":{"description":"Не достаточно прав на выполнение запроса"}}}},"/user":{"post":{"tags":["Пользователи"],"summary":"создание нового пользователя","operationId":"postUser","requestBody":{"required":true,"description":"информация о пользователе","content":{"application/json":{"schema":{"$ref":"#/components/schemas/user"}}}},"responses":{"200":{"description":"ok"},"500":{"description":"Ошибка при вызове метода контекста"},"501":{"description":"Такой пользователь уже есть/При регистрации не было указано ни почты ни пароля"}}}},"/login":{"post":{"tags":["Пользователи"],"summary":"авторизация, получение постоянного ключа refresh token","operationId":"getToken","requestBody":{"required":true,"description":"информация о пользователе","content":{"application/json":{"schema":{"example":{"name":"Anna","passwordHex":"90c340c372f445e72c8396bb01cd4643fcd6c7e13"}}}}},"responses":{"200":{"description":"ok","content":{"text/plain":{"schema":{"type":"string","description":"постоянный ключ","example":"b31fb4e0-0dd5-4ccf-bc34-172d4e019054"}}}},"500":{"description":"Ошибка при вызове метода контекста"}}},"get":{"tags":["Пользователи"],"summary":"обновление временного ключа","operationId":"getTemnNewKey","responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"description":"новый временный ключ","example":{"key":"77026506-ba9a-4525-9fb8-559b4d25e9da","date":"2023-09-17T22:08:23"}}}}},"501":{"description":"Not Implemented"}}}},"/key":{"post":{"tags":["Пользователи"],"summary":"получение временного ключа accept token","operationId":"getTempKey","requestBody":{"required":true,"description":"постоянный ключ","content":{"text/plain":{"schema":{"type":"string","example":"b31fb4e0-0dd5-4ccf-bc34-172d4e019054"}}}},"responses":{"200":{"description":"ok","content":{"text/plain":{"schema":{"type":"string","description":"временный ключ","example":"9b0b89b1-67d9-484d-5cd3-72888dee0eae"}}}},"401":{"description":"Ключ или не существует или имеет не верный формат"},"500":{"description":"Ошибка при вызове"}}}},"/login_end":{"get":{"tags":["Пользователи"],"summary":"получение даты и времени окончания действия ключа","operationId":"getEndDate","responses":{"200":{"description":"ok","content":{"text/plain":{"schema":{"type":"string","description":"возвращает дату  и время, после которой ключ перестает действовать","example":"18.09.2023 15: 12: 26"}}}},"401":{"description":"Ключ или не существует или имеет не верный формат"},"501":{"description":"Ошибка (Not Implemented )/Ключ устарел"}}}},"/date":{"get":{"tags":["Пользователи"],"summary":"получение текущей даты и времени сервера","operationId":"getServDateTime","responses":{"200":{"description":"ok","content":{"text/plain":{"schema":{"type":"string","description":"возвращает дату и время сервера","example":"18.09.2023 15: 12: 26"}}}},"401":{"description":"Ключ или не существует или имеет не верный формат"},"501":{"description":"Ошибка (Not Implemented )"}}}},"/logout":{"get":{"tags":["Пользователи"],"summary":"выйти из аккаунта","description":"Удаляет все ключи пользователя, после чего пользователю, чтобы попасть обратно, нужно вводить пароль","operationId":"logoutAccaunt","responses":{"200":{"description":"ok"},"401":{"description":"Ключ или не существует или имеет не верный формат"},"501":{"description":"Ошибка (Not Implemented )"}}}},"/change_pas":{"post":{"tags":["Пользователи"],"summary":"изменение пароля","description":"меняет старый пароль на новый","operationId":"change_pas","requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"Anna","passwordHex_old":"qwerty123","passwordHex_new":"qwerty12345"}}}}},"responses":{"200":{"description":"ok"},"404":{"description":"not found"},"501":{"description":"Ошибка (Not Implemented )/Пользователь не найден"}}}},"/user_scan":{"post":{"tags":["Пользователи"],"summary":"проверка существования аккаунта пользователя","description":"можно отправить почту (mail), логин (name) или телефон (phone)","operationId":"user_scan","requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"Anna"}}}}},"responses":{"200":{"description":"ok","content":{"text/plain":{"schema":{"type":"boolean","description":"если совпадение - вернет true, иначе false.","example":"true"}}}},"404":{"description":"not found"},"501":{"description":"Ошибка (Not Implemented )/Пользователь не найден"}}}},"/verify_email/{key}":{"post":{"tags":["Пользователи"],"summary":"подтверждение почты","description":"на бэке по этому ключу создается пользователь","operationId":"verify_email","parameters":[{"name":"key","required":true,"in":"path","schema":{"type":"string","example":"bnhgddiuytrewqop12poi"}}],"responses":{"200":{"description":"ok"},"404":{"description":"not found"},"501":{"description":"Ошибка (Not Implemented )"}}}},"/msg_new":{"get":{"tags":["Сообщения"],"summary":"получение количества новых сообщений","operationId":"msg_new","responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"description":"new - количество новых не прочитанных авторизованных сообщений, all - количество новых не прочитанных всех сообщений (и от неавторизованных)","example":{"new":"5","all":"10"}}}}},"404":{"description":"not found"},"501":{"description":"Ошибка (Not Implemented )"}}}}},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"key"}},"schemas":{"currencyItem":{"description":"свойства валюты","type":"object","properties":{"id":{"type":"integer","description":"идентификатор валюты","example":826},"code":{"type":"string","description":"строковый код валюты","example":"GBP"},"title":{"type":"string","description":"наименование валюты","example":"Фунт"},"short":{"type":"string","description":"аббревиатура валюты","example":"£"},"img":{"type":"integer","description":"изображение валюты","example":391523}}},"currency":{"type":"array","items":{"$ref":"#/components/schemas/currencyItem"}},"currencyExchange":{"description":"курс обмена на сегодня","type":"object","properties":{"currency_orig":{"type":"integer","description":"ID валюты из которой переводим","example":840},"currency":{"type":"integer","description":"валюта в которую переводим","example":840},"value":{"type":"number","description":"коэффициент на который надо умножить","example":0.81}}},"currencyExchangeRates":{"type":"array","items":{"$ref":"#/components/schemas/currencyExchange"}},"lang":{"type":"object","properties":{"id":{"type":"integer","description":"идентификатор языка","example":2},"title":{"type":"string","description":"наименование языка","example":"EN"},"img":{"type":"integer","description":"изображение","example":172116}}},"langs":{"type":"array","items":{"$ref":"#/components/schemas/lang"}},"category":{"type":"object","properties":{"id":{"type":"integer","description":"идентификатор категории","example":174},"slug":{"type":"string","description":"уникальная строка идентификатор","example":"proigryvateli-blu-ray-i-dvd"},"title":{"type":"string","description":"наименование категории","example":"DVD Blu-Ray и медиаплееры"},"parentID":{"type":"integer","description":"идентификатор родительской категории","example":178}}},"categories":{"type":"array","items":{"$ref":"#/components/schemas/category"}},"property":{"type":"object","properties":{"id":{"type":"integer","description":"Код свойства","example":18},"title":{"type":"string","description":"наименование категории","example":"Процессор"},"value *":{"type":"string","description":"Текст значения свойства","example":"intel"},"value_ID *":{"type":"integer","description":"ID значения свойства, если знчение не примитив","example":13},"value_primitive *":{"type":"string","description":"Значение свойства если это примитив (строка/число)","example":17},"widget":{"type":"string","description":"имя класса виджета","example":"text_select"},"type":{"type":"string","description":"Тип свойства {string, bool, digital, data, period?, diapason?}","example":"string"},"parents":{"type":"array","description":"Внутри перечислены коды свойств родителей (если свойство можно выбрать только когда выбраны свойства указанных родителей)","items":{"type":"integer","example":1}}}},"img":{"type":"object","properties":{"id":{"type":"integer","description":"идентификатор картинки","example":1428057},"title":{"type":"string","description":"название картинки","example":"автомобиль"},"format":{"type":"string","description":"Расширение картинки","example":"jpg"},"tom":{"type":"integer","description":"ID тома (необязательно)","example":26}}},"message":{"type":"object","properties":{"dialog":{"type":"integer","description":"D диалога","example":142805},"sender":{"type":"integer","description":"Кто послал сообщение, 0 - сообщение системное, номер соответствует порядовому номеру участника диалога","example":0},"readers":{"type":"array","description":"Внутри перечислены id участников, кто прочитал сообщение","items":{"type":"integer","example":56}},"date":{"type":"string","format":"date-time","description":"Когда был послано сообщение","example":"2017-07-21T17:32:28Z"},"text":{"type":"string","description":"Текст сообщения","example":"Привет"}}},"user":{"type":"object","properties":{"id":{"type":"integer","description":"идентификатор пользователя","example":396},"name":{"type":"string","description":"Никнэйм","example":"Katie"},"show":{"type":"string","description":"Как пользователь хотел бы чтобы его видели другие","example":"agentlimassol"},"lang":{"type":"integer","description":"ID языка по умолчанию","example":2},"langs":{"type":"array","description":"внутри ID языка на котором говорит пользователь","items":{"type":"object","properties":{"id":{"type":"integer","example":2}}}},"currency":{"type":"integer","description":"ID валюты по умолчанию","example":826},"phone":{"type":"string","description":"телефон","example":"+90 (533) 821-8795"},"telegram":{"type":"string","description":"ссылка на телеграм","example":"@katie"},"whatsapp":{"type":"string","description":"ссылка на ватсап","example":"katie"},"mail":{"type":"string","description":"почта","example":"katie@gmail.com"},"passwordHex":{"type":"string","description":"Хеш пароля","example":"a278cbae11f77ad9c9dcaf2ab04c077c95b26f6d0a72c0f55ce553b67aec40e9"},"role_mail":{"type":"integer","description":"Отображать почту (1 - никому, 2 - только зарегистрированным, 3 - всем)","example":2},"role_phone":{"type":"integer","description":"Отображать телефон (1 - никому, 2 - только зарегистрированным, 3 - всем)","example":2},"role_telegram":{"type":"integer","description":"Отображать телеграм (1 - никому, 2 - только зарегистрированным, 3 - всем)","example":2},"role_whatsapp":{"type":"integer","description":"Отображать ватсап  (1 - никому, 2 - только зарегистрированным, 3 - всем)","example":2},"photo_url":{"type":"string","description":"Путь к картинке пользователя","example":"https://d2vho998xd1yud.cloudfront.net/property_wm/property/37/216703/1625648588-60e56dccc12f87.78289024.jpeg"}}}}}}