Commit from GitHub Actions (Generate page docs)

github-actions[bot] · github-actions[bot] · commit 33a6714fce9f · 2024-07-03T00:04:02.000Z
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,31 @@
+
+    <!DOCTYPE html>
+    <html>
+    <head>
+    <link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.9.0/swagger-ui.css">
+    <link rel="shortcut icon" href="https://fastapi.tiangolo.com/img/favicon.png">
+    <title>FastAPI Template - Swagger UI</title>
+    </head>
+    <body>
+    <div id="swagger-ui">
+    </div>
+    <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.9.0/swagger-ui-bundle.js"></script>
+    <!-- `SwaggerUIBundle` is now available on the page -->
+    <script>
+    const ui = SwaggerUIBundle({
+        url: '/api/openapi.json',
+    "dom_id": "#swagger-ui",
+"layout": "BaseLayout",
+"deepLinking": true,
+"showExtensions": true,
+"showCommonExtensions": true,
+oauth2RedirectUrl: window.location.origin + '/api/docs/oauth2-redirect',
+    presets: [
+        SwaggerUIBundle.presets.apis,
+        SwaggerUIBundle.SwaggerUIStandalonePreset
+        ],
+    })
+    </script>
+    </body>
+    </html>
+    
diff --git a/docs/openapi.json b/docs/openapi.json
@@ -0,0 +1 @@
+{"openapi":"3.1.0","info":{"title":"FastAPI Template","description":"## Настройка\n\n#### Настройка происходит в файле .env его нет в репозитории, т.к. он конфиденциален, но я предоставил файл .env.dist создайте на его основе файл .env и проведите все необходимые настройки.\n\n## Установка зависимостей\n\n#### В основе проекта лежит пакетный менеджер poetry.\n\n`poetry install` - Вариант с использованием poetry.\n\n`pip install -r requirements.txt` - Вариант с использованием pip.\n\n\n## Документация по make командам\n\n`make help` - Команда help отображает список доступных команд и их описание.\n\n`make ref` - Команда ref используется для форматирования кода с помощью ruff и black.\n\n`make dev` - Команда dev запускает приложение в режиме разработки.\n\n`make req` - Команда req обновляет зависимости в [requirements.txt](requirements.txt)\n\n`make migrate` - Команда migrate применяет все ожидающие миграции к базе данных с помощью alembic.\n\n`make generate` - Команда generate используется для генерации новой миграции базы данных с помощью alembic.\n","contact":{"name":"Fast Code","url":"https://fast-code.pro/","email":"fast.code.auth@gmail.com"},"version":"1.0.0"},"servers":[{"url":"/api"}],"paths":{"/auth/email/registration":{"post":{"tags":["auth"],"summary":"Registration","description":"Create user","operationId":"registration_auth_email_registration_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/auth/email/token":{"post":{"tags":["auth"],"summary":"Token","description":"Retrieve new access token","operationId":"token_auth_email_token_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/":{"get":{"tags":["users"],"summary":"Retrieve","description":"Retrieve user","operationId":"retrieve_users__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRead"}}}}},"security":[{"APIKeyHeader":[]}]}}},"components":{"schemas":{"AccessToken":{"properties":{"token":{"type":"string","title":"Token","description":"Необходим для запросов к API, действует 24 часа."}},"type":"object","title":"AccessToken"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"UserCreate":{"properties":{"email":{"type":"string","title":"Email"},"password":{"type":"string","title":"Password"}},"type":"object","required":["email","password"],"title":"UserCreate"},"UserRead":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"email":{"type":"string","title":"Email"}},"type":"object","required":["email"],"title":"UserRead"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"access-token"}}}}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+{"openapi":"3.1.0","info":{"title":"FastAPI Template","description":"## Настройка\n\n#### Настройка происходит в файле .env его нет в репозитории, т.к. он конфиденциален, но я предоставил файл .env.dist создайте на его основе файл .env и проведите все необходимые настройки.\n\n## Установка зависимостей\n\n#### В основе проекта лежит пакетный менеджер poetry.\n\n`poetry install` - Вариант с использованием poetry.\n\n`pip install -r requirements.txt` - Вариант с использованием pip.\n\n\n## Документация по make командам\n\n`make help` - Команда help отображает список доступных команд и их описание.\n\n`make ref` - Команда ref используется для форматирования кода с помощью ruff и black.\n\n`make dev` - Команда dev запускает приложение в режиме разработки.\n\n`make req` - Команда req обновляет зависимости в [requirements.txt](requirements.txt)\n\n`make migrate` - Команда migrate применяет все ожидающие миграции к базе данных с помощью alembic.\n\n`make generate` - Команда generate используется для генерации новой миграции базы данных с помощью alembic.\n","contact":{"name":"Fast Code","url":"https://fast-code.pro/","email":"[email protected]"},"version":"1.0.0"},"servers":[{"url":"/api"}],"paths":{"/auth/email/registration":{"post":{"tags":["auth"],"summary":"Registration","description":"Create user","operationId":"registration_auth_email_registration_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/auth/email/token":{"post":{"tags":["auth"],"summary":"Token","description":"Retrieve new access token","operationId":"token_auth_email_token_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/":{"get":{"tags":["users"],"summary":"Retrieve","description":"Retrieve user","operationId":"retrieve_users__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRead"}}}}},"security":[{"APIKeyHeader":[]}]}}},"components":{"schemas":{"AccessToken":{"properties":{"token":{"type":"string","title":"Token","description":"Необходим для запросов к API, действует 24 часа."}},"type":"object","title":"AccessToken"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"UserCreate":{"properties":{"email":{"type":"string","title":"Email"},"password":{"type":"string","title":"Password"}},"type":"object","required":["email","password"],"title":"UserCreate"},"UserRead":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"email":{"type":"string","title":"Email"}},"type":"object","required":["email"],"title":"UserRead"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"access-token"}}}}