openapi.json

{"openapi": "3.0.2", "info": {"title": "E-Tago API: Object Detection using FastAPI and YOLOv8", "description": "This is an API for Personal Information Detection and Censorship in E-Commerce Product Review Images using FastAPI and YOLOv8.", "version": "2024.4.1"}, "paths": {"/detection/img_object_detection_to_json": {"post": {"tags": ["Detection"], "summary": "Img Object Detection To Json", "description": "**Object Detection from an image.**\n\n**Args:**\n    - **file (bytes)**: The image file in bytes format.\n**Returns:**\n    - **dict**: JSON format containing the Objects Detections.", "operationId": "img_object_detection_to_json_detection_img_object_detection_to_json_post", "requestBody": {"content": {"multipart/form-data": {"schema": {"$ref": "#/components/schemas/Body_img_object_detection_to_json_detection_img_object_detection_to_json_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/detection/img_object_detection_to_img": {"post": {"tags": ["Detection"], "summary": "Img Object Detection To Img", "description": "**Object Detection from an image plot bbox on image**\n\n**Args:**\n    - **file (bytes)** The image file in bytes format.\n**Returns:**\n    - **Image** Image in bytes with bbox annotations.", "operationId": "img_object_detection_to_img_detection_img_object_detection_to_img_post", "requestBody": {"content": {"multipart/form-data": {"schema": {"$ref": "#/components/schemas/Body_img_object_detection_to_img_detection_img_object_detection_to_img_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/detection/img_object_detection_to_censored_img": {"post": {"tags": ["Detection"], "summary": "Img Object Detection To Censored Img", "description": "**Object Detection from an image plot bbox on image**\n\n**Args:**\n    - **file (bytes)** The image file in bytes format.\n**Returns:**\n    - **Image** Image in bytes with bbox annotations.", "operationId": "img_object_detection_to_censored_img_detection_img_object_detection_to_censored_img_post", "requestBody": {"content": {"multipart/form-data": {"schema": {"$ref": "#/components/schemas/Body_img_object_detection_to_censored_img_detection_img_object_detection_to_censored_img_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/healthcheck": {"get": {"tags": ["Health Check"], "summary": "Perform Healthcheck", "description": "It basically sends a GET request to the route & hopes to get a \"200\"\nresponse code. Failing to return a 200 response code just enables\nthe GitHub Actions to rollback to the last version the project was\nfound in a \"working condition\". It acts as a last line of defense in\ncase something goes south.\nAdditionally, it also returns a JSON response in the form of:\n{\n    'healtcheck': 'Everything OK!'\n}", "operationId": "perform_healthcheck_healthcheck_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}}, "components": {"schemas": {"Body_img_object_detection_to_censored_img_detection_img_object_detection_to_censored_img_post": {"title": "Body_img_object_detection_to_censored_img_detection_img_object_detection_to_censored_img_post", "required": ["file"], "type": "object", "properties": {"file": {"title": "File", "type": "string", "format": "binary"}}}, "Body_img_object_detection_to_img_detection_img_object_detection_to_img_post": {"title": "Body_img_object_detection_to_img_detection_img_object_detection_to_img_post", "required": ["file"], "type": "object", "properties": {"file": {"title": "File", "type": "string", "format": "binary"}}}, "Body_img_object_detection_to_json_detection_img_object_detection_to_json_post": {"title": "Body_img_object_detection_to_json_detection_img_object_detection_to_json_post", "required": ["file"], "type": "object", "properties": {"file": {"title": "File", "type": "string", "format": "binary"}}}, "HTTPValidationError": {"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"$ref": "#/components/schemas/ValidationError"}}}}, "ValidationError": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"anyOf": [{"type": "string"}, {"type": "integer"}]}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}}}}