Checklist

docs/REST API Reference/Reference.yaml

@@ -1525,11 +1525,14 @@ paths:
   "/easy_checklists.{format}":
     post:
       summary: Create EasyChecklist
+      description: Use this endpoint to create a checklist.<br/>
+       You can also create all checklist items within the checklist straight away. Alternatively you can use endpoint `POST /easy_checklist_item.{format}`
+      operationId: createChecklist
       tags:
       - Easy checklist
       parameters:
       - name: format
-        description: specify format of response
+        description: Specify the format of the response
         in: path
         required: true
         schema:
@@ -1538,7 +1541,7 @@ paths:
           - json
           - xml
       requestBody:
-        description: Create EasyChecklist
+        description: Request body to create EasyChecklist
         required: true
         content:
           application/json:
@@ -1552,7 +1555,7 @@ paths:
               "$ref": "#/components/schemas/EasyChecklistApiRequest"
       responses:
         '201':
-          description: created
+          description: Checklist successfully created
           content:
             application/json:
               schema:
@@ -1592,6 +1595,8 @@ paths:
   "/easy_checklists/{id}.{format}":
     get:
       summary: Get EasyChecklist
+      operationId: getChecklist
+      description: Get a specific checklist by ID. 
       tags:
       - Easy checklist
       parameters:
@@ -1602,7 +1607,7 @@ paths:
         schema:
           type: integer
       - name: format
-        description: specify format of response
+        description: Specify the format of the response
         in: path
         required: true
         schema:
@@ -1612,7 +1617,7 @@ paths:
           - xml
       responses:
         '200':
-          description: detail of EasyChecklist
+          description: Successfully retrived a EasyChecklist
           content:
             application/json:
               schema:
@@ -1642,11 +1647,13 @@ paths:
                 "$ref": "#/components/schemas/ErrorModel"
     put:
       summary: Update EasyChecklist
+      description: Use this endpoint to update a specific checklist using checklist ID.
+      operationId: updateChecklist
       tags:
       - Easy checklist
       parameters:
       - name: format
-        description: specify format of response
+        description: Specify the format of the response
         in: path
         required: true
         schema:
@@ -1661,7 +1668,7 @@ paths:
         schema:
           type: integer
       requestBody:
-        description: Update given EasyChecklist
+        description: Request body to update a EasyChecklist
         required: true
         content:
           application/json:
@@ -1675,7 +1682,7 @@ paths:
               "$ref": "#/components/schemas/EasyChecklistApiRequest"
       responses:
         '200':
-          description: updated
+          description: Successfully updated checklist
           content:
             application/json:
               schema:
@@ -1713,12 +1720,14 @@ paths:
               schema:
                 "$ref": "#/components/schemas/ErrorModel"
     delete:
-      summary: Destroy EasyChecklist
+      summary: Delete EasyChecklist
+      operationId: deleteChecklist
+      description: Use this endpoint to delete a checklist using checklist ID.
       tags:
       - Easy checklist
       parameters:
       - name: format
-        description: specify format of response
+        description: Specify the format of the response
         in: path
         required: true
         schema:
@@ -1734,7 +1743,7 @@ paths:
           type: integer
       responses:
         '204':
-          description: ok
+          description: Successfully deleted checklist
         '401':
           description: not authorized
         '403':
@@ -13399,8 +13408,10 @@ components:
         name:
           example: To do list
           type: string
+          description: Name of the checklist shown to the user
         is_default_for_new_projects:
           type: boolean
+          description: Whether the checklist will be available for all newly created projects
           example: false
         entity_id:
           type: integer
@@ -13410,6 +13421,7 @@ components:
           type: string
         easy_checklist_items_attributes:
           type: array
+          description: List of checklist items represented as objects that populate the checklist.
           xml:
             wrapped: true
           items:
@@ -13420,24 +13432,32 @@ components:
       properties:
         id:
           type: integer
+          description: ID of the checklist
           readOnly: true
           example: 1
         name:
           example: To do list
+          description: Name of the checklist
           type: string
         is_default_for_new_projects:
           type: boolean
           example: false
+          description: Whether the checklist will be available for newly created projects
         author:
           type: object
+          description: Object containing information about the author
           readOnly: true
           properties:
             id:
               type: integer
+              example: 15
+              description: ID of the checklist author within Easy Software
               xml:
                 attribute: true
             name:
               type: string
+              description: Name of the checklist author within Easy Software
+              example: John Doe
               xml:
                 attribute: true
         entity:
@@ -13457,16 +13477,21 @@ components:
               example: Issue
         easy_checklist_items:
           type: array
+          description: List of objects of related checklist items
           xml:
             wrapped: true
           items:
             "$ref": "#/components/schemas/EasyChecklistItemApiResponse"
         created_at:
           type: string
+          description: Datetime when the checklist was created
+          example: 2001-12-15T02:59:43.1Z
           format: date-time
           readOnly: true
         updated_at:
           type: string
+          description: Datetime when the checklist was last updated
+          example: 2001-12-15T02:59:43.1Z
           format: date-time
           readOnly: true
       xml: