Skip to content

Commit

Permalink
new Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
0xBLCKLPTN committed Sep 28, 2024
1 parent e36f1f1 commit 0173b32
Show file tree
Hide file tree
Showing 7 changed files with 355 additions and 0 deletions.
36 changes: 36 additions & 0 deletions Docs/screenshots/AboutProject.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Docs/screenshots/Architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 40 additions & 0 deletions Docs/screenshots/Important.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Docs/screenshots/SimplyArchitecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions Docs/screenshots/WhyRust.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
253 changes: 253 additions & 0 deletions Docs/screenshots/postman_schemas/postman_beta-1.1.0.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,253 @@
{
"info": {
"_postman_id": "0fad209d-b96c-4173-83ab-a0ff9cb0f19e",
"name": "Kingdom-System",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Public Requests",
"item": [
{
"name": "Authenticate",
"item": [
{
"name": "Authorize in system",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"username\": \"root\",\n \"password\": \"pwd\"\n}\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "http://127.0.0.1:5800/auth/login",
"protocol": "http",
"host": [
"127",
"0",
"0",
"1"
],
"port": "5800",
"path": [
"auth",
"login"
]
}
},
"response": []
},
{
"name": "Register in system",
"request": {
"method": "GET",
"header": []
},
"response": []
}
]
},
{
"name": "Get all teachers request",
"request": {
"method": "GET",
"header": []
},
"response": []
},
{
"name": "Get Teacher By",
"request": {
"method": "GET",
"header": []
},
"response": []
},
{
"name": "Health Check",
"request": {
"method": "GET",
"header": []
},
"response": []
},
{
"name": "Get groups",
"request": {
"method": "GET",
"header": []
},
"response": []
},
{
"name": "Get lessons",
"request": {
"method": "GET",
"header": []
},
"response": []
},
{
"name": "get schedules",
"request": {
"method": "GET",
"header": []
},
"response": []
}
]
},
{
"name": "Operator Requests",
"item": [
{
"name": "Control Teachers",
"item": [
{
"name": "Set new teacher",
"request": {
"method": "GET",
"header": []
},
"response": []
},
{
"name": "Edit Teacher",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"firstName\": \"Daniil\",\n \"middleName\": \"None\",\n \"lastName\": \"Ermolaev\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "http://127.0.0.1:5800/api/operator/edit-teacher?jwt_token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmFtZSI6InJvb3QiLCJleHAiOjE2ODUwMDExOTZ9.r35FPd0Fn6GO9B22lMQ82f-fwkvEZtCfQ1T4XOWseuc&teacher-id=sdf",
"protocol": "http",
"host": [
"127",
"0",
"0",
"1"
],
"port": "5800",
"path": [
"api",
"operator",
"edit-teacher"
],
"query": [
{
"key": "jwt_token",
"value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmFtZSI6InJvb3QiLCJleHAiOjE2ODUwMDExOTZ9.r35FPd0Fn6GO9B22lMQ82f-fwkvEZtCfQ1T4XOWseuc"
},
{
"key": "teacher-id",
"value": "sdf"
}
]
}
},
"response": []
}
]
},
{
"name": "Group",
"item": [
{
"name": "Add new group",
"request": {
"method": "GET",
"header": []
},
"response": []
}
]
},
{
"name": "Change role by id",
"request": {
"method": "GET",
"header": []
},
"response": []
},
{
"name": "add lesson",
"request": {
"method": "GET",
"header": []
},
"response": []
},
{
"name": "add_schedule",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"group_id\": \"qweqweqwe\",\n \"date\": \"12.01.23\",\n \"lessons\": [\n {\n \"lesson_number\": 1,\n \"teacher_id\": \"werwerwerwer123fsdf23\",\n \"lesson_name\": \"Оркестрация контейнеров\"\n },\n {\n \"lesson_number\": 2,\n \"teacher_id\": \"werwerwerwer123fsdf23\",\n \"lesson_name\": \"Оркестрация контейнеров\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "http://127.0.0.1:5800/api/operator/schedule-management/add-schedule?jwt_token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmFtZSI6InJvb3QiLCJleHAiOjE2ODU4Mjc3MzJ9.iau4Z8BfUmIYkW_TCMEmcA36Ewqfp5Ivg_Bb_y9sihg",
"protocol": "http",
"host": [
"127",
"0",
"0",
"1"
],
"port": "5800",
"path": [
"api",
"operator",
"schedule-management",
"add-schedule"
],
"query": [
{
"key": "jwt_token",
"value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmFtZSI6InJvb3QiLCJleHAiOjE2ODU4Mjc3MzJ9.iau4Z8BfUmIYkW_TCMEmcA36Ewqfp5Ivg_Bb_y9sihg"
}
]
}
},
"response": []
}
]
},
{
"name": "Debug Requests",
"item": [
{
"name": "Get all users",
"request": {
"method": "GET",
"header": []
},
"response": []
}
]
}
]
}%
Binary file added Docs/screenshots/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0173b32

Please sign in to comment.