Mini Shell
Mini Shell
| Direktori : /var/www/html/shaban/duassis/api/storage/api-docs/ |
| Current File : //var/www/html/shaban/duassis/api/storage/api-docs/api-docs.json |
{
"openapi": "3.0.0",
"info": {
"title": "DuAssis",
"description": "DuAssis API description",
"contact": {
"email": "shaban.ramadani@hotmail.com"
},
"version": "1.0.0"
},
"paths": {
"/api/v1/users": {
"get": {
"tags": [
"Users"
],
"summary": "Get list of users",
"description": "Returns list of users",
"operationId": "getUsersList",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "Bad request"
}
},
"security": [
{
"api_key_security_example": []
}
]
},
"post": {
"tags": [
"Users"
],
"summary": "Create user",
"description": "Returns 200",
"operationId": "createUser",
"parameters": [
{
"name": "display_name",
"in": "query",
"description": "User Diplay Name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "email",
"in": "query",
"description": "User email",
"required": true,
"schema": {
"type": "email"
}
},
{
"name": "password",
"in": "query",
"description": "User password",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "password_confirmation",
"in": "query",
"description": "User password confirmation",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"oauth2_security_example": [
"write:users",
"read:users"
]
}
]
}
},
"/api/v1/users/{id}": {
"get": {
"tags": [
"Users"
],
"summary": "Get user information",
"description": "Returns user data",
"operationId": "getUserById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "User id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"oauth2_security_example": [
"write:users",
"read:users"
]
}
]
},
"put": {
"tags": [
"Users"
],
"summary": "Update user information",
"description": "Returns 200",
"operationId": "updateUserById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "User id",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "display_name",
"in": "query",
"description": "User Display Name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"oauth2_security_example": [
"write:users",
"read:users"
]
}
]
},
"delete": {
"tags": [
"Users"
],
"summary": "Delete user",
"description": "Returns 204",
"operationId": "deleteUserById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "User id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "successful operation"
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"oauth2_security_example": [
"write:users",
"read:users"
]
}
]
}
},
"/api/v1/users/{id}/actions/enable": {
"post": {
"tags": [
"Users"
],
"summary": "Enable user",
"description": "Returns 200",
"operationId": "enableUserById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "User id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"oauth2_security_example": [
"write:users",
"read:users"
]
}
]
}
},
"/api/v1/users/{id}/actions/disable": {
"delete": {
"tags": [
"Users"
],
"summary": "Disable user",
"description": "Returns 200",
"operationId": "disableUserById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "User id",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
}
},
"security": [
{
"oauth2_security_example": [
"write:users",
"read:users"
]
}
]
}
},
"/api/v1/changePassword": {
"post": {
"tags": [
"Users"
],
"summary": "Change logged in user's password",
"description": "Returns user",
"operationId": "changeLoggedInUserPassword",
"parameters": [
{
"name": "password",
"in": "query",
"description": "User password",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "password_confirmation",
"in": "query",
"description": "User password confirmation",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "Bad request"
}
},
"security": [
{
"api_key_security_example": []
}
]
}
},
"/api/v1/users/actions/getRoles": {
"get": {
"tags": [
"Users"
],
"summary": "Get list of users",
"description": "Returns list of users",
"operationId": "getUsersList",
"responses": {
"200": {
"description": "successful operation"
},
"400": {
"description": "Bad request"
}
},
"security": [
{
"api_key_security_example": []
}
]
}
}
}
}