From 190b7c742b76384a1440fa0a6ba7cdc3ad5b9cc3 Mon Sep 17 00:00:00 2001 From: "jze@dxheroes.io" Date: Thu, 3 Mar 2022 15:56:13 +0100 Subject: [PATCH 1/3] Modified docs/REST API Reference/Reference.yaml --- docs/REST API Reference/Reference.yaml | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/REST API Reference/Reference.yaml b/docs/REST API Reference/Reference.yaml index a3e29ad..820f925 100644 --- a/docs/REST API Reference/Reference.yaml +++ b/docs/REST API Reference/Reference.yaml @@ -1345,11 +1345,13 @@ paths: "/easy_checklist_items.{format}": post: summary: Create EasyChecklistItem + operationId: createCheclistItem + description: Create a new checklist item. Checklist item created this way can be found in the specified checklist. tags: - Easy checklist item parameters: - name: format - description: specify format of response + description: Specify the format of the response in: path required: true schema: @@ -1358,7 +1360,7 @@ paths: - json - xml requestBody: - description: Create EasyChecklistItem + description: Request body to create EasyChecklistItem required: true content: application/json: @@ -1372,7 +1374,7 @@ paths: "$ref": "#/components/schemas/EasyChecklistItemApiRequest" responses: '201': - description: created + description: Successfully created checklist item content: application/json: schema: @@ -1412,11 +1414,13 @@ paths: "/easy_checklist_items/{id}.{format}": put: summary: Update EasyChecklistItem + description: Update a specific checklist item. The updated checklist item can be found in the specified checklist + operationId: updateChecklistItem tags: - Easy checklist item parameters: - name: format - description: specify format of response + description: Specify the format of the response in: path required: true schema: From cd6570069cf41e985b84141e499da2178bfdbfe0 Mon Sep 17 00:00:00 2001 From: "jze@dxheroes.io" Date: Fri, 4 Mar 2022 14:28:16 +0100 Subject: [PATCH 2/3] Modified docs/REST API Reference/Reference.yaml --- docs/REST API Reference/Reference.yaml | 30 ++++++++++++++++++-------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/docs/REST API Reference/Reference.yaml b/docs/REST API Reference/Reference.yaml index 820f925..8ec035c 100644 --- a/docs/REST API Reference/Reference.yaml +++ b/docs/REST API Reference/Reference.yaml @@ -1435,7 +1435,7 @@ paths: schema: type: integer requestBody: - description: Update given EasyChecklistItem + description: Request update body of EasyChecklistItem required: true content: application/json: @@ -1449,7 +1449,7 @@ paths: "$ref": "#/components/schemas/EasyChecklistItemApiRequest" responses: '200': - description: updated + description: Successfully updated checklist item content: application/json: schema: @@ -1487,12 +1487,14 @@ paths: schema: "$ref": "#/components/schemas/ErrorModel" delete: - summary: Destroy EasyChecklistItem + summary: Delete EasyChecklistItem + operationId: deleteChecklistItem + description: Use this endpoint to delete a specific checklist item. tags: - Easy checklist item parameters: - name: format - description: specify format of response + description: Specify format of the response in: path required: true schema: @@ -1508,7 +1510,7 @@ paths: type: integer responses: '204': - description: ok + description: Successfully deleted checklist item '401': description: not authorized '403': @@ -13403,6 +13405,7 @@ components: name: example: To do list type: string + desciption: aa is_default_for_new_projects: type: boolean example: false @@ -13478,17 +13481,21 @@ components: EasyChecklistItemApiRequest: properties: subject: - example: Need to do + example: Buy groceries type: string + description: Description of the item to be done done: type: boolean - description: Is this done item? + description: Whether the checklist item has been marked as done example: false easy_checklist_id: type: integer + description: ID of the checklist this item relates to + example: 22 new_position: type: integer example: 1 + description: Position of the item within the list. If not filled in, the item is put at the end of the list. xml: name: easy_checklist_item EasyChecklistItemApiRequestFromChecklists: @@ -13514,21 +13521,26 @@ components: properties: id: type: integer + description: ID of the checklist item readOnly: true example: 1 subject: - example: Need to do + example: Buy groceries + description: Description of the item to be done type: string done: type: boolean - description: Is this done item? + description: Whether the checklist item has been marked as done example: false author: type: object + description: Object describing author information readOnly: true properties: id: type: integer + description: ID of the user who created the checklist item + example: 17 xml: attribute: true name: From b628c3178214d9b70a274bc35eb4e803ac77a6d8 Mon Sep 17 00:00:00 2001 From: "jze@dxheroes.io" Date: Fri, 4 Mar 2022 14:45:25 +0100 Subject: [PATCH 3/3] Modified docs/REST API Reference/Reference.yaml --- docs/REST API Reference/Reference.yaml | 28 +++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/REST API Reference/Reference.yaml b/docs/REST API Reference/Reference.yaml index 8ec035c..d516370 100644 --- a/docs/REST API Reference/Reference.yaml +++ b/docs/REST API Reference/Reference.yaml @@ -13405,7 +13405,6 @@ components: name: example: To do list type: string - desciption: aa is_default_for_new_projects: type: boolean example: false @@ -13509,9 +13508,9 @@ components: example: false id: type: integer - description: Optional. Specify only to update an item in checklist. - example: 1 (Optional. Specify only to update an item with 'id' in checklist. - Skip this attribute for create new element in checklist.) + description: Optional. Specify only to update an item with 'id' in checklist. + Skip this attribute for create new element in checklist. + example: 1 new_position: type: integer example: 1 @@ -13534,7 +13533,7 @@ components: example: false author: type: object - description: Object describing author information + description: Object describing information about author readOnly: true properties: id: @@ -13545,41 +13544,58 @@ components: attribute: true name: type: string + description: Name of the user who created the checklist item + example: John Doe xml: attribute: true changed_by: type: object + description: Object describing information about user who last updated the checklist item. readOnly: true properties: id: type: integer + description: ID of the user in Easy Software who last updated the checklist item + example: 15 xml: attribute: true name: type: string + description: Name of the user who last updated the checklist item + example: John Doe xml: attribute: true easy_checklist: type: object + description: Object describing information about checklist which checklist item is a part of readOnly: true properties: id: type: integer + description: ID of the checklist the item is a part of + example: 5 xml: attribute: true name: type: string + description: Name of the checklist the item is a part of + example: Agenda for this week xml: attribute: true position: type: integer example: 1 + description: Position of the checklist item within the checklist. If not filled in, the item is placed as the last in the list created_at: type: string format: date-time + description: Datetime when the checklist item was created + example: 2001-12-15T02:59:43.1Z readOnly: true updated_at: type: string + description: Datetime when the checklist item was last updated + example: 2001-12-15T02:59:43.1Z format: date-time readOnly: true xml: @@ -20162,3 +20178,5 @@ components: type: apiKey name: key in: query +ey + in: query