birzha-legalizasia/storage/api-docs/api-docs.json

1906 lines
72 KiB
JSON
Raw Normal View History

2022-06-27 06:32:28 +00:00
{
"openapi": "3.0.0",
"info": {
"title": "Legalization API",
2022-07-08 09:40:16 +00:00
"version": "1.0.0"
2022-06-27 06:32:28 +00:00
},
"paths": {
2022-07-14 12:26:35 +00:00
"/api/account": {
"get": {
"tags": [
"Account"
],
"summary": " - Get client account",
2022-08-02 10:12:09 +00:00
"operationId": "e809af65c12695106f3cbcf67011e1c1",
2022-07-14 12:26:35 +00:00
"responses": {
"200": {
2022-08-10 06:03:35 +00:00
"description": "OK",
"content": {
"application/json":{
"schema":{
2022-08-11 08:31:35 +00:00
"type": "object",
"example": {
"data": {
2022-08-22 07:48:27 +00:00
"bank_account": {
"account_number": "4785963214785",
"account_date": "2022-10-10 11:41:02",
"currency": "USD",
"iban": "TTMK",
"bank_name": "Turkish Bank",
"country": "Brazil"
},
"contacts": {
"address": "Gami city",
"phone": "+99365555555",
"email": "johndoe@gmail.com"
},
2022-08-11 08:31:35 +00:00
"account_type": "business",
2022-09-12 10:03:36 +00:00
"country": "Turkmenistan",
2022-09-12 09:03:54 +00:00
"profile": null,
"legal_number": null,
"legal_expires_at": null,
"legal_can_apply": true,
"legal_can_extend": false,
"application_status": null
2022-08-11 08:31:35 +00:00
}
}
2022-08-10 06:03:35 +00:00
}
}
}
2022-07-14 12:26:35 +00:00
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/api/account/contacts": {
"put": {
"tags": [
"Account"
],
"summary": " - Store account contacts",
"operationId": "e809af65c12695106f3cbcf67011e145",
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"address": {
"type": "string"
},
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"fax": {
"type": "string"
}
},
"type": "object",
"example": {
"address": "Gami city",
"phone": "+99365555555",
"email": "johndoe@gmail.com",
"fax": "+99312454545"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
2022-08-22 08:36:11 +00:00
"type": "object",
"example": {
"data": {
"address": "Gami city",
"phone": "+99365555555",
"email": "johndoe@gmail.com",
"fax": "+99365555555"
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/api/account/bank": {
"put": {
"tags": [
"Account"
],
"summary": " - Store account bank info",
"operationId": "e809af65c12695106f3cbcf67011embgt",
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"account_number": {
"type": "string"
},
"account_date": {
"type": "string"
},
"currency": {
"type": "string"
},
"iban": {
"type": "string"
},
"bank_name": {
"type": "string"
},
"country": {
"type": "string"
}
},
"type": "object",
"example": {
"account_number": "4785963214785",
"account_date": "2022-10-10 11:41:02",
"currency": "USD",
"iban": "TTMK",
"bank_name": "Turkish Bank",
2022-08-22 08:36:11 +00:00
"country": "Brazil"
}
}
}
}
},
"responses": {
2022-08-08 06:26:01 +00:00
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
2022-08-22 08:36:11 +00:00
"type": "object",
"example": {
"data": {
"account_number": "4785963214785",
"account_date": "2022-10-10 11:41:02",
"currency": "USD",
"iban": "TTMK",
"bank_name": "Turkish Bank",
"country": "Brazil"
}
}
2022-08-08 06:26:01 +00:00
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
2022-08-22 09:02:31 +00:00
"/api/account/profile/#business": {
2022-08-08 06:26:01 +00:00
"put": {
"tags": [
"Account"
],
2022-08-22 09:02:31 +00:00
"summary": " - Store account profile info for business",
"operationId": "p809af65c12695106f3cbcf67011embgt",
2022-08-08 06:26:01 +00:00
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"account_type": {
"type": "string"
},
"name": {
"type": "string"
},
"surname": {
"type": "string"
},
"patronomic_name": {
"type": "string"
},
"date_of_birth": {
2022-08-22 09:02:31 +00:00
"type": "date"
2022-08-08 06:26:01 +00:00
},
"birth_place": {
"type": "string"
},
"citizenship_id": {
"type": "string"
},
"registration_address": {
"type": "string"
}
},
"type": "object",
"example": {
"account_type": "business",
"name": "John",
"surname": "Doe",
"patronomic_name": "Muhammedovich",
2022-09-14 11:00:52 +00:00
"date_of_birth": "2001-01-20",
2022-08-08 06:26:01 +00:00
"birth_place": "Ashgabat",
2022-08-30 06:05:39 +00:00
"citizenship_id": 2,
2022-08-08 06:26:01 +00:00
"registration_address": "Ashgabat"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
2022-08-22 09:02:31 +00:00
"/api/account/profile/#company": {
2022-08-08 06:26:01 +00:00
"put": {
"tags": [
"Account"
],
2022-08-22 09:02:31 +00:00
"summary": " - Store account profile info for company",
"operationId": "c809af65c12695106f3cbcf67011embgt",
2022-08-08 06:26:01 +00:00
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
2022-08-22 09:02:31 +00:00
"name": {"type": "string"},
"short_name": {"type": "string"},
"registration_number": {"type": "string"},
"registration_date": {"type": "string"},
"state_registration_agency": {"type": "string"},
"registration_place": {"type": "string"},
2022-09-02 13:12:45 +00:00
"registration_address": {"type": "string"}
2022-08-22 09:02:31 +00:00
2022-08-08 06:26:01 +00:00
},
"type": "object",
"example": {
2022-08-22 09:02:31 +00:00
"name": "Tapylgysyz mahabat",
"short_name":"TPS",
"registration_number": "132321",
2022-09-14 11:00:52 +00:00
"registration_date":"2001-01-20",
2022-08-22 09:02:31 +00:00
"state_registration_agency": "Agcy bilmeyanem",
"registration_place":"Shatauz",
"registration_address": "Yubileyni Under Radar"
2022-08-08 06:26:01 +00:00
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
2022-10-04 10:43:32 +00:00
"/api/account/clients": {
"get": {
"tags": [
"Account"
],
"summary": " - Get account clients",
"operationId": "e809af65c12695106f3cbcf67011e2c2",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json":{
"schema":{
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/api/account/add-client": {
"post": {
"tags": [
"Account"
],
"summary": " - Add account user",
"operationId": "a718f172ff3ac464d723835815f8fb77",
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"email": {
"type": "string"
},
"password": {
"type": "string"
}
},
"type": "object",
"example": {
"firstname": "Mahri",
"lastname": "Ilmedova",
"email": "ilmedovamahri@gmail.com",
"password": 12345678,
}
}
}
}
},
"responses": {
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"token": {
"type": "string"
},
"client": {
"properties": {
"id": {
"type": "integer"
},
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"email": {
"type": "string"
},
"is_verified": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
2022-06-27 06:32:28 +00:00
"/api/login": {
"post": {
"tags": [
2022-06-30 14:55:51 +00:00
"Authorization"
2022-06-27 06:32:28 +00:00
],
"summary": " - Login user",
2022-08-02 10:12:09 +00:00
"operationId": "44212a9096e4b09358281e9ec8a0701d",
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
2022-06-27 06:32:28 +00:00
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string"
}
},
"type": "object",
"example": {
"email": "ilmedovamahri@gmail.com",
2022-06-30 14:55:51 +00:00
"password": 12345678
2022-06-27 06:32:28 +00:00
}
}
}
}
},
"responses": {
"200": {
2022-07-07 14:19:10 +00:00
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
2022-06-27 06:32:28 +00:00
},
"401": {
2022-07-07 14:19:10 +00:00
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
2022-06-27 06:32:28 +00:00
}
}
}
},
"/api/register": {
"post": {
"tags": [
2022-06-30 14:55:51 +00:00
"Authorization"
2022-06-27 06:32:28 +00:00
],
"summary": " - Register user",
2022-08-02 10:12:09 +00:00
"operationId": "a718f172ff3ac464d723835815f8fb57",
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
2022-06-27 06:32:28 +00:00
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"email": {
"type": "string"
},
"password": {
"type": "string"
},
"account_type": {
"type": "string"
},
"country": {
"type": "integer"
2022-06-27 06:32:28 +00:00
}
},
"type": "object",
"example": {
"firstname": "Mahri",
"lastname": "Ilmedova",
"email": "ilmedovamahri@gmail.com",
"password": 12345678,
"country": 1,
"account_type": "business"
2022-06-27 06:32:28 +00:00
}
}
}
}
},
"responses": {
2022-07-07 14:19:10 +00:00
"201": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"properties": {
"token": {
"type": "string"
},
"client": {
"properties": {
"id": {
"type": "integer"
},
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"email": {
"type": "string"
},
"is_verified": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
2022-06-30 14:55:51 +00:00
},
2022-07-07 14:19:10 +00:00
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
2022-06-30 14:55:51 +00:00
}
}
}
},
2022-07-06 13:37:51 +00:00
"/api/verify-email": {
"post": {
"tags": [
"Authorization"
],
"summary": " - Verify email of client",
2022-08-02 10:12:09 +00:00
"operationId": "af6cac9e8cbada96c437ae2bc707a3be",
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
2022-07-06 13:37:51 +00:00
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"email": {
"type": "string"
},
"token": {
"type": "string"
}
},
"type": "object",
"example": {
"email": "ilmedovamahri@gmail.com",
"token": "4515"
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Missing fields (email or token)"
},
"404": {
"description": "Client not found"
},
"401": {
"description": "Unauthorised. Tokens do not match"
}
}
}
},
2022-06-30 14:55:51 +00:00
"/api/client": {
"get": {
"tags": [
"Authorization"
],
"summary": " - Get user",
2022-08-02 10:12:09 +00:00
"operationId": "ca66439cda88a6db7126df9a2bcdab16",
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
2022-06-30 14:55:51 +00:00
"responses": {
"200": {
"description": "OK"
2022-06-27 06:32:28 +00:00
},
"401": {
"description": "Unauthorized"
}
2022-06-30 14:55:51 +00:00
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/api/logout": {
"post": {
"tags": [
"Authorization"
],
"summary": " - Logout user",
2022-08-02 10:12:09 +00:00
"operationId": "79854151e609bd20032aa5aa4d5a35c0",
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
2022-06-30 14:55:51 +00:00
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/api/forgot-password": {
"post": {
"tags": [
"Authorization"
],
"summary": " - Send a user password reset link",
2022-08-02 10:12:09 +00:00
"operationId": "0569c8517e57256a8097079796c64246",
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
2022-06-30 14:55:51 +00:00
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"email": {
"type": "string"
}
},
"type": "object",
"example": {
"email": "ilmedovamahri@gmail.com"
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
2022-06-27 06:32:28 +00:00
}
}
},
"/api/reset-password": {
"post": {
"tags": [
"Authorization"
],
"summary": " - Reset client password and enter new",
2022-08-02 10:12:09 +00:00
"operationId": "b7633b69dc4b52a11d4bf29165b57061",
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"email": {
"type": "string"
},
"token": {
"type": "string"
},
"password": {
"type": "string"
},
"confirm_password": {
"type": "string"
}
},
"type": "object",
"example": {
"email": "ilmedovamahri@gmail.com",
"token": "2546",
"password": "Hello001!",
"confirm_password": "Hello001!"
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
2022-07-08 09:40:16 +00:00
"/api/update-client": {
"post": {
"tags": [
"Authorization"
],
"summary": " - Update client account",
2022-07-08 10:21:04 +00:00
"description": "Every field is required, except password. Password field is optional",
2022-08-02 10:12:09 +00:00
"operationId": "46b65b60e64a23248dc5aa4062c5d21e",
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"password": {
"type": "string"
}
},
"type": "object",
"example": {
"firstname": "Mahri",
"lastname": "Ilmedova",
2022-07-08 09:40:16 +00:00
"password": "Hello001!"
}
}
}
}
},
"responses": {
2022-07-20 12:22:43 +00:00
"201": {
"description": "Successful created",
"content": {
"application/json": {
"schema": {}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
2022-07-14 11:22:39 +00:00
},
2022-07-14 12:22:10 +00:00
"/api/countries": {
2022-07-14 11:22:39 +00:00
"get": {
"tags": [
2022-08-02 10:12:09 +00:00
"Resources"
2022-07-14 11:22:39 +00:00
],
"summary": " - Get countries list",
2022-08-02 10:12:09 +00:00
"operationId": "564aa61702ec5a6b97507a0505ef1356",
2022-07-14 11:22:39 +00:00
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
2022-08-02 10:12:09 +00:00
},
2022-08-09 09:40:36 +00:00
"/api/categories": {
2022-08-02 10:12:09 +00:00
"get": {
"tags": [
2022-08-09 09:40:36 +00:00
"Resources"
2022-08-02 10:12:09 +00:00
],
2022-08-09 09:40:36 +00:00
"summary": " - Get categories list for ticketing questions",
"operationId": "564aa61702ec5a6b97507a0505ef1tgh",
2022-08-02 10:12:09 +00:00
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
2022-08-29 17:44:40 +00:00
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/faqs": {
"get": {
"tags": [
"Resources"
],
"summary": " - Get FAQs list",
"operationId": "564aa61702ec5a6b97507a0505ef1tghh",
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
2022-08-02 10:12:09 +00:00
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
2022-08-09 09:40:36 +00:00
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/ticket/my-tickets": {
"get": {
"tags": [
"Tickets"
],
"summary": " - Get client tickets",
"operationId": "3dfdd9308e24af6164e9a9235d383bbb",
"parameters": [
2022-08-02 10:12:09 +00:00
{
2022-08-09 09:40:36 +00:00
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
2022-08-02 10:12:09 +00:00
"schema": {
"type": "string"
2022-08-09 09:40:36 +00:00
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
2022-08-02 10:12:09 +00:00
}
}
],
"responses": {
"200": {
2022-08-12 05:34:45 +00:00
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
2022-08-02 10:12:09 +00:00
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
2022-08-09 09:40:36 +00:00
"/api/ticket/post-ticket": {
2022-08-02 10:12:09 +00:00
"post": {
"tags": [
"Tickets"
],
2022-08-09 09:40:36 +00:00
"summary": " - Create new ticket",
"operationId": "24acefdf33a7a299d4773103cb6626fe",
2022-08-02 10:12:09 +00:00
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
2022-08-09 09:40:36 +00:00
"title": {
2022-08-02 10:12:09 +00:00
"type": "string"
},
2022-08-09 09:40:36 +00:00
"content": {
"type": "string"
2022-08-02 10:12:09 +00:00
},
2022-08-09 09:40:36 +00:00
"category_id": {
2022-08-02 10:12:09 +00:00
"type": "integer"
}
},
"type": "object",
"example": {
"content": "ilmedovamahri@gmail.com",
2022-08-09 09:40:36 +00:00
"title": "hello",
"category_id": 1
2022-08-02 10:12:09 +00:00
}
}
}
}
},
"responses": {
"201": {
"description": "Successful created",
"content": {
"application/json": {
"schema": {}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
2022-08-09 09:40:36 +00:00
"/api/ticket/ticket-messages": {
2022-08-02 10:12:09 +00:00
"get": {
"tags": [
"Tickets"
],
2022-08-09 09:40:36 +00:00
"summary": " - Get ticket messages",
"operationId": "61f3e305598ff903e170894ab09ad61d",
2022-08-02 10:12:09 +00:00
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
2022-08-09 09:40:36 +00:00
},
{
"name": "ticket_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
2022-08-02 10:12:09 +00:00
}
],
"responses": {
"200": {
2022-08-12 05:34:45 +00:00
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
2022-08-02 10:12:09 +00:00
},
"401": {
"description": "Unauthorized"
}
},
"security": [
{
"bearerAuth": []
}
]
}
2022-08-02 12:31:56 +00:00
},
2022-08-09 09:40:36 +00:00
"/api/ticket/post-message": {
2022-08-02 12:31:56 +00:00
"post": {
"tags": [
"Tickets"
],
2022-08-09 09:40:36 +00:00
"summary": " - Post ticket message",
"operationId": "8eecfef93e99b11c97b37b69e3457f41",
2022-08-02 12:31:56 +00:00
"parameters": [
{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"content": {
"type": "string"
2022-08-09 09:40:36 +00:00
},
"ticket_id": {
"type": "integer"
2022-08-02 12:31:56 +00:00
}
},
"type": "object",
"example": {
"content": "ilmedovamahri@gmail.com",
2022-08-09 09:40:36 +00:00
"ticket_id": 2
2022-08-02 12:31:56 +00:00
}
}
}
}
},
"responses": {
"201": {
"description": "Successful created",
"content": {
"application/json": {
"schema": {}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
2022-09-02 13:12:45 +00:00
},
"/api/application": {
"get": {
"tags": ["Application"],
"summary": "Get accounts Legalization application",
"parameters": [{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security":[
{
"bearerAuth": []
}
]
}
},
"/api/application/new": {
"get": {
"tags": ["Application"],
"summary": "Create,make new Legalization application",
"parameters": [{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security":[
{
"bearerAuth": []
}
]
}
},
2022-09-15 07:54:32 +00:00
"/api/application/upload/{attachment_id}": {
2022-09-15 08:08:06 +00:00
"post": {
2022-09-02 13:12:45 +00:00
"tags": ["Application"],
"summary": "Upload document to application",
"parameters": [{
2022-09-15 07:54:32 +00:00
"name": "attachment_id",
"in": "path",
2022-09-15 08:08:06 +00:00
"description": "Attachment id",
2022-09-15 07:54:32 +00:00
"required": true,
"schema": {
"type": "integer"
}
2022-09-02 13:12:45 +00:00
}],
2022-09-14 13:01:26 +00:00
"requestBody": {
"content": {
2022-09-15 07:03:52 +00:00
"multipart/form-data:": {
2022-09-14 13:01:26 +00:00
"schema": {
"properties": {
"file": {
2022-09-15 06:36:44 +00:00
"type": "string",
2022-09-15 08:03:18 +00:00
"format": "binary",
"required": true
2022-09-14 13:01:26 +00:00
}
},
2022-09-15 07:03:52 +00:00
"type": "object"
2022-09-14 13:01:26 +00:00
}
}
}
},
2022-09-02 13:12:45 +00:00
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security":[
{
"bearerAuth": []
}
]
}
},
"/api/application/apply": {
2022-09-19 07:13:07 +00:00
"post": {
2022-09-02 13:12:45 +00:00
"tags": ["Application"],
"summary": "Commit,apply application. send to review ",
"parameters": [{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
2022-09-14 12:13:41 +00:00
"type": "object",
"example": {
"data": {
"attachment_id": 1,
"attachment_name": "Pasport Kopia",
"attachment_size": "10",
"attachment_file_type": "pdf",
"attachment_file_path": "/storage/mtorage/gdeto/tam",
"document_name": "Pasport Kopia",
"document_description": "Pasport kopialay",
"document_max_size": "10"
}
}
2022-09-02 13:12:45 +00:00
}
}
}
},
"401": {
"description": "Unauthorized"
}
},
"security":[
{
"bearerAuth": []
}
]
}
2022-09-29 07:44:58 +00:00
},
"/api/application/oprosnik": {
"get": {
2022-09-29 08:41:36 +00:00
"tags": ["Application"],
2022-09-29 07:44:58 +00:00
"summary": "Download oprosnik",
"parameters": [{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}],
"security":[
{
"bearerAuth": []
}
]
}
2022-10-07 10:57:32 +00:00
},
"api/contract": {
"post": {
"tags": ["Contract"],
"summary": "Contract monitoring",
"parameters": [{
"name": "X-Localization",
"in": "header",
"description": "Localization",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"ru": {
"summary": "Russian localization",
"value": "ru"
},
"en": {
"summary": "English localization",
"value": "en"
},
"tm": {
"summary": "Turkmen localization",
"value": "tm"
}
}
}],
"security":[
{
"bearerAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"number": {
"type": "string"
}
},
"type": "object",
"example": {
"number": "123321"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
2022-06-27 06:32:28 +00:00
}
2022-06-30 14:55:51 +00:00
},
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"name": "bearerAuth",
"in": "header",
"bearerFormat": "JWT",
"scheme": "bearer"
}
}
2022-06-27 06:32:28 +00:00
}
}