valitydev/damsel
14
0
Fork 0
mirror of https://github.com/valitydev/damsel.git synced 2024-11-06 01:35:19 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

[TD-192] Columbus proto refactored (#22)

Browse Source 
[TD-192] Columbus proto moved outside and refactored

Co-authored-by: PNV <pnv@empayre.com>
This commit is contained in:
Pospolita Nikita 2022-02-21 11:28:26 +03:00 committed by GitHub
parent b25d3365e1
commit 2c585080d2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
proto/geo_ip.thrift
View File

@ -1,21 +1,17 @@
include "base.thrift"
include "domain.thrift"
namespace java dev.vality.damsel.geo_ip
namespace erlang geo_ip
// moved to https://github.com/valitydev/columbus-proto
namespace java dev.vality.damsel.columbus
namespace erlang columbus
/**
* Идентификатор места по базе http://www.geonames.org/
**/
typedef i32 GeoID
/**
* GeoIsoCode - страна в формате ISO3166-1 Alpha 3
**/
typedef string GeoIsoCode
const GeoID GEO_ID_UNKNOWN = -1
const GeoIsoCode UNKNOWN = "UNKNOWN"
struct LocationInfo {
// GeoID города
@ -25,64 +21,4 @@ struct LocationInfo {
// Полное описание локации в json
// подробное описание на сайте https://www.maxmind.com/en/geoip2-city
3: optional string raw_response;
}
// Информация о регоине
struct SubdivisionInfo{
// глубина в иерархии. Чем ниже тем цифра выше. Например 1 - Московская область. 2 - Подольский район.
1: required i16 level
2: required string subdivision_name;
}
/**
* Информация о данном GeoID
**/
struct GeoIDInfo{
2: required string country_name;
3: optional set<SubdivisionInfo> subdivisions;
4: optional string city_name;
}
/**
* Интерфейс Geo Service для клиентов - "Columbus"
*/
service GeoIpService {
/**
* Возвращает информацию о предполагаемом местоположении по IP
* если IP некоректный то кидается InvalidRequest с этим IP
* если для IP не найдена страна или город то в LocationInfo, данное поле будет иметь значение GEO_ID_UNKNOWN
**/
LocationInfo GetLocation (1: domain.IPAddress ip) throws (1: base.InvalidRequest ex1)
/**
* то же что и GetLocation, но для списка IP адресов
**/
map <domain.IPAddress, LocationInfo> GetLocations (1: set <domain.IPAddress> ip) throws (1: base.InvalidRequest ex1)
/**
* Возвращает структуру с названием места на указанном языке
* geo_ids - список geo-id по которым нужно получить информацию.
* lang - язык ответа. Например: "RU", "ENG"
*
* если по данному geo-id нужная детализация не обнаружена, соответствующее поле в возвращаемой структуре останется не заполненным
* если в результате по данному geo-id не обнаружено никаких данных, он не попадает в возвращаемый результат
* если язык не поддерживается -> InvalidRequest
**/
map <GeoID, GeoIDInfo> GetLocationInfo (1: set<GeoID> geo_ids, 2: string lang) throws (1: base.InvalidRequest ex1)
/**
* Возвращает наименование географического объекта по указанному geoID.
* При передаче geoID страны - название страны
* При передаче geoID региона - название региона
* При передаче geoID города - название города
* и т.д.
* Если передан неизвестный geoID, он не попадет в возвращаемый результат
**/
map <GeoID, string> GetLocationName (1: set<GeoID> geo_ids, 2: string lang) throws (1: base.InvalidRequest ex1)
/**
* Возвращает iso code страны местоположения по IP
* если IP некоректный то кидается InvalidRequest с этим IP
* если для IP не найдена iso code будет равен UNKNOWN
**/
GeoIsoCode GetLocationIsoCode (1: domain.IPAddress ip) throws (1: base.InvalidRequest ex1)
}