View Issue Details

IDProjectCategoryView StatusLast Update
0025998mantisbtdocumentationpublic2019-08-14 09:56
Reporterdregad Assigned Tovboctor  
PrioritynormalSeveritymajorReproducibilityN/A
Status assignedResolutionopen 
Product Version 
Target VersionFixed in Version 
Summary0025998: REST API documentation
Description

Currently, the REST API's documentation is hosted externally at https://documenter.getpostman.com/view/29959/mantis-bug-tracker-rest-api/7Lt6zkP

The source is not part of the MantisBT repository, and generally not available to the team since currently @vboctor is the only person having access to the Postman account.

We need to

  1. reference the documentation on http://mantisbt.org/documentation.php
  2. define a process so the team (and possibly contributors, if possible) can update and publish the documentation
Additional Information

Record of a Gitter discussion on the subject

@dregad April 17, 2019 9:40 AM

@vboctor As I was reviewing PR 1506, I thought that this change should be reflected in documentation. That's when I realized that the REST API docs are not in the repository. What is the process to maintain / update that ?

@vboctor April 18, 2019 9:22 AM:

For the API documentation I do this via Postman and it may rely on my account being a paid one. I’ll explore options.

TagsNo tags attached.

Activities

dregad

dregad

2019-08-14 09:55

developer   ~0062568

@vboctor I'm assigning this to you, as you're currently the only one who can take action on point 2.

If sharing Postman account turns out not to be an option, maybe we can consider other alternatives for REST API docs ?
Reference: https://pronovix.com/blog/free-and-open-source-api-documentation-tools

Issue History

Date Modified Username Field Change
2019-08-14 09:48 dregad New Issue
2019-08-14 09:55 dregad Assigned To => dregad
2019-08-14 09:55 dregad Status new => assigned
2019-08-14 09:55 dregad Note Added: 0062568
2019-08-14 09:55 dregad Assigned To dregad => vboctor