{ "openapi": "3.1.0", "info": { "title": "iTechBD API", "version": "1.0.0", "description": "Versioned Laravel API for the Next.js public website, authentication, checkout and student panel." }, "servers": [ { "url": "http://localhost:8000/api/v1", "description": "Local Laravel API" } ], "tags": [ { "name": "Public" }, { "name": "Authentication" }, { "name": "Checkout" }, { "name": "Student" }, { "name": "Student Profile" } ], "paths": { "/public/bootstrap": { "get": { "summary": "Get site bootstrap data", "operationId": "getPublicBootstrap", "tags": [ "Public" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/public/home": { "get": { "summary": "Get homepage data", "operationId": "getPublicHome", "tags": [ "Public" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/public/pages/{slug}": { "get": { "summary": "Get CMS page", "operationId": "getPublicPage", "tags": [ "Public" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/public/courses": { "get": { "summary": "List active courses", "operationId": "listPublicCourses", "tags": [ "Public" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "track", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/public/courses/{course}": { "get": { "summary": "Get course details", "operationId": "getPublicCourse", "tags": [ "Public" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "course", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Course slug or numeric ID" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/public/mentors": { "get": { "summary": "List active mentors", "operationId": "listPublicMentors", "tags": [ "Public" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/public/mentors/{mentor}": { "get": { "summary": "Get mentor details", "operationId": "getPublicMentor", "tags": [ "Public" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "mentor", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Mentor slug or numeric ID" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/public/profiles/{publicUrl}": { "get": { "summary": "Get public profile", "operationId": "getPublicProfile", "tags": [ "Public" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "publicUrl", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/public/reviews": { "get": { "summary": "List public reviews", "operationId": "listPublicReviews", "tags": [ "Public" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/public/news": { "get": { "summary": "List published news", "operationId": "listPublicNews", "tags": [ "Public" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/public/news/{newsUpdate}": { "get": { "summary": "Get news details", "operationId": "getPublicNews", "tags": [ "Public" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "newsUpdate", "in": "path", "required": true, "schema": { "type": "string" }, "description": "News slug" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/public/contact": { "post": { "summary": "Submit contact message", "operationId": "submitContact", "tags": [ "Public" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited" } } } }, "/auth/register": { "post": { "summary": "Register student account", "operationId": "register", "tags": [ "Authentication" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited" } } } }, "/auth/login": { "post": { "summary": "Login", "operationId": "login", "tags": [ "Authentication" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited" } } } }, "/auth/resend-verification": { "post": { "summary": "Resend email verification", "operationId": "resendVerification", "tags": [ "Authentication" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited" } } } }, "/auth/forgot-password": { "post": { "summary": "Send password reset link", "operationId": "forgotPassword", "tags": [ "Authentication" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited" } } } }, "/auth/reset-password": { "post": { "summary": "Reset password", "operationId": "resetPassword", "tags": [ "Authentication" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limited" } } } }, "/auth/me": { "get": { "summary": "Get authenticated user", "operationId": "getCurrentUser", "tags": [ "Authentication" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/auth/logout": { "post": { "summary": "Logout current token or session", "operationId": "logout", "tags": [ "Authentication" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/auth/logout-all": { "post": { "summary": "Logout all devices", "operationId": "logoutAll", "tags": [ "Authentication" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/checkout/courses/{course}": { "get": { "summary": "Get checkout preview", "operationId": "getCheckoutPreview", "tags": [ "Checkout" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "course", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Course slug or numeric ID" } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "post": { "summary": "Create or update pending order", "operationId": "storeCheckoutOrder", "tags": [ "Checkout" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "course", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Course slug or numeric ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutRequest" } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "409": { "description": "Enrollment conflict" }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/checkout/orders/{order}": { "get": { "summary": "Get checkout order", "operationId": "getCheckoutOrder", "tags": [ "Checkout" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "order", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/dashboard": { "get": { "summary": "Get student dashboard", "operationId": "getStudentDashboard", "tags": [ "Student" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/courses": { "get": { "summary": "List enrolled courses", "operationId": "listStudentCourses", "tags": [ "Student" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/courses/{course}": { "get": { "summary": "Get enrolled course details", "operationId": "getStudentCourse", "tags": [ "Student" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "course", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Course slug or numeric ID" } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/batches": { "get": { "summary": "List student batches", "operationId": "listStudentBatches", "tags": [ "Student" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pending", "approved" ] } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/batches/{batch}": { "get": { "summary": "Get student batch details", "operationId": "getStudentBatch", "tags": [ "Student" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "batch", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/mentors": { "get": { "summary": "List assigned mentors", "operationId": "listStudentMentors", "tags": [ "Student" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/invoices": { "get": { "summary": "List student invoices", "operationId": "listStudentInvoices", "tags": [ "Student" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pending", "paid", "cancelled" ] } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/invoices/{order}": { "get": { "summary": "Get invoice details", "operationId": "getStudentInvoice", "tags": [ "Student" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "order", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/invoices/{order}/download": { "get": { "summary": "Download invoice PDF", "operationId": "downloadStudentInvoice", "tags": [ "Student" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "order", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "PDF invoice", "content": { "application/pdf": { "schema": { "type": "string", "contentEncoding": "binary" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/profile": { "get": { "summary": "Get complete student profile", "operationId": "getStudentProfile", "tags": [ "Student Profile" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "post": { "summary": "Update account and profile image", "operationId": "updateStudentProfile", "tags": [ "Student Profile" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "name", "email" ], "properties": { "name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "profile_image": { "type": "string", "contentEncoding": "binary" }, "remove_profile_image": { "type": "boolean" } } } } } } } }, "/student/profile/details": { "patch": { "summary": "Update personal details", "operationId": "updateStudentProfileDetails", "tags": [ "Student Profile" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileDetailsRequest" } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/profile/public-url": { "patch": { "summary": "Update public profile URL", "operationId": "updateStudentPublicUrl", "tags": [ "Student Profile" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "public_url": { "type": [ "string", "null" ], "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$" } } } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/profile/address": { "put": { "summary": "Create or update address", "operationId": "updateStudentAddress", "tags": [ "Student Profile" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressRequest" } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/profile/password": { "put": { "summary": "Change password", "operationId": "updateStudentPassword", "tags": [ "Student Profile" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/profile/educations": { "post": { "summary": "Add education", "operationId": "createStudentEducation", "tags": [ "Student Profile" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EducationRequest" } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/profile/educations/{education}": { "patch": { "summary": "Update education", "operationId": "updateStudentEducation", "tags": [ "Student Profile" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "education", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EducationRequest" } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "delete": { "summary": "Delete education", "operationId": "deleteStudentEducation", "tags": [ "Student Profile" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "education", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/profile/experiences": { "post": { "summary": "Add experience", "operationId": "createStudentExperience", "tags": [ "Student Profile" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperienceRequest" } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/profile/experiences/{experience}": { "patch": { "summary": "Update experience", "operationId": "updateStudentExperience", "tags": [ "Student Profile" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "experience", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperienceRequest" } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "delete": { "summary": "Delete experience", "operationId": "deleteStudentExperience", "tags": [ "Student Profile" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "experience", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/profile/skills": { "post": { "summary": "Add skill", "operationId": "createStudentSkill", "tags": [ "Student Profile" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillRequest" } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/student/profile/skills/{skill}": { "patch": { "summary": "Update skill proficiency", "operationId": "updateStudentSkill", "tags": [ "Student Profile" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "skill", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "proficiency_level" ], "properties": { "proficiency_level": { "type": "string", "enum": [ "beginner", "intermediate", "expert" ] } } } } } }, "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "delete": { "summary": "Remove skill", "operationId": "deleteStudentSkill", "tags": [ "Student Profile" ], "parameters": [ { "$ref": "#/components/parameters/LocaleHeader" }, { "name": "skill", "in": "path", "required": true, "schema": { "type": "integer" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiSuccess" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "Sanctum token" } }, "parameters": { "LocaleHeader": { "name": "X-Locale", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "en", "bn" ], "default": "en" }, "description": "Response locale" } }, "schemas": { "ApiSuccess": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "const": true }, "message": { "type": [ "string", "null" ] }, "data": {} } }, "ApiError": { "type": "object", "required": [ "success", "message" ], "properties": { "success": { "type": "boolean", "const": false }, "message": { "type": "string" }, "code": { "type": [ "string", "null" ] }, "errors": {} } }, "EmailRequest": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email" } } }, "RegisterRequest": { "type": "object", "required": [ "name", "email", "password", "password_confirmation" ], "properties": { "name": { "type": "string", "maxLength": 255 }, "email": { "type": "string", "format": "email" }, "password": { "type": "string", "format": "password" }, "password_confirmation": { "type": "string", "format": "password" }, "g-recaptcha-response": { "type": "string" } } }, "LoginRequest": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "format": "password" }, "device_name": { "type": "string", "default": "nextjs-web" }, "issue_token": { "type": "boolean", "default": true }, "g-recaptcha-response": { "type": "string" } } }, "ResetPasswordRequest": { "type": "object", "required": [ "token", "email", "password", "password_confirmation" ], "properties": { "token": { "type": "string" }, "email": { "type": "string", "format": "email" }, "password": { "type": "string", "format": "password" }, "password_confirmation": { "type": "string", "format": "password" } } }, "ContactRequest": { "type": "object", "required": [ "name", "email", "phone", "subject", "message" ], "properties": { "name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "subject": { "type": "string" }, "message": { "type": "string", "maxLength": 5000 }, "g-recaptcha-response": { "type": "string" } } }, "CheckoutRequest": { "type": "object", "properties": { "batch_id": { "type": [ "integer", "null" ] }, "batch_type": { "type": [ "string", "null" ], "enum": [ "online", "offline", null ] } } }, "ProfileDetailsRequest": { "type": "object", "properties": { "gender": { "type": [ "string", "null" ], "enum": [ "male", "female", "other", null ] }, "date_of_birth": { "type": [ "string", "null" ], "format": "date" }, "mobile_number": { "type": [ "string", "null" ] }, "father_name": { "type": [ "string", "null" ] }, "father_mobile": { "type": [ "string", "null" ] }, "mother_name": { "type": [ "string", "null" ] }, "mother_mobile": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ] } } }, "AddressRequest": { "type": "object", "required": [ "city", "country" ], "properties": { "house_number": { "type": [ "string", "null" ] }, "street": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "post_office": { "type": [ "string", "null" ] }, "zip_code": { "type": [ "string", "null" ] }, "country": { "type": "string" } } }, "ChangePasswordRequest": { "type": "object", "required": [ "current_password", "password", "password_confirmation" ], "properties": { "current_password": { "type": "string", "format": "password" }, "password": { "type": "string", "format": "password" }, "password_confirmation": { "type": "string", "format": "password" } } }, "EducationRequest": { "type": "object", "required": [ "degree_name", "institute_name" ], "properties": { "degree_name": { "type": "string" }, "institute_name": { "type": "string" }, "board_or_university": { "type": [ "string", "null" ] }, "start_year": { "type": [ "integer", "null" ] }, "end_year": { "type": [ "integer", "null" ] }, "result_or_grade": { "type": [ "string", "null" ] } } }, "ExperienceRequest": { "type": "object", "required": [ "company_name", "job_title", "start_date" ], "properties": { "company_name": { "type": "string" }, "job_title": { "type": "string" }, "start_date": { "type": "string", "format": "date" }, "end_date": { "type": [ "string", "null" ], "format": "date" }, "description": { "type": [ "string", "null" ] } } }, "SkillRequest": { "type": "object", "required": [ "skill_name", "proficiency_level" ], "properties": { "skill_name": { "type": "string" }, "proficiency_level": { "type": "string", "enum": [ "beginner", "intermediate", "expert" ] } } } } } }