MrRefactoring / jira.js

A JavaScript/TypeScript wrapper for the JIRA Cloud, Service Desk and Agile REST API

Home Page:https://mrrefactoring.github.io/jira.js/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Improving Avatar API's

MrRefactoring opened this issue · comments

As we approach the release of version 3.0.0, several endpoints within the Avatar API need improvements. Here's a list of the endpoints and their corresponding tasks:

  • storeAvatar: Add the avatar to the request body. This entails:
  1. Updating the parameter model
  2. Configuring to include the 'body' property
  1. The return type needs to be updated to Models.AvatarWithDetails.
  2. The endpoint should be adapted to deliver a response based on the new model.
  3. The responseType should be changed to arraybuffer.
    For reference on these changes, please consult this development PR.
  1. The return type needs to be updated to Models.AvatarWithDetails.
  2. The endpoint should be adapted to deliver a response based on the new model.
  3. The responseType should be changed to arraybuffer.
    For reference on these changes, please consult this development PR.
  • Avatar model: Need to specify and clarify which properties within this model are mandatory.

Please make changes for both versions of API (Version2 and Version3)

Please create PR's to v3.0.0 branch