root
39 lines
1.1 KiB
YAML
39 lines
1.1 KiB
YAML
openapi: 3.0.3
|
|
info: { title: Broadcast Email API, version: 1.0.0 }
|
|
servers: [ { url: https://your-domain.com/api/v1 } ]
|
|
tags: [ { name: Broadcast Email } ]
|
|
security: [ { bearerAuth: [] } ]
|
|
|
|
paths:
|
|
/broadcast-email/send:
|
|
post:
|
|
tags: [Broadcast Email]
|
|
summary: Send broadcast email
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema: { $ref: '#/components/schemas/BroadcastEmailSend' }
|
|
responses:
|
|
"200": { description: Broadcast sent successfully }
|
|
"422": { description: Validation error }
|
|
|
|
/broadcast-email/parents:
|
|
get:
|
|
tags: [Broadcast Email]
|
|
summary: Get all parents for broadcast selection
|
|
responses:
|
|
"200": { description: List of parent recipients }
|
|
|
|
components:
|
|
schemas:
|
|
BroadcastEmailSend:
|
|
type: object
|
|
required: [subject, body, recipients]
|
|
properties:
|
|
subject: { type: string, example: "Reminder: School Closed on Sunday" }
|
|
body: { type: string, example: "Dear parents, please note that..." }
|
|
recipients:
|
|
type: array
|
|
items: { type: string, format: email }
|