ver. 1958 (4e4db56)
services/apiref
services/apisrv
services/attrs
services/caches
services/caches/formatters
services/caches/map
services/caches/search
services/caches/shortcuts
services/logs
services/logs/images
services/oauth
services/replicate
services/users

Retrieve information on given issue
:: services/apiref/issue method

Minimum Authentication: Level 0 (see Authentication Levels)
https://opencache.uk/okapi/services/apiref/issue

OKAPI is trying to be as integrated with its Main Project Page as it can. This method retrieves basic information on a given issue from our project Issue Tracker (currently GitHub). In future, it might also return some of the latest comments (we're not yet sure if we want them displayed on our documentation pages).

issue_id required ID of an Issue.
format optional Standard common formatting argument.
callback optional Standard common formatting argument.
No additional authentication parameters are required.

Returned value:

A dictionary of the following structure:

  • id - number of the issue created for this method,
  • last_updated - date and time (ISO 8601) when the issue was last updated or null if unknown,
  • title - issue title or null if unknown,
  • url - URL of the issue page,
  • comment_count - total number of submitted comments or null if unknown.

Note, that this might respond with HTTP 400 if we fail to retrieve data from GitHub.