root
47 lines
1.1 KiB
YAML
47 lines
1.1 KiB
YAML
openapi: 3.0.3
|
|
info: { title: Teacher API, version: 1.0.0 }
|
|
servers: [ { url: https://your-domain.com/api/v1 } ]
|
|
tags: [ { name: Teachers } ]
|
|
security: [ { bearerAuth: [] } ]
|
|
|
|
paths:
|
|
/teachers:
|
|
get:
|
|
tags: [Teachers]
|
|
summary: List teachers
|
|
parameters:
|
|
- in: query
|
|
name: page
|
|
schema: { type: integer, default: 1 }
|
|
- in: query
|
|
name: per_page
|
|
schema: { type: integer, default: 20 }
|
|
responses:
|
|
"200": { description: Teachers retrieved }
|
|
|
|
/teachers/{id}:
|
|
get:
|
|
tags: [Teachers]
|
|
summary: Get teacher by ID
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema: { type: integer }
|
|
responses:
|
|
"200": { description: Teacher profile }
|
|
"404": { description: Not found }
|
|
|
|
/teachers/{id}/classes:
|
|
get:
|
|
tags: [Teachers]
|
|
summary: Get teacher class assignments
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema: { type: integer }
|
|
responses:
|
|
"200": { description: Class assignments }
|
|
|