API 1.10.1

Patch superseded by API 1.10.2


Software version: API 1.10.1

Scheduled release date:  

This file provides information about the VERA API Server

  • Version Information
  • Fixed Issues
  • New Features
  • Docker Image Information
  • Known Issues and Limitations

Version Information

High-level VERA Version2021.4.1
API Version1.10.1

Software Build

(Can be verified on the "Versions" screen in the web portal.)

2241
(2022/02/23)

Fixed Issues

KeySummaryNotes
VS-1522A route action callback request being canceled/closed results in records not being routed - qTestFixed issue when a request was stopping for large records that take a long time to process.
VS-1539A route action callback request being canceled/closed results in records not being routed - JiraFixed issue when a request was stopping for large records that take a long time to process.
VS-1565Fixed issue when a request was stopping for large records that take a long time to processFixed an issue where attachment URLs from XRay tests were not handled properly.

New Features

KeySummaryNotes
VS-1558

Break up record creation into smaller chunks in qTest

Separated web service calls to smaller messages for adding attachments and adding sub-records/linked records to separate requests.
VS-1580Break up record creation into smaller chunks in JiraSeparated web service calls to smaller messages for adding attachments and adding sub-records/linked records to separate requests.

Docker

Repositoryveraserver20190209075900.azurecr.io/tx3/vera-server
Tags
  • 2021.4.1
  • 1.10.1
How to UpgradeSee Upgrade the VERA Server Applications for instructions


Known Issues and Limitations

Key

Summary

Known Issue Details

VS-139"Pending Tasks" field refreshes too slowly after route withdrawal.The Pending Tasks field in qTest and Jira is not immediately updated when the record is approved or rejected in VERA.  The cached values are updated when the user invokes a browser refresh,
VS-163Rejection Reason can be submitted with only a space (no text) enteredRejection Reason can be submitted with only a space (no text) entered. 
VS-323VERA Server needs a reboot to fully read new Sync Policy entriesChanges to the VERA Synchronization Policy will not take affect until the VERA Application service is restarted.
VS-447User Administrator role can see Signature Verification Failure Report and Re-verifyA User Administrator can access the Signature Verification reporting section of the Administration Portal.  This feature should be limited to System Administrators.
VS-606Error while sorting approval queue with large quantity of tasksUsers may encounter errors while sorting an approval queue with a large (thousands) quantity of tasks.
VS-668Sorting shows all values beginning with a capital letter before lowercase valuesWhen sorting data (users, records, etc.) alphabetically, the system erroneously alphabetizes capital letters independently from lower-case letters.  For example:  Apple, Cat, ball -- instead of: Apple, ball, Cat
VS-692JSON Attachment download returns 500 errorA Jira issue had the approval policy.jason file attached; an error was displayed when downloading the attachment.
VS-698VERA cannot create a qTest record if two fields in the record have the same nameThe VERA-qTest integration does not support importing records from qTest where the record has two fields with the same name.  If such a record is routed for approval from qTest, then an error will occur.
VS-700User sees duplicate approval tasks for the same record in approval queueIf an approval route contains two pending tasks for the same role (e.g. two Technical approvals) then an eligible approver will see both tasks in their queue.
VS-810Admin can't remove a project from domain if project name contains regexA project created with regex characters cannot be removed from a domain once it is added. This also causes issues with displaying tasks in the approval queue for a user
VS-962Approval Queue user filter uses RegEx can match different usersDue to regular expression matching, a record that has been signed by one user may cause another user's approval queue to exclude the record when it should be available.
VS-988VERA DevOps does not apply a default approval routeIf a record is routed for approval that does not satisfy any configured route templates, the user will see "VERA is trying to start the approval route" rather than a descriptive error containing the reason why the route was not started.
VS-1060If user has a null value for a role in their claims list the user module fails to add or remove them from a roleIf a user has a claim that has a type of role and a value of null (not just a blank string), the user module will throw an exception when trying to add or remove the user from a role.
VS-1065A misleading error message is displayed when VERA cannot apply a final approvalVERA will display a misleading error message when it fails to transition a Jira issue in the workflow.  The error message displayed to the user will indicate that there is a connectivity problem, even if it's actually a configuration problem. 
VS-1095Project names are not validated when adding to domainAdmins are able to add a project to a domain that contains RegEx characters.
VS-1243

Invalid Approval Group error log should indicate with group or line number the error is on

Currently error log does not display approval group details when invalid approval group is logged. 
VS-1263

VERA does not properly handle a hidden Sync ID field in Jira

VERA does not have valid error handling for scenarios in which the VERA Sync ID field in Jira is inaccessible (e.g.. not on the issue's edit screen).
VS-1277

VERA returns an HTTP 500 status code to Jira webhooks when it cannot access the Sync ID field

With Jira Cloud, the HTTP 500 status code will prompt Jira to retry the same webhook a few minutes later.  This is undesirable, because a) there is no reasonable expectation that it will succeed, and b) the user will have very likely tried rerouting the record again anyway.

Therefore, the Jira module should return a different status code that will not trigger a retry from Jira Cloud.

VS-1278

VERA does not handle concurrent start route requests for the same record

The VERA API does not have proper handling for concurrent start approval route requests for the same record.  If it is a new record, then the end result could be the record receiving two different Sync IDs each with its own approval route.
VS-1293Final approval fails when Jira projects are configured with a Signatures fieldVERA will attempt to write the entire approval route to the Jira Signatures field if the field is present in the Jira project. If the approval route contains over 255 characters the Approval will fail since VERA is attempting to write over 255 characters to the field.
VS-1303Jira and qTest Modules use the Server property from the Sync Policy as the Base URLThe Jira and qTest modules both use the Server property for a location for the baseurl when connecting to Jira or qTest. This is normally fine, but can cause an issue where a client has a gateway or proxy in between VERA and their Jira/qTest servers. Modules should use the API Server url defined in the policy file.
VS-1391Revision is blank in qTest Run Record Details for History entriesThe Revision field is blank for qTest Test Run records in the Record Details for a History entry.
VS-1419Routing records for approval - errors in logsIn the users module, when GET /users/{userId} endpoint is being called with a userId different from the request owner's userId, then users module responses with 403 Forbidden status code.