swagger.json

{
    "openapi": "3.0.0",
    "info": {
        "version": "1.0.0"
    },
    "paths": {
        "/api/public/data": {
            "post": {
                "summary": "Get student information",
                "responses": {
                    "200": {
                        "description": "Successful response",
                        "content": {
                            "application/json": {
                                "example": [{
                                    "index": "19000X",
                                    "email": "<EMAIL>",
                                    "firstName": "User1",
                                    "lastName": "User1",
                                    "faculty": "Faculty1",
                                    "department": "Department1",
                                    "photo": "<bytestring>"
                                }]
                            }
                        }
                    }
                },
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "indices": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        }
                                    },
                                    "fields": {
                                        "type": "array",
                                        "items": {
                                            "type": "string",
                                            "enum": ["index", "email", "firstName", "lastName", "faculty", "department", "photo"]
                                        }
                                    }
                                }
                            },
                            "example": {
                                "indices": [
                                    "190000X"
                                ],
                                "fields": [
                                    "index",
                                    "email",
                                    "firstName",
                                    "lastName",
                                    "faculty",
                                    "department"
                                ]

                            }
                        }
                    }
                }
            }
        },
        "/api/public/verify": {
            "post": {
                "summary": "Verify credentials",
                "responses": {
                    "200": {
                        "description": "Successful response",
                        "content": {
                            "application/json": {
                                "example": {
                                    "verified": true,
                                    "email": "test@gmail.com",
                                    "firstName": "User1",
                                    "lastName": "User1",
                                    "role": "student"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Invalid credentials",
                        "content": {
                            "application/json": {
                                "example": {
                                    "verified": false,
                                    "reason": "Invalid credentials"
                                }
                            }
                        }
                    }
                },
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "email": {
                                        "type": "string"
                                    },
                                    "password": {
                                        "type": "string"
                                    }
                                }
                            },
                            "example": {
                                "email": "user1@example.com",
                                "password": "password"
                            }
                        }
                    }
                }
            }
        }
    }
}