View Issue Details

IDProjectCategoryView StatusLast Update
0025998mantisbtdocumentationpublic2021-02-15 20:50
Reporterdregad Assigned Tovboctor  
Status closedResolutionfixed 
Target Version2.25.0Fixed in Version2.25.0 
Summary0025998: REST API documentation

Currently, the REST API's documentation is hosted externally at

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
  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.


related to 0026982 assignedvboctor mantisbt REST API documentation not discoverable via 




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 ?



2019-08-20 02:13

manager   ~0062612


Related Changesets

MantisBT: master 8bdbfa7d

2019-08-20 02:11:41


Details Diff
Add Postman collection and environment

Fixes 0025998
Affected Issues
add - api/rest/api.postman_collection.json Diff File
add - api/rest/env.postman_environment.json Diff File

MantisBT: master 9efcff25

2020-05-10 14:09:01


Details Diff
Add REST API section in Developer manual

Fixes 0025998
Affected Issues
add - docbook/Developers_Guide/en-US/Api_Rest.xml Diff File
mod - docbook/Developers_Guide/en-US/Developers_Guide.xml Diff File