#45: Сравнительный анализ API v2 релизов 4.4 и 4.5

Отредактирована: 4 дня назад

Добавились методы:

  • /api/v2/backgroundJobs/{id}/status
  • /api/v2/projects/{projectId}/testPlans/attributes/{attributeId}
  • /api/v2/projects/{projectId}/workItems/search/grouped
  • /api/v2/projects/{projectId}/testPlans/attributes put

в следующих методах изменилось название параметра, сперва идет старый метод, следом - новый:

  • /api/v2/projects/{id}/attributes/templates/{templateId} post, delete
    • /api/v2/projects/{projectId}/attributes/templates/{templateId} post, delete
  • /api/v2/projects/{id}/attributes/templates/search post
    • /api/v2/projects/{projectId}/attributes/templates/search post
  • /api/v2/projects/{id}/attributes get, post, put
    • /api/v2/projects/{projectId}/attributes get, post, put
  • /api/v2/projects/{id}/attributes/search post
    • /api/v2/projects/{projectId}/attributes/search post
  • /api/v2/projects/{id}/attributes/{attributeId} get, delete
    • /api/v2/projects/{projectId}/attributes/{attributeId} get, delete
  • /api/v2/projects/{id}/configurations get
    • /api/v2/projects/{projectId}/configurations get
  • /api/v2/projects/{id}/export/json post
    • /api/v2/projects/{projectId}/export/json post
  • /api/v2/projects/{id}/export/zip post
    • /api/v2/projects/{projectId}/export/zip post
  • /api/v2/projects/{id}/export post
    • /api/v2/projects/{projectId}/export post
  • /api/v2/projects/{id}/export/testPlans/json post
    • /api/v2/projects/{projectId}/export/testPlans/json post
  • /api/v2/projects/{id}/export/testPlans/zip post
    • /api/v2/projects/{projectId}/export/testPlans/zip post
  • /api/v2/projects/{id}/import/json post
    • /api/v2/projects/{projectId}/import/json post
  • /api/v2/projects/{id}/import/zip post
    • /api/v2/projects/{projectId}/import/zip post
  • /api/v2/projects/{id}/import post
    • /api/v2/projects/{projectId}/import post
  • /api/v2/projects/{id}/sections get
    • /api/v2/projects/{projectId}/sections get
  • /api/v2/projects/{id}/testPlans/attributes get, post
    • /api/v2/projects/{projectId}/testPlans/attributes get, post
  • /api/v2/projects/{id}/testPlans/attributes/search post
    • /api/v2/projects/{projectId}/testPlans/attributes/search post
  • /api/v2/projects/{id}/testPlans/search post
    • /api/v2/projects/{projectId}/testPlans/search post
  • /api/v2/projects/{id}/testPlans/{name}/exists get
    • /api/v2/projects/{projectId}/testPlans/{name}/exists get
  • /api/v2/projects/{id}/testPlans/analytics get
    • /api/v2/projects/{projectId}/testPlans/analytics get
  • /api/v2/projects/{id}/testPlans/delete/bulk post
    • /api/v2/projects/{projectId}/testPlans/delete/bulk post
  • /api/v2/projects/{id}/testPlans/restore/bulk post
    • /api/v2/projects/{projectId}/testPlans/restore/bulk post
  • /api/v2/projects/{id}/testPlans/purge/bulk post
    • /api/v2/projects/{projectId}/testPlans/purge/bulk post
  • /api/v2/projects/{id}/workItems get
    • /api/v2/projects/{projectId}/workItems get
  • /api/v2/projects/{id}/workItems/search post
    • /api/v2/projects/{projectId}/workItems/search post
  • /api/v2/projects/{id}/workItems/search/id post
    • /api/v2/projects/{projectId}/workItems/search/id post
  • /api/v2/projects/{id}/workItems/tags get
    • /api/v2/projects/{projectId}/workItems/tags get

Отредактировано описание для следующих методов:

  • /api/v2/configurations/purge/bulk
    • добавили описание для статуса 200
  • /api/v2/configurations/createByParameters
    • обновили саммари
    • обновили описание ошибки 403
    • убрали описание респонса 200
  • /api/v2/parameters
    • убрали описание для статуса 201
    • добавили описание для статуса 200
  • добавили "deprecated": true
    • /api/v2/projects/{id}/testPlans/attribute/{attributeId}
    • /api/v2/projects/{id}/testPlans/attribute
  • добавлены респонсы 400, 401, 404 в документацию
    • /api/v2/workItems/{id}/restore
    • /api/v2/workItems/{id}/purge

Добавлены следующие модели:

  • WorkItemExtractionModel
  • WorkItemGroupGetModel
  • WorkItemGroupModel
  • WorkItemGroupType
  • WorkItemLocalFilterModel
  • WorkItemLocalSelectModel

Изменения в моделях:

  • AttachmentModel
    • Добавлено поле IsTemp
  • AutoTestPutModel
    • id сделали не обязательным, нулабле
  • BackgroundJobGetModel
    • добавили обязательное поле createdDate
  • BackgroundJobType
    • добавили значения "ExportProjects", "ImportProjects"
  • LinkModel, LinkPutModel
    • id сделали не обязательным, нулабле
  • ParameterModel, ParameterPostModel, ParameterPutModel, ParameterShortModel
    • добавили документацию к полям value, name
  • SectionPostModel, SectionPutModel
    • добавили обязательное поле attachments
  • SectionWithStepsModel
    • добавили не обязательное поле attachments, нулабле
  • TestPointByTestSuiteModel, TestPointShortModel
    • в документации поле title изменено на description, расширены значения полей
    • добавлено не обязательное поле workItemMedianDuration
  • WorkItemsExtractionModel
    • переименовано в WorkItemExtractionModel