1 line
32 KiB
JSON
1 line
32 KiB
JSON
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Overview","text":""},{"location":"#aetoskia-blog-api-012","title":"Aetoskia Blog API 0.1.2","text":"Text Only<pre><code>This is the **Aetoskia Blog API**, part of the personal service network.\n\nProvides:\n- Article CRUD operations\n- User comment management\n- Tag-based search\n\nFully async, secured via JWT auth.\n</code></pre> Terms of service: https://aetoskia.com/terms Contact: Aetoskia Dev Team dev@aetoskia.com License: MIT License"},{"location":"#servers","title":"Servers","text":"Description URL Production server https://api.aetoskia.com/blogs Staging environment for internal testing http://server-pi:9001 Local development server http://localhost:8000"},{"location":"#blog","title":"blog","text":""},{"location":"#post-authors","title":"POST /authors","text":"<p>Create Author</p> <p>Request body</p> application/json <p>JSON<pre><code>{\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the request body JSON<pre><code>{\n \"properties\": {\n \"_id\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"examples\": [\n \"507f1f77bcf86cd799439011\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ],\n \"title\": \"Id\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Created At\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Updated At\"\n },\n \"username\": {\n \"type\": \"string\",\n \"maxLength\": 50,\n \"minLength\": 3,\n \"title\": \"Username\"\n },\n \"email\": {\n \"type\": \"string\",\n \"title\": \"Email\"\n },\n \"is_active\": {\n \"type\": \"boolean\",\n \"title\": \"Is Active\",\n \"default\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"title\": \"Name\"\n },\n \"avatar\": {\n \"type\": \"string\",\n \"title\": \"Avatar\"\n }\n },\n \"type\": \"object\",\n \"required\": [\n \"username\",\n \"email\",\n \"name\",\n \"avatar\"\n ],\n \"title\": \"Author\",\n \"example\": {\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n }\n}\n</code></pre> <p> Response 200 OK </p> application/json <p>JSON<pre><code>{\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"_id\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"examples\": [\n \"507f1f77bcf86cd799439011\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ],\n \"title\": \"Id\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Created At\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Updated At\"\n },\n \"username\": {\n \"type\": \"string\",\n \"maxLength\": 50,\n \"minLength\": 3,\n \"title\": \"Username\"\n },\n \"email\": {\n \"type\": \"string\",\n \"title\": \"Email\"\n },\n \"is_active\": {\n \"type\": \"boolean\",\n \"title\": \"Is Active\",\n \"default\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"title\": \"Name\"\n },\n \"avatar\": {\n \"type\": \"string\",\n \"title\": \"Avatar\"\n }\n },\n \"type\": \"object\",\n \"required\": [\n \"username\",\n \"email\",\n \"name\",\n \"avatar\"\n ],\n \"title\": \"Author\",\n \"example\": {\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n }\n}\n</code></pre> <p> Response 422 Unprocessable Content </p> application/json <p>JSON<pre><code>{\n \"detail\": [\n {\n \"loc\": [\n null\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"detail\": {\n \"items\": {\n \"$ref\": \"#/components/schemas/ValidationError\"\n },\n \"type\": \"array\",\n \"title\": \"Detail\"\n }\n },\n \"type\": \"object\",\n \"title\": \"HTTPValidationError\"\n}\n</code></pre>"},{"location":"#get-authors","title":"GET /authors","text":"<p>List Authors</p> <p>Input parameters</p> Parameter In Type Default Nullable Description <code>limit</code> query integer 10 No <code>skip</code> query integer 0 No <p> Response 200 OK </p> application/json <p>JSON<pre><code>[\n {\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n }\n]\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/components/schemas/Author\"\n },\n \"title\": \"Response List Authors Authors Get\"\n}\n</code></pre> <p> Response 422 Unprocessable Content </p> application/json <p>JSON<pre><code>{\n \"detail\": [\n {\n \"loc\": [\n null\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"detail\": {\n \"items\": {\n \"$ref\": \"#/components/schemas/ValidationError\"\n },\n \"type\": \"array\",\n \"title\": \"Detail\"\n }\n },\n \"type\": \"object\",\n \"title\": \"HTTPValidationError\"\n}\n</code></pre>"},{"location":"#get-authorsauthor_id","title":"GET /authors/{author_id}","text":"<p>Get Author</p> <p>Input parameters</p> Parameter In Type Default Nullable Description <code>author_id</code> path string No <p> Response 200 OK </p> application/json <p>JSON<pre><code>{\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"_id\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"examples\": [\n \"507f1f77bcf86cd799439011\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ],\n \"title\": \"Id\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Created At\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Updated At\"\n },\n \"username\": {\n \"type\": \"string\",\n \"maxLength\": 50,\n \"minLength\": 3,\n \"title\": \"Username\"\n },\n \"email\": {\n \"type\": \"string\",\n \"title\": \"Email\"\n },\n \"is_active\": {\n \"type\": \"boolean\",\n \"title\": \"Is Active\",\n \"default\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"title\": \"Name\"\n },\n \"avatar\": {\n \"type\": \"string\",\n \"title\": \"Avatar\"\n }\n },\n \"type\": \"object\",\n \"required\": [\n \"username\",\n \"email\",\n \"name\",\n \"avatar\"\n ],\n \"title\": \"Author\",\n \"example\": {\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n }\n}\n</code></pre> <p> Response 422 Unprocessable Content </p> application/json <p>JSON<pre><code>{\n \"detail\": [\n {\n \"loc\": [\n null\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"detail\": {\n \"items\": {\n \"$ref\": \"#/components/schemas/ValidationError\"\n },\n \"type\": \"array\",\n \"title\": \"Detail\"\n }\n },\n \"type\": \"object\",\n \"title\": \"HTTPValidationError\"\n}\n</code></pre>"},{"location":"#put-authorsauthor_id","title":"PUT /authors/{author_id}","text":"<p>Update Author</p> <p>Input parameters</p> Parameter In Type Default Nullable Description <code>author_id</code> path string No <code>email</code> query string No <p> Response 200 OK </p> application/json <p>JSON<pre><code>{\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"_id\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"examples\": [\n \"507f1f77bcf86cd799439011\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ],\n \"title\": \"Id\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Created At\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Updated At\"\n },\n \"username\": {\n \"type\": \"string\",\n \"maxLength\": 50,\n \"minLength\": 3,\n \"title\": \"Username\"\n },\n \"email\": {\n \"type\": \"string\",\n \"title\": \"Email\"\n },\n \"is_active\": {\n \"type\": \"boolean\",\n \"title\": \"Is Active\",\n \"default\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"title\": \"Name\"\n },\n \"avatar\": {\n \"type\": \"string\",\n \"title\": \"Avatar\"\n }\n },\n \"type\": \"object\",\n \"required\": [\n \"username\",\n \"email\",\n \"name\",\n \"avatar\"\n ],\n \"title\": \"Author\",\n \"example\": {\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n }\n}\n</code></pre> <p> Response 422 Unprocessable Content </p> application/json <p>JSON<pre><code>{\n \"detail\": [\n {\n \"loc\": [\n null\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"detail\": {\n \"items\": {\n \"$ref\": \"#/components/schemas/ValidationError\"\n },\n \"type\": \"array\",\n \"title\": \"Detail\"\n }\n },\n \"type\": \"object\",\n \"title\": \"HTTPValidationError\"\n}\n</code></pre>"},{"location":"#delete-authorsauthor_id","title":"DELETE /authors/{author_id}","text":"<p>Delete Author</p> <p>Input parameters</p> Parameter In Type Default Nullable Description <code>author_id</code> path string No <p> Response 200 OK </p> application/json Schema of the response body JSON<pre><code>\n</code></pre> <p> Response 422 Unprocessable Content </p> application/json <p>JSON<pre><code>{\n \"detail\": [\n {\n \"loc\": [\n null\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"detail\": {\n \"items\": {\n \"$ref\": \"#/components/schemas/ValidationError\"\n },\n \"type\": \"array\",\n \"title\": \"Detail\"\n }\n },\n \"type\": \"object\",\n \"title\": \"HTTPValidationError\"\n}\n</code></pre>"},{"location":"#post-articles","title":"POST /articles","text":"<p>Create Article</p> <p>Request body</p> application/json <p>JSON<pre><code>{\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the request body JSON<pre><code>{\n \"properties\": {\n \"_id\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"examples\": [\n \"507f1f77bcf86cd799439011\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ],\n \"title\": \"Id\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Created At\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Updated At\"\n },\n \"img\": {\n \"type\": \"string\",\n \"title\": \"Img\"\n },\n \"tag\": {\n \"type\": \"string\",\n \"title\": \"Tag\"\n },\n \"title\": {\n \"type\": \"string\",\n \"title\": \"Title\"\n },\n \"description\": {\n \"type\": \"string\",\n \"title\": \"Description\"\n },\n \"content\": {\n \"type\": \"string\",\n \"title\": \"Content\"\n },\n \"authors\": {\n \"items\": {\n \"type\": \"string\",\n \"examples\": [\n \"507f1f77bcf86cd799439011\"\n ]\n },\n \"type\": \"array\",\n \"title\": \"Authors\"\n }\n },\n \"type\": \"object\",\n \"required\": [\n \"img\",\n \"tag\",\n \"title\",\n \"description\",\n \"content\"\n ],\n \"title\": \"Article\",\n \"example\": {\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n }\n}\n</code></pre> <p> Response 200 OK </p> application/json <p>JSON<pre><code>{\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"_id\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"examples\": [\n \"507f1f77bcf86cd799439011\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ],\n \"title\": \"Id\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Created At\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Updated At\"\n },\n \"img\": {\n \"type\": \"string\",\n \"title\": \"Img\"\n },\n \"tag\": {\n \"type\": \"string\",\n \"title\": \"Tag\"\n },\n \"title\": {\n \"type\": \"string\",\n \"title\": \"Title\"\n },\n \"description\": {\n \"type\": \"string\",\n \"title\": \"Description\"\n },\n \"content\": {\n \"type\": \"string\",\n \"title\": \"Content\"\n },\n \"authors\": {\n \"items\": {\n \"type\": \"string\",\n \"examples\": [\n \"507f1f77bcf86cd799439011\"\n ]\n },\n \"type\": \"array\",\n \"title\": \"Authors\"\n }\n },\n \"type\": \"object\",\n \"required\": [\n \"img\",\n \"tag\",\n \"title\",\n \"description\",\n \"content\"\n ],\n \"title\": \"Article\",\n \"example\": {\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n }\n}\n</code></pre> <p> Response 422 Unprocessable Content </p> application/json <p>JSON<pre><code>{\n \"detail\": [\n {\n \"loc\": [\n null\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"detail\": {\n \"items\": {\n \"$ref\": \"#/components/schemas/ValidationError\"\n },\n \"type\": \"array\",\n \"title\": \"Detail\"\n }\n },\n \"type\": \"object\",\n \"title\": \"HTTPValidationError\"\n}\n</code></pre>"},{"location":"#get-articles","title":"GET /articles","text":"<p>List Articles</p> <p>Input parameters</p> Parameter In Type Default Nullable Description <code>limit</code> query integer 10 No <code>skip</code> query integer 0 No <p> Response 200 OK </p> application/json <p>JSON<pre><code>[\n {\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n }\n]\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/components/schemas/ArticleResponse\"\n },\n \"title\": \"Response List Articles Articles Get\"\n}\n</code></pre> <p> Response 422 Unprocessable Content </p> application/json <p>JSON<pre><code>{\n \"detail\": [\n {\n \"loc\": [\n null\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"detail\": {\n \"items\": {\n \"$ref\": \"#/components/schemas/ValidationError\"\n },\n \"type\": \"array\",\n \"title\": \"Detail\"\n }\n },\n \"type\": \"object\",\n \"title\": \"HTTPValidationError\"\n}\n</code></pre>"},{"location":"#get-articlesarticle_id","title":"GET /articles/{article_id}","text":"<p>Get Article</p> <p>Input parameters</p> Parameter In Type Default Nullable Description <code>article_id</code> path string No <p> Response 200 OK </p> application/json <p>JSON<pre><code>{\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"_id\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"examples\": [\n \"507f1f77bcf86cd799439011\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ],\n \"title\": \"Id\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Created At\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Updated At\"\n },\n \"img\": {\n \"type\": \"string\",\n \"title\": \"Img\"\n },\n \"tag\": {\n \"type\": \"string\",\n \"title\": \"Tag\"\n },\n \"title\": {\n \"type\": \"string\",\n \"title\": \"Title\"\n },\n \"description\": {\n \"type\": \"string\",\n \"title\": \"Description\"\n },\n \"content\": {\n \"type\": \"string\",\n \"title\": \"Content\"\n },\n \"authors\": {\n \"items\": {\n \"$ref\": \"#/components/schemas/Author\"\n },\n \"type\": \"array\",\n \"title\": \"Authors\"\n }\n },\n \"type\": \"object\",\n \"required\": [\n \"img\",\n \"tag\",\n \"title\",\n \"description\",\n \"content\",\n \"authors\"\n ],\n \"title\": \"ArticleResponse\",\n \"example\": {\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n }\n}\n</code></pre> <p> Response 422 Unprocessable Content </p> application/json <p>JSON<pre><code>{\n \"detail\": [\n {\n \"loc\": [\n null\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"detail\": {\n \"items\": {\n \"$ref\": \"#/components/schemas/ValidationError\"\n },\n \"type\": \"array\",\n \"title\": \"Detail\"\n }\n },\n \"type\": \"object\",\n \"title\": \"HTTPValidationError\"\n}\n</code></pre>"},{"location":"#put-articlesarticle_id","title":"PUT /articles/{article_id}","text":"<p>Update Article</p> <p>Input parameters</p> Parameter In Type Default Nullable Description <code>article_id</code> path string No <p>Request body</p> application/json <p>JSON<pre><code>{\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the request body JSON<pre><code>{\n \"properties\": {\n \"_id\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"examples\": [\n \"507f1f77bcf86cd799439011\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ],\n \"title\": \"Id\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Created At\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Updated At\"\n },\n \"img\": {\n \"type\": \"string\",\n \"title\": \"Img\"\n },\n \"tag\": {\n \"type\": \"string\",\n \"title\": \"Tag\"\n },\n \"title\": {\n \"type\": \"string\",\n \"title\": \"Title\"\n },\n \"description\": {\n \"type\": \"string\",\n \"title\": \"Description\"\n },\n \"content\": {\n \"type\": \"string\",\n \"title\": \"Content\"\n },\n \"authors\": {\n \"items\": {\n \"type\": \"string\",\n \"examples\": [\n \"507f1f77bcf86cd799439011\"\n ]\n },\n \"type\": \"array\",\n \"title\": \"Authors\"\n }\n },\n \"type\": \"object\",\n \"required\": [\n \"img\",\n \"tag\",\n \"title\",\n \"description\",\n \"content\"\n ],\n \"title\": \"Article\",\n \"example\": {\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n }\n}\n</code></pre> <p> Response 200 OK </p> application/json <p>JSON<pre><code>{\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"_id\": {\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"examples\": [\n \"507f1f77bcf86cd799439011\"\n ]\n },\n {\n \"type\": \"null\"\n }\n ],\n \"title\": \"Id\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Created At\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"title\": \"Updated At\"\n },\n \"img\": {\n \"type\": \"string\",\n \"title\": \"Img\"\n },\n \"tag\": {\n \"type\": \"string\",\n \"title\": \"Tag\"\n },\n \"title\": {\n \"type\": \"string\",\n \"title\": \"Title\"\n },\n \"description\": {\n \"type\": \"string\",\n \"title\": \"Description\"\n },\n \"content\": {\n \"type\": \"string\",\n \"title\": \"Content\"\n },\n \"authors\": {\n \"items\": {\n \"type\": \"string\",\n \"examples\": [\n \"507f1f77bcf86cd799439011\"\n ]\n },\n \"type\": \"array\",\n \"title\": \"Authors\"\n }\n },\n \"type\": \"object\",\n \"required\": [\n \"img\",\n \"tag\",\n \"title\",\n \"description\",\n \"content\"\n ],\n \"title\": \"Article\",\n \"example\": {\n \"created_at\": \"2024-01-01T00:00:00\",\n \"updated_at\": \"2024-01-01T00:00:00\"\n }\n}\n</code></pre> <p> Response 422 Unprocessable Content </p> application/json <p>JSON<pre><code>{\n \"detail\": [\n {\n \"loc\": [\n null\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"detail\": {\n \"items\": {\n \"$ref\": \"#/components/schemas/ValidationError\"\n },\n \"type\": \"array\",\n \"title\": \"Detail\"\n }\n },\n \"type\": \"object\",\n \"title\": \"HTTPValidationError\"\n}\n</code></pre>"},{"location":"#delete-articlesarticle_id","title":"DELETE /articles/{article_id}","text":"<p>Delete Article</p> <p>Input parameters</p> Parameter In Type Default Nullable Description <code>article_id</code> path string No <p> Response 200 OK </p> application/json Schema of the response body JSON<pre><code>\n</code></pre> <p> Response 422 Unprocessable Content </p> application/json <p>JSON<pre><code>{\n \"detail\": [\n {\n \"loc\": [\n null\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}\n</code></pre> \u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.</p> Schema of the response body JSON<pre><code>{\n \"properties\": {\n \"detail\": {\n \"items\": {\n \"$ref\": \"#/components/schemas/ValidationError\"\n },\n \"type\": \"array\",\n \"title\": \"Detail\"\n }\n },\n \"type\": \"object\",\n \"title\": \"HTTPValidationError\"\n}\n</code></pre>"},{"location":"#endpoints","title":"Endpoints","text":""},{"location":"#get-health","title":"GET /health","text":"<p>Health Check</p> <p> Response 200 OK </p> application/json Schema of the response body JSON"},{"location":"#schemas","title":"Schemas","text":""},{"location":"#article","title":"Article","text":"Name Type <code>_id</code> <code>authors</code> Array<string> <code>content</code> string <code>created_at</code> string(date-time) <code>description</code> string <code>img</code> string <code>tag</code> string <code>title</code> string <code>updated_at</code> string(date-time)"},{"location":"#articleresponse","title":"ArticleResponse","text":"Name Type <code>_id</code> <code>authors</code> Array<Author> <code>content</code> string <code>created_at</code> string(date-time) <code>description</code> string <code>img</code> string <code>tag</code> string <code>title</code> string <code>updated_at</code> string(date-time)"},{"location":"#author","title":"Author","text":"Name Type <code>_id</code> <code>avatar</code> string <code>created_at</code> string(date-time) <code>email</code> string <code>is_active</code> boolean <code>name</code> string <code>updated_at</code> string(date-time) <code>username</code> string"},{"location":"#httpvalidationerror","title":"HTTPValidationError","text":"Name Type <code>detail</code> Array<ValidationError>"},{"location":"#validationerror","title":"ValidationError","text":"Name Type <code>loc</code> Array<> <code>msg</code> string <code>type</code> string"},{"location":"#tags","title":"Tags","text":"Name Description Articles Operations for creating, reading, updating, and deleting blog articles. Users User management and authentication endpoints."},{"location":"swagger-ui/","title":"Index","text":""}]} |