Research on necessary endpoints for saving homework

[hoshion]

We have such task in our semester's plan:

What does it mean?

We don't have in database such field as "homework". Homework is a description (eventInfo) for exact event of lesson. We need to have an ability to save this event info from bot.

Functionality:

• Save new info into event of this week lesson event or next event of the lesson's sequence, command in DM and Group chat (captain and moderator)
• Edit info of event of this week lesson event or next event of the lesson's sequence, command in DM and Group chat (captain and moderator)
• Delete info of event of this week lesson event or next event of the lesson's sequence, command in DM and Group chat (captain and moderator)
• Show the list of events infos for today, command in DM and Group chat
• Show the list of events infos for next day, command in DM and Group chat
• Show the list of events infos for current week, command in DM and Group chat
• Show the list of events infos for next week, command in DM and Group chat
• Show the list of events infos for exact lesson's event sequence, command in DM and Group chat

The task is to say what endpoints and tables in database should back-end have. It must be fully described with essential requests, responses, fields, queries, data types, etc.

[ke1wi]

To implement the described functionality, we would need this endpoints.

Endpoint:

Save/edit/delete new info into event:

• Endpoint: /v2/schedule/groups/{groupId}/eventInfo/{event_id}
• Method: PATCH
• Path parameters:
  • groupId: Group ID
  • event_id: Event ID
• Query parameters:
  • week: number
• Request Payload:

    {
      "eventInfo": "string"
    }

• Response:

    {
      "status": "success",
      "message": "Event information saved successfully."
    }

Show list of events for exact lesson's event sequence:

• Endpoint: /v2/schedule/groups/{groupId}/eventInfo/{event_id}
• Method: GET
• Path Parameters:
  • groupId: Group ID
  • event_id: Event ID
• Response:

  {
    "period": "enum"
    "startTime": "datestring"
    "endTime": "datestring"
    "url": "string"
    "name": "string"
    "type": "enum"
    "eventInfos": [
      {
        "number": "number"
        "eventInfo": "string"
      },
      // Other eventInfos
    ]
  }