forked from ebhomengo/niki
393 lines
12 KiB
JSON
393 lines
12 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"contact": {}
|
|
},
|
|
"paths": {
|
|
"/address/": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"AuthBearer": []
|
|
}
|
|
],
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"benefactor"
|
|
],
|
|
"summary": "Add Address benefactor",
|
|
"parameters": [
|
|
{
|
|
"description": "Add Address benefactor",
|
|
"name": "Request",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/addressparam.BenefactorAddAddressRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/addressparam.BenefactorAddAddressResponse"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad request",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/address/cities": {
|
|
"get": {
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"benefactor"
|
|
],
|
|
"summary": "get all cities",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/addressparam.GetAllCitiesResponse"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad request",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/address/provinces": {
|
|
"get": {
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"benefactor"
|
|
],
|
|
"summary": "get all provinces",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/addressparam.GetAllProvincesResponse"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad request",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/benefactor/login-register": {
|
|
"post": {
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"benefactor"
|
|
],
|
|
"summary": "login Or Register benefactor",
|
|
"parameters": [
|
|
{
|
|
"description": "login Or Register benefactor",
|
|
"name": "Request",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/benefactoreparam.LoginOrRegisterRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/benefactoreparam.LoginOrRegisterResponse"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad request",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/benefactor/send-otp": {
|
|
"post": {
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"benefactor"
|
|
],
|
|
"summary": "send otp benefactor",
|
|
"parameters": [
|
|
{
|
|
"description": "send otp benefactor",
|
|
"name": "Request",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/benefactoreparam.SendOtpRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/benefactoreparam.SendOtpResponse"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad request",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"addressparam.BenefactorAddAddressRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"address": {
|
|
"type": "string",
|
|
"example": "tehran"
|
|
},
|
|
"benefactor_id": {
|
|
"type": "integer",
|
|
"example": 1
|
|
},
|
|
"city_id": {
|
|
"type": "integer",
|
|
"example": 1
|
|
},
|
|
"lat": {
|
|
"type": "number",
|
|
"example": 22.23
|
|
},
|
|
"lon": {
|
|
"type": "number",
|
|
"example": 22.22
|
|
},
|
|
"postal_code": {
|
|
"type": "string",
|
|
"example": "1234567890"
|
|
},
|
|
"province_id": {
|
|
"type": "integer",
|
|
"example": 1
|
|
}
|
|
}
|
|
},
|
|
"addressparam.BenefactorAddAddressResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"address": {
|
|
"$ref": "#/definitions/entity.Address"
|
|
}
|
|
}
|
|
},
|
|
"addressparam.GetAllCitiesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"cities": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/entity.City"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"addressparam.GetAllProvincesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"provinces": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/entity.Province"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"benefactoreparam.BenefactroInfo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"first_name": {
|
|
"type": "string",
|
|
"example": "mehdi"
|
|
},
|
|
"id": {
|
|
"type": "integer",
|
|
"example": 1
|
|
},
|
|
"last_name": {
|
|
"type": "string",
|
|
"example": "rez"
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"example": "benefactor"
|
|
}
|
|
}
|
|
},
|
|
"benefactoreparam.LoginOrRegisterRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"phone_number": {
|
|
"type": "string",
|
|
"example": "09198829528"
|
|
},
|
|
"verification_code": {
|
|
"type": "string",
|
|
"example": "123456"
|
|
}
|
|
}
|
|
},
|
|
"benefactoreparam.LoginOrRegisterResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"benefactore_info": {
|
|
"$ref": "#/definitions/benefactoreparam.BenefactroInfo"
|
|
},
|
|
"tokens": {
|
|
"$ref": "#/definitions/benefactoreparam.Tokens"
|
|
}
|
|
}
|
|
},
|
|
"benefactoreparam.SendOtpRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"phone_number": {
|
|
"type": "string",
|
|
"example": "09198829528"
|
|
}
|
|
}
|
|
},
|
|
"benefactoreparam.SendOtpResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"description": "this just use in test .env\n\t\tTODO - remove it after test",
|
|
"type": "string"
|
|
},
|
|
"phone_number": {
|
|
"type": "string",
|
|
"example": "09198829528"
|
|
}
|
|
}
|
|
},
|
|
"benefactoreparam.Tokens": {
|
|
"type": "object",
|
|
"properties": {
|
|
"access_token": {
|
|
"type": "string"
|
|
},
|
|
"refresh_token": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"entity.Address": {
|
|
"type": "object",
|
|
"properties": {
|
|
"address": {
|
|
"type": "string"
|
|
},
|
|
"benefactorID": {
|
|
"type": "integer"
|
|
},
|
|
"cityID": {
|
|
"type": "integer"
|
|
},
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"isMain": {
|
|
"type": "boolean"
|
|
},
|
|
"lat": {
|
|
"type": "number"
|
|
},
|
|
"lon": {
|
|
"type": "number"
|
|
},
|
|
"postalCode": {
|
|
"type": "string"
|
|
},
|
|
"provinceID": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"entity.City": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"provinceID": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"entity.Province": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"securityDefinitions": {
|
|
"AuthBearer": {
|
|
"type": "apiKey",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
}
|
|
}
|
|
} |