MrRefactoring / jira.js

A JavaScript/TypeScript wrapper for the JIRA Cloud, Service Desk and Agile REST API
https://mrrefactoring.github.io/jira.js/
MIT License
381 stars 53 forks source link

parameter docs returning 404s #165

Closed valentijnscholten closed 3 years ago

valentijnscholten commented 3 years ago

Hi,

I was trying to find out how to provide the parameters to functions that require both a path parameter and some body parameters, linke jira.issueWatchers.addWatcher().

The readme/docs point to https://mrrefactoring.github.io/jira.js/#decreasing-webpack-bundle-size. This has a list of links on the right side of the page, most of which return a 404 directly or after clicking through to the models/parameters.

i.e. version2/parameters/addWatcher points to https://mrrefactoring.github.io/jira.js/modules/version2_parameters_addWatcher.html which returns a 404.

agile/issue points to https://mrrefactoring.github.io/jira.js/modules/agile_issue.html which points to https://mrrefactoring.github.io/jira.js/classes/agile_issue.Issue.html which returns a 404.

Or am I missing something and should I look for the paramater specs somewhere else?

As stated I am looking to add a watcher to an issue.

Valentijn

valentijnscholten commented 3 years ago

BTW when looking at the source I don't think I can supply a username or user id, it only seems to support adding the "logged in user" as a watcher?

https://github.com/MrRefactoring/jira.js/blob/8c1b61eef1129c2081ab2d6acb2258b0730b6991/src/version2/issueWatchers.ts#L74

MrRefactoring commented 3 years ago

Hi @valentijnscholten! Yeah, you can add only logged user as a watcher. And I agree we have problems with docs

MrRefactoring commented 3 years ago

I fixed documentation. But it’s temporary fix and I need a little more time to finally complete