{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Overview","text":""},{"location":"#aetoskia-blog-api-004","title":"Aetoskia Blog API 0.0.4","text":"Text Only
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
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 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":"

Create Author

Request body

application/json

JSON

{\n    \"created_at\": \"2024-01-01T00:00:00\",\n    \"updated_at\": \"2024-01-01T00:00:00\"\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body JSON
{\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

Response 200 OK

application/json

JSON

{\n    \"created_at\": \"2024-01-01T00:00:00\",\n    \"updated_at\": \"2024-01-01T00:00:00\"\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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

Response 422 Unprocessable Content

application/json

JSON

{\n    \"detail\": [\n        {\n            \"loc\": [\n                null\n            ],\n            \"msg\": \"string\",\n            \"type\": \"string\"\n        }\n    ]\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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
"},{"location":"#get-authors","title":"GET /authors","text":"

List Authors

Input parameters

Parameter In Type Default Nullable Description limit query integer 10 No skip query integer 0 No

Response 200 OK

application/json

JSON

[\n    {\n        \"created_at\": \"2024-01-01T00:00:00\",\n        \"updated_at\": \"2024-01-01T00:00:00\"\n    }\n]\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\n    \"type\": \"array\",\n    \"items\": {\n        \"$ref\": \"#/components/schemas/Author\"\n    },\n    \"title\": \"Response List Authors Authors Get\"\n}\n

Response 422 Unprocessable Content

application/json

JSON

{\n    \"detail\": [\n        {\n            \"loc\": [\n                null\n            ],\n            \"msg\": \"string\",\n            \"type\": \"string\"\n        }\n    ]\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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
"},{"location":"#get-authorsauthor_id","title":"GET /authors/{author_id}","text":"

Get Author

Input parameters

Parameter In Type Default Nullable Description author_id path string No

Response 200 OK

application/json

JSON

{\n    \"created_at\": \"2024-01-01T00:00:00\",\n    \"updated_at\": \"2024-01-01T00:00:00\"\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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

Response 422 Unprocessable Content

application/json

JSON

{\n    \"detail\": [\n        {\n            \"loc\": [\n                null\n            ],\n            \"msg\": \"string\",\n            \"type\": \"string\"\n        }\n    ]\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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
"},{"location":"#put-authorsauthor_id","title":"PUT /authors/{author_id}","text":"

Update Author

Input parameters

Parameter In Type Default Nullable Description author_id path string No email query string No

Response 200 OK

application/json

JSON

{\n    \"created_at\": \"2024-01-01T00:00:00\",\n    \"updated_at\": \"2024-01-01T00:00:00\"\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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

Response 422 Unprocessable Content

application/json

JSON

{\n    \"detail\": [\n        {\n            \"loc\": [\n                null\n            ],\n            \"msg\": \"string\",\n            \"type\": \"string\"\n        }\n    ]\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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
"},{"location":"#delete-authorsauthor_id","title":"DELETE /authors/{author_id}","text":"

Delete Author

Input parameters

Parameter In Type Default Nullable Description author_id path string No

Response 200 OK

application/json Schema of the response body JSON
\n

Response 422 Unprocessable Content

application/json

JSON

{\n    \"detail\": [\n        {\n            \"loc\": [\n                null\n            ],\n            \"msg\": \"string\",\n            \"type\": \"string\"\n        }\n    ]\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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
"},{"location":"#post-articles","title":"POST /articles","text":"

Create Article

Request body

application/json

JSON

{\n    \"created_at\": \"2024-01-01T00:00:00\",\n    \"updated_at\": \"2024-01-01T00:00:00\"\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body JSON
{\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

Response 200 OK

application/json

JSON

{\n    \"created_at\": \"2024-01-01T00:00:00\",\n    \"updated_at\": \"2024-01-01T00:00:00\"\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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

Response 422 Unprocessable Content

application/json

JSON

{\n    \"detail\": [\n        {\n            \"loc\": [\n                null\n            ],\n            \"msg\": \"string\",\n            \"type\": \"string\"\n        }\n    ]\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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
"},{"location":"#get-articles","title":"GET /articles","text":"

List Articles

Input parameters

Parameter In Type Default Nullable Description limit query integer 10 No skip query integer 0 No

Response 200 OK

application/json

JSON

[\n    {\n        \"created_at\": \"2024-01-01T00:00:00\",\n        \"updated_at\": \"2024-01-01T00:00:00\"\n    }\n]\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\n    \"type\": \"array\",\n    \"items\": {\n        \"$ref\": \"#/components/schemas/ArticleResponse\"\n    },\n    \"title\": \"Response List Articles Articles Get\"\n}\n

Response 422 Unprocessable Content

application/json

JSON

{\n    \"detail\": [\n        {\n            \"loc\": [\n                null\n            ],\n            \"msg\": \"string\",\n            \"type\": \"string\"\n        }\n    ]\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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
"},{"location":"#get-articlesarticle_id","title":"GET /articles/{article_id}","text":"

Get Article

Input parameters

Parameter In Type Default Nullable Description article_id path string No

Response 200 OK

application/json

JSON

{\n    \"created_at\": \"2024-01-01T00:00:00\",\n    \"updated_at\": \"2024-01-01T00:00:00\"\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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

Response 422 Unprocessable Content

application/json

JSON

{\n    \"detail\": [\n        {\n            \"loc\": [\n                null\n            ],\n            \"msg\": \"string\",\n            \"type\": \"string\"\n        }\n    ]\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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
"},{"location":"#put-articlesarticle_id","title":"PUT /articles/{article_id}","text":"

Update Article

Input parameters

Parameter In Type Default Nullable Description article_id path string No

Request body

application/json

JSON

{\n    \"created_at\": \"2024-01-01T00:00:00\",\n    \"updated_at\": \"2024-01-01T00:00:00\"\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body JSON
{\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

Response 200 OK

application/json

JSON

{\n    \"created_at\": \"2024-01-01T00:00:00\",\n    \"updated_at\": \"2024-01-01T00:00:00\"\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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

Response 422 Unprocessable Content

application/json

JSON

{\n    \"detail\": [\n        {\n            \"loc\": [\n                null\n            ],\n            \"msg\": \"string\",\n            \"type\": \"string\"\n        }\n    ]\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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
"},{"location":"#delete-articlesarticle_id","title":"DELETE /articles/{article_id}","text":"

Delete Article

Input parameters

Parameter In Type Default Nullable Description article_id path string No

Response 200 OK

application/json Schema of the response body JSON
\n

Response 422 Unprocessable Content

application/json

JSON

{\n    \"detail\": [\n        {\n            \"loc\": [\n                null\n            ],\n            \"msg\": \"string\",\n            \"type\": \"string\"\n        }\n    ]\n}\n
\u26a0\ufe0f This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body JSON
{\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
"},{"location":"#endpoints","title":"Endpoints","text":""},{"location":"#get-health","title":"GET /health","text":"

Health Check

Response 200 OK

application/json Schema of the response body JSON"},{"location":"#schemas","title":"Schemas","text":""},{"location":"#article","title":"Article","text":"Name Type _id authors Array<string> content string created_at string(date-time) description string img string tag string title string updated_at string(date-time)"},{"location":"#articleresponse","title":"ArticleResponse","text":"Name Type _id authors Array<Author> content string created_at string(date-time) description string img string tag string title string updated_at string(date-time)"},{"location":"#author","title":"Author","text":"Name Type _id avatar string created_at string(date-time) email string is_active boolean name string updated_at string(date-time) username string"},{"location":"#httpvalidationerror","title":"HTTPValidationError","text":"Name Type detail Array<ValidationError>"},{"location":"#validationerror","title":"ValidationError","text":"Name Type loc Array<> msg string type 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":""}]}