From 53a3f51341e35f1ee3ffce122c5b10fc8e4183bf Mon Sep 17 00:00:00 2001 From: "jan.ricica@dxheroes.io" Date: Mon, 7 Mar 2022 10:31:50 +0100 Subject: [PATCH 1/2] Modified projects --- docs/REST API Reference/Reference.yaml | 176 +++++++++++++++++++------ 1 file changed, 133 insertions(+), 43 deletions(-) diff --git a/docs/REST API Reference/Reference.yaml b/docs/REST API Reference/Reference.yaml index a3e29ad..a9bd923 100644 --- a/docs/REST API Reference/Reference.yaml +++ b/docs/REST API Reference/Reference.yaml @@ -9051,17 +9051,22 @@ paths: "/projects/{id}.{format}": get: summary: Get Project + operationId: GetProject + description: Use this method to get project.
+ To successfully call a method, specify the format of response (format) and ID of the project (id) in the Path.
+ Also, specify the associations you want to be included (include) in the Query (use one of the allowed values.
+ See the schema below. tags: - Project parameters: - name: id in: path - description: ID of Project + description: ID of the project. required: true schema: type: integer - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -9071,8 +9076,7 @@ paths: - xml - name: include description: |- - explicitly specify the associations you want to be included in the query result (separated by a comma) - + Explicitly specify the associations you want to be included in the query result (separated by a comma) * **trackers** (List of enabled trackers on project) * **issue_categories** (List of IssueCategories) * **enabled_modules** (List of enabled project modules) @@ -9087,7 +9091,7 @@ paths: - enabled_modules responses: '200': - description: detail of Project + description: Details of the project. content: application/json: schema: @@ -9230,11 +9234,15 @@ paths: "/projects/{id}/close.{format}": post: summary: Close Project + operationId: CloseProject + description: Use this method to close project.
+ To successfully call a method, specify the format of response (format) and ID of the project (id) in the Path.
+ See the schema below. tags: - Project parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -9244,13 +9252,13 @@ paths: - xml - name: id in: path - description: ID of Project + description: ID of the project. required: true schema: type: string responses: '204': - description: ok + description: The project was closed. '401': description: not authorized '403': @@ -9280,11 +9288,15 @@ paths: "/projects/{id}/reopen.{format}": post: summary: Reopen Project + operationId: ReopenProject + description: Use this method to reopen project.
+ To successfully call a method, specify the format of response (format) and ID of the project (id) in the Path.
+ See the schema below. tags: - Project parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -9294,13 +9306,13 @@ paths: - xml - name: id in: path - description: ID of Project + description: ID of the project. required: true schema: type: string responses: '204': - description: ok + description: The project was reopened. '401': description: not authorized '403': @@ -9330,11 +9342,15 @@ paths: "/projects/{id}/archive.{format}": post: summary: Archive Project + operationId: ArchiveProject + description: Use this method to archive project.
+ To successfully call a method, specify the format of response (format) and ID of the project (id) in the Path.
+ See the schema below. tags: - Project parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -9344,13 +9360,13 @@ paths: - xml - name: id in: path - description: ID of Project + description: ID of the project. required: true schema: type: string responses: '204': - description: ok + description: The project was archived. '401': description: not authorized '403': @@ -9380,11 +9396,15 @@ paths: "/projects/{id}/unarchive.{format}": post: summary: Unarchive Project + operationId: UnarchiveProject + description: Use this method to unarchive project.
+ To successfully call a method, specify the format of response (format) and ID of the project (id) in the Path.
+ See the schema below. tags: - Project parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -9394,13 +9414,13 @@ paths: - xml - name: id in: path - description: ID of Project + description: ID of the project. required: true schema: type: string responses: '204': - description: ok + description: The project was unarchived. '401': description: not authorized '403': @@ -9430,11 +9450,15 @@ paths: "/projects/{id}/favorite.{format}": post: summary: Add Project to favorites + operationId: AddProjectToFavorites + description: Use this method to add project to favorites.
+ To successfully call a method, specify the format of response (format) and ID of the project (id) in the Path.
+ See the schema below. tags: - Project parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -9444,13 +9468,13 @@ paths: - xml - name: id in: path - description: ID of Project + description: ID of the project required: true schema: type: string responses: '204': - description: ok + description: The project was added to favorites. '401': description: not authorized '403': @@ -9480,11 +9504,15 @@ paths: "/projects/{id}/unfavorite.{format}": post: summary: Remove Project from favorites + operationId: RemoveProjectFromFavirotes + description: Use this method to remove project from favorites.
+ To successfully call a method, specify the format of response (format) and ID of the project (id) in the Path.
+ See the schema below. tags: - Project parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -9494,13 +9522,13 @@ paths: - xml - name: id in: path - description: ID of Project + description: ID of the project. required: true schema: type: string responses: '204': - description: ok + description: The project was removed from favorites. '401': description: not authorized '403': @@ -12708,10 +12736,11 @@ components: properties: id: type: integer + description: ID of the custom field. example: 1 value: example: Iron Man - description: value is based on field_format - can be Array, Boolean, Date + description: Value is based on field_format - can be Array, Boolean or Date. type: string xml: name: custom_field_value @@ -12719,14 +12748,17 @@ components: properties: id: type: integer + description: ID of the custom field. readOnly: true example: 1 name: example: Hero list + description: Name of the custom field. readOnly: true type: string internal_name: example: easy_hero_list + description: Internal name of the custom field. readOnly: true type: string field_format: @@ -12760,7 +12792,7 @@ components: - flag type: string value: - description: value is based on field_format - can be Array, Boolean, Date + description: Value is based on field_format - can be Array, Boolean or Date. type: string xml: name: custom_field_value @@ -18835,20 +18867,28 @@ components: properties: easy_external_id: example: external-system-1 + description: Easy external ID of the project. type: string name: example: Blue 2 + description: Name of the project. type: string homepage: example: blue-2 + description: Homepage of the project. type: string description: - example: I can’t abide these Jawas. Disgusting creatures. + example: My project description. type: string + description: Description of the project. parent_id: type: integer + description: Parent ID of the project. + example: 12 author_id: type: integer + description: Author ID of the project. + example: 31 is_planned: type: boolean easy_is_easy_template: @@ -18857,16 +18897,20 @@ components: easy_start_date: format: date type: string + description: Start date of the project. + example: 2021-09-21 easy_due_date: format: date type: string + description: Due date of the project. + example: 2021-01-02 custom_fields: type: array items: "$ref": "#/components/schemas/CustomFieldValueApiRequest" tag_list: type: array - description: List of tags associated with entity + description: List of tags associated with entity. example: - deployment - gantt @@ -18884,7 +18928,12 @@ components: properties: id: type: integer - name: {} + description: Easy priority ID. + example: 21 + name: + type: string + description: Name of the Easy priority ID. + example: My Easy priority ID name. required: - name - author_id @@ -18894,19 +18943,24 @@ components: properties: id: type: integer + description: ID of the project. readOnly: true example: 1 easy_external_id: example: external-system-1 + description: ID of the easy external. type: string name: example: Blue 2 + description: Name of the project. type: string homepage: example: blue-2 + description: Homepage name. type: string description: - example: I can’t abide these Jawas. Disgusting creatures. + example: My description. + description: Description of the project. type: string parent: type: object @@ -18914,10 +18968,14 @@ components: properties: id: type: integer + description: ID of the parent. + example: 12 xml: attribute: true name: type: string + description: Name of the parent. + example: My parent name. xml: attribute: true author: @@ -18926,10 +18984,14 @@ components: properties: id: type: integer + description: ID of the author. + example: 12 xml: attribute: true name: type: string + description: Name of the author. + example: My author name. xml: attribute: true is_planned: @@ -18939,10 +19001,14 @@ components: description: Is this project a template? easy_start_date: format: date + description: Start date of the project. type: string + example: 2019-09-15 easy_due_date: format: date type: string + description: Due date of the project. + example: 2020-02-21 custom_fields: type: array xml: @@ -18951,7 +19017,7 @@ components: "$ref": "#/components/schemas/CustomFieldValueApiResponse" tag_list: type: array - description: List of tags associated with entity + description: List of tags associated with entity. example: - deployment - gantt @@ -18961,11 +19027,11 @@ components: status: readOnly: true enum: - - 1 - - 5 - - 9 - - 15 - - 19 + - "1" + - "5" + - "9" + - "15" + - "19" example: '1' description: |- 1 = ACTIVE @@ -18981,13 +19047,16 @@ components: identifier: readOnly: true example: blue2 + description: Specific indentifier of the project. type: string sum_time_entries: type: integer + description: Total time of enteries. readOnly: true sum_estimated_hours: type: integer readOnly: true + description: Total estimated time. currency: readOnly: true type: string @@ -18995,19 +19064,25 @@ components: type: string format: date-time readOnly: true + description: Date and time when project was created. updated_on: type: string format: date-time readOnly: true + description: Date and time when project was updated. start_date: format: date type: string + description: Start date of the project. + example: 2021-02-03 due_date: format: date type: string + description: Due date of the project. + example: 2022-01-01 trackers: type: array - description: if you specify `include=trackers` + description: If you specify `include=trackers`. items: title: Tracker type: object @@ -19015,19 +19090,23 @@ components: properties: id: type: integer - example: '1' + description: ID of the tracker. + example: 1 name: example: bug + description: Name of the tracker. type: string internal_name: example: easy_bug + description: Internal name of the tracker. type: string easy_external_id: example: easy_bug + description: Easy external ID of the tracker. type: string issue_categories: type: array - description: if you specify `include=issue_categories` + description: If you specify `include=issue_categories`. items: title: IssueCategory type: object @@ -19035,11 +19114,15 @@ components: properties: id: type: integer + description: ID of the issue category. + example: 21 name: type: string + description: Name of the issue category. + example: My issue category name. time_entry_activities: type: array - description: if you specify `include=time_entry_activities` + description: If you specify `include=time_entry_activities`. items: title: TimeEntryActivity type: object @@ -19047,11 +19130,15 @@ components: properties: id: type: integer + description: ID of the time entry activity. + example: 12 name: type: string + description: Name of the time entry activity. + example: My time entry activity. enabled_modules: type: array - description: if you specify `include=enabled_modules` + description: If you specify `include=enabled_modules`. items: title: EnabledModule type: object @@ -19059,17 +19146,20 @@ components: properties: id: type: integer + description: ID of the enabled module. + example: 39 name: type: string + description: Name of the enabled module. scheduled_for_destroy: type: boolean - description: indicates if the project has been scheduled to be deleted + description: Indicates if the project has been scheduled to be deleted. readOnly: true destroy_at: type: string format: date-time - description: the date when the project is expected to be deleted; is shown - only if the project has been scheduled to be deleted + description: The date when the project is expected to be deleted; is shown + only if the project has been scheduled to be deleted. readOnly: true xml: name: project From 78e751de1691c15629d514955532dd36c99ed9b4 Mon Sep 17 00:00:00 2001 From: "jan.ricica@dxheroes.io" Date: Mon, 7 Mar 2022 12:09:15 +0100 Subject: [PATCH 2/2] Modified project - part two --- docs/REST API Reference/Reference.yaml | 101 ++++++++++++++++++------- 1 file changed, 74 insertions(+), 27 deletions(-) diff --git a/docs/REST API Reference/Reference.yaml b/docs/REST API Reference/Reference.yaml index a9bd923..5380774 100644 --- a/docs/REST API Reference/Reference.yaml +++ b/docs/REST API Reference/Reference.yaml @@ -8698,13 +8698,17 @@ paths: "$ref": "#/components/schemas/ErrorModel" "/projects/{project_id}/memberships.{format}": get: - summary: Retrieve memberships of the Project with specified id + summary: Retrieve memberships of the project with specified ID + operationId: RetrieveMembershipsOfTheProjectWithSpecifiedID + description: Use this method to retrieve memberships of the project with specified ID.
+ To successfully call a method, specify the format of response (format) and ID of the project (id) in the Path.
+ See the schema below. tags: - Project membership - Membership parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -8714,7 +8718,7 @@ paths: - xml - name: project_id in: path - description: ID of Project + description: ID of the project. required: true schema: type: integer @@ -8792,13 +8796,18 @@ paths: schema: "$ref": "#/components/schemas/ErrorModel" post: - summary: Create a membership in a Project with specified id + summary: Create a membership in a project with specified ID + operationId: CreateAMembershipInAProjectWithSpecifiedID + description: Use this method to create memberships in a project with specified ID.
+ To successfully call a method, specify the format of response (format) and ID of the project (id) in the Path.
+ Also, specify paramethers of your new membership in the Body.
+ See the schema below. tags: - Project membership - Membership parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -8808,12 +8817,12 @@ paths: - xml - name: project_id in: path - description: ID of Project + description: ID of the project. required: true schema: type: integer requestBody: - description: Create Project membership + description: Create project membership. required: true content: application/json: @@ -8837,7 +8846,7 @@ paths: "$ref": "#/components/schemas/MembershipApiRequest" responses: '201': - description: created + description: Membership was created. content: application/json: schema: @@ -8874,12 +8883,17 @@ paths: "/projects.{format}": get: summary: List of Projects - description: For filtering send parameter `set_filter=1` and specify filters + operationId: ListOfProjects + description: Use this method to list of projects.
+ To successfully call a method, specify the format of response (format) in the Path.
+ Also, specify paramethers in the Query.
+ See the schema below.
+ For filtering send parameter `set_filter=1` and specify filters tags: - Project parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -8888,30 +8902,29 @@ paths: - json - xml - name: easy_query_q - description: free-text filter of current entity + description: Free-text filter of current entity. in: query schema: type: string - name: set_filter - description: enable filter through Easy Query + description: Enable filter through Easy Query. in: query schema: type: boolean - name: limit - description: the number of items to be present in the response (default is - 25, maximum is 100) + description: The number of items to be present in the response. Default is + 25, maximum is 100. in: query schema: type: integer - name: offset - description: the offset of the first object to retrieve + description: The offset of the first object to retrieve. in: query schema: type: integer - name: include description: |- - explicitly specify the associations you want to be included in the query result (separated by a comma) - + Explicitly specify the associations you want to be included in the query result (separated by a comma). * **trackers** (List of enabled trackers on project) * **issue_categories** (List of IssueCategories) * **enabled_modules** (List of enabled project modules) @@ -8984,11 +8997,16 @@ paths: description: not authorized post: summary: Create Project + operationId: CreateProject + description: Use this method to create a new project.
+ To successfully call a method, specify the format of response (format) in the Path.
+ Also, specify paramethers of your new project in the Body.
+ See the schema below. tags: - Project parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -9011,7 +9029,7 @@ paths: "$ref": "#/components/schemas/ProjectApiRequest" responses: '201': - description: created + description: Project was created. content: application/json: schema: @@ -9121,11 +9139,16 @@ paths: "$ref": "#/components/schemas/ErrorModel" put: summary: Update Project + operationId: UpdateProject + description: Use this method to update project.
+ To successfully call a method, specify the format of response (format) and ID of the project (id) in the Path.
+ Also, specify paramethers you want to update in the Body.
+ See the schema below. tags: - Project parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -9135,7 +9158,7 @@ paths: - xml - name: id in: path - description: ID of Project + description: ID of the project. required: true schema: type: integer @@ -9154,7 +9177,7 @@ paths: "$ref": "#/components/schemas/ProjectApiRequest" responses: '200': - description: updated + description: Project was updated. content: application/json: schema: @@ -9192,12 +9215,15 @@ paths: schema: "$ref": "#/components/schemas/ErrorModel" delete: - summary: Destroy Project + summary: Delete Project + operationId: DeleteProject + description: Use this method to delete project.
+ To successfully call a method, specify the format of response (format) and ID of the project (id) in the Path.
tags: - Project parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -9207,13 +9233,13 @@ paths: - xml - name: id in: path - description: ID of Project + description: ID of the project. required: true schema: type: integer responses: '204': - description: ok + description: Project was deleted. '401': description: not authorized '403': @@ -18792,7 +18818,7 @@ components: type: integer role_ids: type: array - description: IDs of roles + description: IDs of roles. items: type: integer xml: @@ -18801,6 +18827,7 @@ components: properties: id: type: integer + description: ID of the membership. readOnly: true example: 1 project: @@ -18809,10 +18836,14 @@ components: properties: id: type: integer + description: ID of the project. + example: 21 xml: attribute: true name: type: string + description: Name of the project. + example: My project name. xml: attribute: true user: @@ -18821,10 +18852,14 @@ components: properties: id: type: integer + description: ID of the user. + example: 12 xml: attribute: true name: type: string + description: Name of the user. + example: My user name. xml: attribute: true group: @@ -18833,10 +18868,14 @@ components: properties: id: type: integer + description: ID of the group. + example: 12 xml: attribute: true name: type: string + description: Name of the group. + example: Name of the group. xml: attribute: true roles: @@ -18849,17 +18888,25 @@ components: properties: id: type: integer + description: ID of the role. + example: 93 name: type: string + description: Name of the role. + example: My role name. inherited: type: boolean + description: Role is inherited. + example: true created_at: type: string format: date-time + description: Date and time when membership was created. readOnly: true updated_at: type: string format: date-time + description: Date and time when membership was updated. readOnly: true xml: name: membership