|
1 |
| -#the participant of the training session |
2 | 1 | type: object
|
| 2 | +required: |
| 3 | + - training_id |
| 4 | + - session_date |
| 5 | + - location |
| 6 | + - trainer_id |
| 7 | + - max_participants |
3 | 8 | properties:
|
4 | 9 | id:
|
5 | 10 | type: string
|
6 | 11 | format: cuid
|
7 | 12 | readOnly: true
|
8 |
| - description: "The unique Id of the participant." |
9 |
| - first_name: |
| 13 | + description: "The unique ID of the training session" |
| 14 | + example: "clh1234567890abcdef" |
| 15 | + training_id: |
10 | 16 | type: string
|
11 |
| - description: "first name of the participant" |
12 |
| - last_name: |
| 17 | + format: cuid |
| 18 | + description: "The ID of the training this session belongs to" |
| 19 | + example: "clh1234567890abcdef" |
| 20 | + session_date: |
13 | 21 | type: string
|
14 |
| - description: "last name of the participant" |
15 |
| - email: |
| 22 | + format: date |
| 23 | + description: "The date of the training session" |
| 24 | + example: "2024-01-15" |
| 25 | + start_time: |
16 | 26 | type: string
|
17 |
| - description: "email of the participant" |
18 |
| - |
19 |
| - signature: |
| 27 | + pattern: "^([0-1][0-9]|2[0-3]):[0-5][0-9]$" |
| 28 | + description: "Start time of the session (24-hour format)" |
| 29 | + example: "09:00" |
| 30 | + end_time: |
20 | 31 | type: string
|
21 |
| - description: "To hold the digital the signature of the participant" |
22 |
| - role: |
| 32 | + pattern: "^([0-1][0-9]|2[0-3]):[0-5][0-9]$" |
| 33 | + description: "End time of the session (24-hour format)" |
| 34 | + example: "17:00" |
| 35 | + location: |
23 | 36 | type: string
|
24 |
| - description: To Specify the role of the participant |
25 |
| - example: "Farmer, Trainer" |
26 |
| - training_id: |
| 37 | + description: "Location where the session will be held" |
| 38 | + example: "Community Center" |
| 39 | + trainer_id: |
27 | 40 | type: string
|
28 | 41 | format: cuid
|
29 |
| - description: the company id of the training |
30 |
| - example: 1jssbbjsbjsbjs221878dd817dd87sd |
31 |
| - phone: |
32 |
| - type: string |
33 |
| - description: To Specify the phone number of the participant |
34 |
| - training_picture_urls: |
| 42 | + description: "The ID of the trainer conducting the session" |
| 43 | + example: "clh1234567890abcdef" |
| 44 | + max_participants: |
| 45 | + type: integer |
| 46 | + minimum: 1 |
| 47 | + description: "Maximum number of participants allowed" |
| 48 | + example: 30 |
| 49 | + current_participants: |
| 50 | + type: integer |
| 51 | + minimum: 0 |
| 52 | + description: "Current number of participants registered" |
| 53 | + example: 25 |
| 54 | + status: |
35 | 55 | type: string
|
36 |
| - format: array |
37 |
| - description: the images of the training |
38 |
| - example: ["https://senima.com/wp-content/uploads/2022/01/gold.png"] |
39 |
| - report_url: |
40 |
| - type: string |
41 |
| - description: To specify the report of the training |
42 |
| - example: "https://senima.com/wp-content/uploads/2022/01/report.pdf" |
43 |
| - trainer_proof_of_competency: |
44 |
| - type: string |
45 |
| - format: array |
46 |
| - description: the training proof of competency of the trainer. |
| 56 | + enum: ["scheduled", "in-progress", "completed", "cancelled"] |
| 57 | + description: "Current status of the session" |
| 58 | + example: "scheduled" |
47 | 59 | created_at:
|
48 | 60 | type: string
|
49 | 61 | format: date-time
|
50 |
| - example: "2020-01-01T00:00:00Z" |
51 |
| - description: "the date and time when the participant was created" |
| 62 | + readOnly: true |
| 63 | + description: "When the session was created" |
| 64 | + example: "2024-01-15T10:30:00Z" |
52 | 65 | updated_at:
|
53 | 66 | type: string
|
54 | 67 | format: date-time
|
55 |
| - example: "2020-01-01T00:00:00Z" |
56 |
| - description: "the date and time when the participant was updated" |
| 68 | + readOnly: true |
| 69 | + description: "When the session was last updated" |
| 70 | + example: "2024-01-15T10:30:00Z" |
0 commit comments