From 8c508bbde71b7ede8c9a0b62f6d18441903db85b Mon Sep 17 00:00:00 2001 From: "jze@dxheroes.io" Date: Fri, 4 Mar 2022 14:57:21 +0100 Subject: [PATCH 1/6] Modified docs/REST API Reference/Reference.yaml --- docs/REST API Reference/Reference.yaml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/REST API Reference/Reference.yaml b/docs/REST API Reference/Reference.yaml index a3e29ad..50a08d4 100644 --- a/docs/REST API Reference/Reference.yaml +++ b/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.
+ You can also create all checklist items within the checklist straight away. Alternatively you can use endpoint [POST /easy_checklist_item.{format}](#easy_checklist_items.{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: From f36962cc4ce913e8da88bd9eebaa178f4fcc48ae Mon Sep 17 00:00:00 2001 From: "jze@dxheroes.io" Date: Fri, 4 Mar 2022 15:04:21 +0100 Subject: [PATCH 2/6] Modified docs/REST API Reference/Reference.yaml --- docs/REST API Reference/Reference.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/REST API Reference/Reference.yaml b/docs/REST API Reference/Reference.yaml index 50a08d4..3b0de80 100644 --- a/docs/REST API Reference/Reference.yaml +++ b/docs/REST API Reference/Reference.yaml @@ -1526,7 +1526,7 @@ paths: post: summary: Create EasyChecklist description: Use this endpoint to create a checklist.
- You can also create all checklist items within the checklist straight away. Alternatively you can use endpoint [POST /easy_checklist_item.{format}](#easy_checklist_items.{format}) + You can also create all checklist items within the checklist straight away. Alternatively you can use endpoint [POST /easy_checklist_item.{format}](https://easysoftware.stoplight.io/docs/developer-portal-integrators/docs/REST%20API%20Reference/Reference.yaml#easy_checklist_items.{format}) operationId: createChecklist tags: - Easy checklist From 7bb9409661836c6ed8483c0279ba54b8b2d490d6 Mon Sep 17 00:00:00 2001 From: "jze@dxheroes.io" Date: Fri, 4 Mar 2022 15:05:55 +0100 Subject: [PATCH 3/6] Modified docs/REST API Reference/Reference.yaml --- docs/REST API Reference/Reference.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/REST API Reference/Reference.yaml b/docs/REST API Reference/Reference.yaml index 3b0de80..494c1a1 100644 --- a/docs/REST API Reference/Reference.yaml +++ b/docs/REST API Reference/Reference.yaml @@ -1526,7 +1526,7 @@ paths: post: summary: Create EasyChecklist description: Use this endpoint to create a checklist.
- You can also create all checklist items within the checklist straight away. Alternatively you can use endpoint [POST /easy_checklist_item.{format}](https://easysoftware.stoplight.io/docs/developer-portal-integrators/docs/REST%20API%20Reference/Reference.yaml#easy_checklist_items.{format}) + You can also create all checklist items within the checklist straight away. Alternatively you can use endpoint [POST /easy_checklist_item.{format}](docs/REST API Reference/Reference.yaml/paths/~1easy_checklist_items.{format}) operationId: createChecklist tags: - Easy checklist From 73d38c6562e6238759907bdf7d9a20fc168ac84f Mon Sep 17 00:00:00 2001 From: "jze@dxheroes.io" Date: Fri, 4 Mar 2022 15:09:13 +0100 Subject: [PATCH 4/6] Modified docs/REST API Reference/Reference.yaml --- docs/REST API Reference/Reference.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/REST API Reference/Reference.yaml b/docs/REST API Reference/Reference.yaml index 494c1a1..41c85b6 100644 --- a/docs/REST API Reference/Reference.yaml +++ b/docs/REST API Reference/Reference.yaml @@ -1526,7 +1526,8 @@ paths: post: summary: Create EasyChecklist description: Use this endpoint to create a checklist.
- You can also create all checklist items within the checklist straight away. Alternatively you can use endpoint [POST /easy_checklist_item.{format}](docs/REST API Reference/Reference.yaml/paths/~1easy_checklist_items.{format}) + You can also create all checklist items within the checklist straight away. Alternatively you can use endpoint + [POST /easy_checklist_item.{format}](Reference.yaml/paths/~1easy_checklist_items.{format}) operationId: createChecklist tags: - Easy checklist From c7dfc708c4ce32134d6c2d91fd47b61d0fd20189 Mon Sep 17 00:00:00 2001 From: "jze@dxheroes.io" Date: Fri, 4 Mar 2022 15:45:53 +0100 Subject: [PATCH 5/6] Modified docs/REST API Reference/Reference.yaml --- docs/REST API Reference/Reference.yaml | 32 ++++++++++++++++++-------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/docs/REST API Reference/Reference.yaml b/docs/REST API Reference/Reference.yaml index 41c85b6..d08c71d 100644 --- a/docs/REST API Reference/Reference.yaml +++ b/docs/REST API Reference/Reference.yaml @@ -1526,8 +1526,7 @@ paths: post: summary: Create EasyChecklist description: Use this endpoint to create a checklist.
- You can also create all checklist items within the checklist straight away. Alternatively you can use endpoint - [POST /easy_checklist_item.{format}](Reference.yaml/paths/~1easy_checklist_items.{format}) + 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 @@ -1596,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: @@ -1606,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: @@ -1616,7 +1617,7 @@ paths: - xml responses: '200': - description: detail of EasyChecklist + description: Successfully retrived a EasyChecklist content: application/json: schema: @@ -1646,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: tags: - Easy checklist parameters: - name: format - description: specify format of response + description: Specify the format of the response in: path required: true schema: @@ -1665,7 +1668,7 @@ paths: schema: type: integer requestBody: - description: Update given EasyChecklist + description: Request body to update a EasyChecklist required: true content: application/json: @@ -1679,7 +1682,7 @@ paths: "$ref": "#/components/schemas/EasyChecklistApiRequest" responses: '200': - description: updated + description: Successfully updated checklist content: application/json: schema: @@ -1717,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 ID. tags: - Easy checklist parameters: - name: format - description: specify format of response + description: Specify the format of the response in: path required: true schema: @@ -1738,7 +1743,7 @@ paths: type: integer responses: '204': - description: ok + description: Successfully deleted checklist '401': description: not authorized '403': @@ -13403,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 @@ -13414,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: @@ -13424,16 +13432,20 @@ 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: From defab569fddcad7716c0413309f7080829a9fd71 Mon Sep 17 00:00:00 2001 From: "jze@dxheroes.io" Date: Sun, 6 Mar 2022 15:06:33 +0100 Subject: [PATCH 6/6] Modified docs/REST API Reference/Reference.yaml --- docs/REST API Reference/Reference.yaml | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/REST API Reference/Reference.yaml b/docs/REST API Reference/Reference.yaml index d08c71d..596e7fe 100644 --- a/docs/REST API Reference/Reference.yaml +++ b/docs/REST API Reference/Reference.yaml @@ -1648,7 +1648,7 @@ paths: put: summary: Update EasyChecklist description: Use this endpoint to update a specific checklist using checklist ID. - operationId: + operationId: updateChecklist tags: - Easy checklist parameters: @@ -1722,7 +1722,7 @@ paths: delete: summary: Delete EasyChecklist operationId: deleteChecklist - description: Use this endpoint to delete a checklist using ID. + description: Use this endpoint to delete a checklist using checklist ID. tags: - Easy checklist parameters: @@ -13450,10 +13450,14 @@ components: 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: @@ -13473,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: