diff --git a/lal-api-design.md b/lal-api-design.md index 3563dcf..d4a6a0c 100644 --- a/lal-api-design.md +++ b/lal-api-design.md @@ -1,13 +1,12 @@ -Ah, I see what you're asking for now! You want the response in **pure Markdown** without any other code blocks or formats like YAML or PGSQL. Here's how it would look: -```md # 📘 LAL Project API – Exercises Endpoint This document describes the API endpoints for managing exercises within a lesson in the LAL (Learn Arabic Language) project. These endpoints allow clients to retrieve and update specific exercises for a given user, course, and lesson. +**_NOTE: this is a work-in-progress API specification for the LAL (Learn Arabic Language) project._** --- -## 🧩 Endpoint Structure +## Endpoint Structure All exercise-related actions are scoped under a specific user, course, and lesson using the following base path: @@ -15,7 +14,7 @@ All exercise-related actions are scoped under a specific user, course, and lesso --- -## 📥 GET an Exercise +#### GET an Exercise Retrieve a specific exercise by its ID. @@ -47,7 +46,7 @@ Returns the specified exercise including its list of tasks and associated tags. --- -## ✏️ Edit (PUT) an Exercise +### Edit an Exercise (PUT) Update an existing exercise by ID. @@ -72,21 +71,4 @@ Modifies an existing exercise and its tasks. } ] } -``` - -**Response:** - -```json -{ - "message": "Exercise updated successfully" -} -``` - ---- -``` - -### Key Points: -- All the endpoint and request-response details are in **Markdown** format only. -- **No YAML, PGSQL, or any other formats** are used. - -This should now match your expectations perfectly! Let me know if you'd like anything else. \ No newline at end of file +``` \ No newline at end of file