diff --git a/docs/REST API Reference/Reference.yaml b/docs/REST API Reference/Reference.yaml index a3e29ad..89ffaf3 100644 --- a/docs/REST API Reference/Reference.yaml +++ b/docs/REST API Reference/Reference.yaml @@ -10665,12 +10665,16 @@ paths: "/test_cases.{format}": get: summary: List of TestCases - description: For filtering send parameter `set_filter=1` and specify filters + operationId: ListOfTestCases + description: Use this method to get list of test cases.
+ To successfully call a method, specify the format of response (format) in the Path and specific parameters into the Query.
+ As a response, you can see list of test cases. The number of test cases depends on limit parameters.
+ See the schema below. tags: - Test case parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -10679,29 +10683,29 @@ paths: - json - xml - name: easy_query_q - description: free-text filter of current entity + description: Free-text filter of the 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 responses: '200': - description: ok + description: OK content: application/json: schema: @@ -10713,15 +10717,18 @@ paths: total_count: type: number example: 75 + description: Total count of test cases. xml: attribute: true offset: type: number + description: Test case offset. example: 0 xml: attribute: true limit: type: number + description: Current limit of test cases. example: 25 xml: attribute: true @@ -10739,16 +10746,19 @@ paths: total_count: type: number example: 75 + description: Total count of test cases. xml: attribute: true offset: type: number + description: Test case offset. example: 0 xml: attribute: true limit: type: number example: 25 + description: Current limit of test cases. xml: attribute: true test_cases: @@ -10759,11 +10769,16 @@ paths: description: not authorized post: summary: Create TestCase + operationId: CreateTestCase + description: Use this method to create new test case.
+ To successfully call a method, specify the format of response (format) in the Path and fill all possible parameters to the Body.
+ As a response, you can see your created test case.
+ See the schema below. tags: - Test case parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -10772,7 +10787,7 @@ paths: - json - xml requestBody: - description: Create TestCase + description: Parameters to create test case. required: true content: application/json: @@ -10786,7 +10801,7 @@ paths: "$ref": "#/components/schemas/TestCaseApiRequest" responses: '201': - description: created + description: Test case was created. content: application/json: schema: @@ -10826,17 +10841,22 @@ paths: "/test_cases/{id}.{format}": get: summary: Get TestCase + operationId: GetTestCase + description: Use this method to get details about test case.
+ To successfully call a method, specify the format of response (format) and ID of the test case (id) in the Path.
+ As a response, you can see the details of your current test case.
+ See the schema below. tags: - - Test case + - Test case parameters: - name: id in: path - description: ID of TestCase + description: ID of the test case. required: true schema: type: integer - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -10846,7 +10866,7 @@ paths: - xml responses: '200': - description: detail of TestCase + description: Details of the test case. content: application/json: schema: @@ -10876,11 +10896,16 @@ paths: "$ref": "#/components/schemas/ErrorModel" put: summary: Update TestCase + operationId: UpdateTestCase + description: Use this method to update details about the test case.
+ To successfully call a method, specify the format of response (format), ID of the test case (id) in the Path and parameters you want to update to the Body.
+ As a response, you can see your updated test case details.
+ See the schema below. tags: - Test case parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -10890,12 +10915,12 @@ paths: - xml - name: id in: path - description: ID of TestCase + description: ID of the test case. required: true schema: type: integer requestBody: - description: Update given TestCase + description: Parameters to update test case. required: true content: application/json: @@ -10909,7 +10934,7 @@ paths: "$ref": "#/components/schemas/TestCaseApiRequest" responses: '200': - description: updated + description: Test case was updated. content: application/json: schema: @@ -10947,12 +10972,15 @@ paths: schema: "$ref": "#/components/schemas/ErrorModel" delete: - summary: Destroy TestCase + summary: Delete TestCase + operationId: DeleteTestCase + description: Use this method to delete test case.
+ To successfully call a method, specify the format of response (format), ID of the test plan in the Path.
tags: - Test case parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -10962,13 +10990,13 @@ paths: - xml - name: id in: path - description: ID of TestCase + description: ID of the test case. required: true schema: type: integer responses: '204': - description: ok + description: Test case was deleted. '401': description: not authorized '403': @@ -10989,12 +11017,16 @@ paths: "/test_plans.{format}": get: summary: List of TestPlans - description: For filtering send parameter `set_filter=1` and specify filters + operationId: ListOfTestPlans + description: Use this method to get list of test plans.
+ To successfully call a method, specify the format of response (format) in the Path and specific parameters into the Query.
+ As a response, you can see list of test plans. The number of test plans depends on limit parameters.
+ See the schema below. tags: - Test plan parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -11003,29 +11035,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 responses: '200': - description: ok + description: OK content: application/json: schema: @@ -11036,16 +11068,19 @@ paths: properties: total_count: type: number + description: Total count of the test plans. example: 75 xml: attribute: true offset: type: number + description: Test plans offset. example: 0 xml: attribute: true limit: type: number + description: Current limit of test plans. example: 25 xml: attribute: true @@ -11083,11 +11118,16 @@ paths: description: not authorized post: summary: Create TestPlan + operationId: CreateTestPlan + description: Use this method to create new test plan.
+ To successfully call a method, specify the format of response (format) in the Path and fill all possible parameters to the Body.
+ As a response, you can see your created test plan.
+ See the schema below. tags: - Test plan parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -11096,7 +11136,7 @@ paths: - json - xml requestBody: - description: Create TestPlan + description: Test plan parameters required: true content: application/json: @@ -11110,7 +11150,7 @@ paths: "$ref": "#/components/schemas/TestPlanApiRequest" responses: '201': - description: created + description: Test plan was created. content: application/json: schema: @@ -11150,17 +11190,22 @@ paths: "/test_plans/{id}.{format}": get: summary: Get TestPlan + operationId: GetTestPlan + description: Use this method to get details about test plan.
+ To successfully call a method, specify the format of response (format) and ID of the test plan in the Path.
+ As a response, you can see the details of your current test plan.
+ See the schema below. tags: - Test plan parameters: - name: id in: path - description: ID of TestPlan + description: ID of the test plan. required: true schema: type: integer - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -11170,7 +11215,7 @@ paths: - xml responses: '200': - description: detail of TestPlan + description: Details of the TestPlan. content: application/json: schema: @@ -11200,11 +11245,16 @@ paths: "$ref": "#/components/schemas/ErrorModel" put: summary: Update TestPlan + operationId: UpdatedTestPlan + description: Use this method to update details about the test plan.
+ To successfully call a method, specify the format of response (format), ID of the test plan (id) in the Path and parameters you want to update to the Body.
+ As a response, you can see your updated test plan details.
+ See the schema below. tags: - Test plan parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -11214,7 +11264,7 @@ paths: - xml - name: id in: path - description: ID of TestPlan + description: ID of the test plan. required: true schema: type: integer @@ -11271,12 +11321,15 @@ paths: schema: "$ref": "#/components/schemas/ErrorModel" delete: - summary: Destroy TestPlan + summary: Delete TestPlan + operationId: DeleteTestPlan + description: Use this method to delete test plan.
+ To successfully call a method, specify the format of response (format), ID of the test plan in the Path.
tags: - Test plan parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -11286,13 +11339,13 @@ paths: - xml - name: id in: path - description: ID of TestPlan + description: ID of the test plan. required: true schema: type: integer responses: '204': - description: ok + description: Test plan was deleted. '401': description: not authorized '403': @@ -11312,13 +11365,17 @@ paths: "$ref": "#/components/schemas/ErrorModel" "/time_entries.{format}": get: - summary: List of TimeEntries - description: For filtering send parameter `set_filter=1` and specify filters + summary: List of time enteries + operationId: ListOfTimeEnteries + description: Use this method to get list of time entries.
+ To successfully call a method, specify the format of response (format) and in the Path and fill all parameters into the Query.
+ An object with all time entries details is returned in the API call response.
+ See the schema below. tags: - Time entry parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -11327,23 +11384,23 @@ 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. Fefault 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 @@ -11360,16 +11417,19 @@ paths: properties: total_count: type: number + description: Total count of time enteries. example: 75 xml: attribute: true offset: type: number + description: Time enteries offset. example: 0 xml: attribute: true limit: type: number + description: Limit of list time enteries. example: 25 xml: attribute: true @@ -11386,16 +11446,19 @@ paths: properties: total_count: type: number + description: Total count of time enteries. example: 75 xml: attribute: true offset: type: number + description: Time enteries offset. example: 0 xml: attribute: true limit: type: number + description: Limit of list time enteries. example: 25 xml: attribute: true @@ -11406,12 +11469,17 @@ paths: '401': description: not authorized post: - summary: Create TimeEntry + summary: Create time entry + operationId: CreateTimeEntry + description: Use this method to create new time entry.
+ To successfully call a method, specify the format of response (format) and in the Path and fill all parameters into the Body.
+ As a response, you can see the result of your new time entry with all possible parameters..
+ See the schema below. tags: - Time entry parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -11420,7 +11488,7 @@ paths: - json - xml requestBody: - description: Create TimeEntry + description: Create new time entry. required: true content: application/json: @@ -11434,7 +11502,7 @@ paths: "$ref": "#/components/schemas/TimeEntryApiRequest" responses: '201': - description: created + description: Time entry was created. content: application/json: schema: @@ -11523,12 +11591,17 @@ paths: schema: "$ref": "#/components/schemas/ErrorModel" put: - summary: Update TimeEntry + summary: Update time entry + description: Use this method to update details about time entry.
+ To successfully call a method, specify the format of response (format) and ID of the time entry (id) in the Path.
+ An object with all possible details about time entry is returned in the API call response.
+ See the schema below. + operationId: UpdateTimeEntry tags: - Time entry parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -11538,12 +11611,12 @@ paths: - xml - name: id in: path - description: ID of TimeEntry + description: ID of the time entry. required: true schema: type: integer requestBody: - description: Update given TimeEntry + description: Parameters to update time entry. required: true content: application/json: @@ -11557,7 +11630,7 @@ paths: "$ref": "#/components/schemas/TimeEntryApiRequest" responses: '200': - description: updated + description: Time entry was updated. content: application/json: schema: @@ -11595,12 +11668,15 @@ paths: schema: "$ref": "#/components/schemas/ErrorModel" delete: - summary: Destroy TimeEntry + summary: Delete time entry + operationId: DeleteTimeEntry + description: Use this method to delete time entry.
+ To successfully call a method, specify the format of response (format) and ID of the time entry (id) in the Path.
tags: - Time entry parameters: - name: format - description: specify format of response + description: Specify format of the response. in: path required: true schema: @@ -11610,13 +11686,13 @@ paths: - xml - name: id in: path - description: ID of TimeEntry + description: ID of the time entry. required: true schema: type: integer responses: '204': - description: ok + description: Time entry was deleted. '401': description: not authorized '403': @@ -12708,10 +12784,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 + example: Your value. + description: Value is based on field_format - can be Array, Boolean or Date. type: string xml: name: custom_field_value @@ -12719,18 +12796,22 @@ components: properties: id: type: integer + description: ID of the custom field value. readOnly: true example: 1 name: example: Hero list + description: Name of the custom field value. readOnly: true type: string internal_name: example: easy_hero_list + description: Internal name of the custom field. readOnly: true type: string field_format: readOnly: true + description: Specific format of the field. Choose one of the allowed values. enum: - string - text @@ -12760,7 +12841,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. It can be Array, Boolean or Date. type: string xml: name: custom_field_value @@ -19269,14 +19350,23 @@ components: properties: project_id: type: integer + description: ID of the project. + example: 1 author_id: type: integer + description: ID of the author. + example: 21 name: type: string + description: Name of the test case. + example: My test case. scenario: type: string + description: Test case scenario. + example: This is my scenario for test case. expected_result: type: string + description: What you expect as a result of your test case. issue_ids: type: array items: @@ -19305,6 +19395,7 @@ components: properties: id: type: integer + description: ID of the test case. readOnly: true example: 1 project: @@ -19313,10 +19404,14 @@ components: properties: id: type: integer + description: ID of the project. + example: 12 xml: attribute: true name: type: string + description: Name of the project. + example: My project name. xml: attribute: true author: @@ -19325,18 +19420,27 @@ components: properties: id: type: integer + description: ID of the author. + example: 12 xml: attribute: true name: type: string + description: Name of the author. + example: Author name. xml: attribute: true name: type: string + description: Name of the test case. + example: My test case name. scenario: type: string + description: Test case scenario. + example: This is my scenario for test case. expected_result: type: string + description: What you expect as a result of your test case. issue_ids: type: array items: @@ -19472,10 +19576,13 @@ components: properties: project_id: type: integer + description: ID of the project. author_id: type: integer + description: ID of the author. name: type: string + description: Name of the test plan. issue_ids: type: array items: @@ -19497,6 +19604,7 @@ components: properties: id: type: integer + description: ID of the test plan. readOnly: true example: 1 project: @@ -19505,10 +19613,12 @@ components: properties: id: type: integer + description: ID of the project. xml: attribute: true name: type: string + description: Name of the project. xml: attribute: true author: @@ -19517,14 +19627,17 @@ components: properties: id: type: integer + description: ID of the author. xml: attribute: true name: type: string + description: Name of the author. xml: attribute: true name: type: string + description: Name of the test plan. issue_ids: type: array items: @@ -19545,39 +19658,47 @@ components: properties: project_id: type: integer + description: ID of the project. issue_id: type: integer + description: ID of the issue. user_id: type: integer + description: ID of the user. priority_id: type: integer + description: ID of the priority. activity_id: type: integer + description: ID of the activity. easy_external_id: type: string + description: ID of the Easy external. hours: example: '8' - description: Amount of spent hours + description: Amount of spent hours. type: string spent_on: format: date example: '2019-07-09' - description: Date of spent time. It can be limited by global setting + description: Date of spent time. It can be limited by global setting. type: string comments: - example: I work very hard + example: I work mostly at the night. type: string easy_is_billable: type: boolean + description: True/false decision if you want to invoice the work. easy_billed: type: boolean + description: True/false decision if your work was invoiced by Easy. 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