[NIFIREG-146] REST API Documentation Improvements

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 0.1.0
• Fix Version/s: 0.2.0
• Labels: swagger
• Assignee: Kevin Doran
• Reporter: Kevin Doran
• Created: 17/Feb/18 20:29
• Updated: 09/Mar/18 15:50
• Resolved: 09/Mar/18 15:50

Description

The self-hosted REST API documentation that is generated using templated HTML files and the swagger.json needs the following improvements:

• Collection response types are not being populated into the template correctly
• Endpoints that require authorization to an access policy should be marked as such

Additionally, the following improvements can be made to the Swagger output by the build:

• Mark fields required in a few places where that is missing
• Mark fields readOnly in a few places where that is missing
• Proper security definitions and Authorization mappings
• Correct VersionedConnection.zIndex field name in ApiOperation annotation

Issue Links

• links to: GitHub Pull Request #103