{"openapi":"3.0.0","info":{"description":"","version":"1.0.0","title":"2gis-test","contact":{"email":"zfirewolfz@yandex.ru"}},"servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/walkerus/2gis-test/1.0.0"}],"paths":{"/firms/{firm_id}":{"get":{"tags":["firm"],"summary":"Get firm by firm id","operationId":"getFirmById","parameters":[{"name":"firm_id","in":"path","description":"The id that needs to be fetched.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Firm"}}}}}},"404":{"description":"Firm not found"}}}},"/firms/building/{building_id}":{"get":{"tags":["firm"],"summary":"Get firms by building id","operationId":"getFirmByBuildingId","parameters":[{"name":"building_id","in":"path","description":"Id of the building where the firms are located.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Firm"}}}}}}},"404":{"description":"Building not found"}}}},"/firms/rubric/{rubric_id}":{"get":{"tags":["firm"],"summary":"Get firms by rubric and rubric's children.","operationId":"getFirmByRubricId","parameters":[{"name":"rubric_id","in":"path","description":"Id of the rubric where the firms are located.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Firm"}}}}}}},"404":{"description":"Rubric not found"}}}},"/firms/radius":{"get":{"tags":["firm"],"summary":"Get firms in radius.","operationId":"getFirmByRadius","parameters":[{"name":"page","in":"query","description":"Number of page.","required":false,"schema":{"type":"integer"}},{"name":"radius","in":"query","description":"Map Search Radius in meters.","required":true,"schema":{"type":"integer"}},{"name":"latitude","in":"query","description":"Latitude of the center of the search circle (degrees).","example":55.555,"required":true,"schema":{"type":"number"}},{"name":"longitude","in":"query","description":"Longitude of the center of the search circle (degrees).","example":86.555,"required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/Links"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Firm"}}}}}}},"422":{"description":"validation params error"}}}},"/buildings":{"get":{"tags":["building"],"summary":"Get list of buildings.","operationId":"getBuildings","parameters":[{"name":"page","in":"query","description":"Number of page.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/Links"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Building"}}}}}}}}}}},"externalDocs":{"description":"Find out more about Swagger","url":"http://swagger.io"},"components":{"schemas":{"Firm":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string","example":"firms"},"attributes":{"type":"object","properties":{"name":{"type":"string"},"phones":{"type":"array","example":["123-123","321-321"],"items":{"type":"string"}}}},"relationships":{"type":"object","properties":{"building":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BuildingBase"}}},"rubrics":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RubricBase"}}}}}}}},"Building":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string","example":"buildings"},"attributes":{"type":"object","properties":{"address":{"type":"string","example":"Васильева 20А"},"latitude":{"type":"number","description":"geo latitude between -90 and 90"},"longitude":{"type":"number","description":"geo longitude between -180 and 180"}}},"relationships":{"type":"object","properties":{"firms":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FirmBase"}}}}}}}},"BuildingBase":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string","example":"buildings"}}},"RubricBase":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string","example":"rubrics"}}},"FirmBase":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string","example":"firms"}}},"Links":{"type":"object","properties":{"self":{"type":"string","example":"http://wsl/api/v1/firms/1"},"last":{"type":"string","example":"http://wsl/api/v1/firms/10"}}}}}}