root
91 lines
2.4 KiB
YAML
91 lines
2.4 KiB
YAML
openapi: 3.0.3
|
|
info: { title: Project API, version: 1.0.0 }
|
|
servers: [ { url: https://your-domain.com/api/v1 } ]
|
|
tags: [ { name: Projects } ]
|
|
security: [ { bearerAuth: [] } ]
|
|
|
|
paths:
|
|
/projects:
|
|
get:
|
|
tags: [Projects]
|
|
summary: List projects
|
|
parameters:
|
|
- in: query
|
|
name: page
|
|
schema: { type: integer, default: 1 }
|
|
- in: query
|
|
name: per_page
|
|
schema: { type: integer, default: 20 }
|
|
- in: query
|
|
name: student_id
|
|
schema: { type: integer }
|
|
- in: query
|
|
name: class_section_id
|
|
schema: { type: integer }
|
|
responses:
|
|
"200": { description: Projects retrieved }
|
|
post:
|
|
tags: [Projects]
|
|
summary: Create project row
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
required: [student_id, class_section_id, project_index]
|
|
properties:
|
|
student_id: { type: integer }
|
|
class_section_id: { type: integer }
|
|
project_index: { type: integer }
|
|
score: { type: number }
|
|
comment: { type: string }
|
|
responses:
|
|
"201": { description: Project created }
|
|
|
|
/projects/{id}:
|
|
get:
|
|
tags: [Projects]
|
|
summary: Get project by ID
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema: { type: integer }
|
|
responses:
|
|
"200": { description: Project }
|
|
"404": { description: Not found }
|
|
put:
|
|
tags: [Projects]
|
|
summary: Update project row
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema: { type: integer }
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
score: { type: number }
|
|
comment: { type: string }
|
|
project_index: { type: integer }
|
|
responses:
|
|
"200": { description: Project updated }
|
|
|
|
/projects/student/{id}:
|
|
get:
|
|
tags: [Projects]
|
|
summary: Get projects by student
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema: { type: integer }
|
|
responses:
|
|
"200": { description: Student projects list }
|
|
|