[ https://issues.apache.org/jira/browse/NIFIREG-146?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kevin Doran updated NIFIREG-146: -------------------------------- 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 was: 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: * Proper security definitions and Authorization mappings * Correct VersionedConnection.zIndex field name in ApiOperation annotation > REST API Documentation Improvements > ----------------------------------- > > Key: NIFIREG-146 > URL: https://issues.apache.org/jira/browse/NIFIREG-146 > Project: NiFi Registry > Issue Type: Improvement > Affects Versions: 0.1.0 > Reporter: Kevin Doran > Assignee: Kevin Doran > Priority: Major > Labels: swagger > Fix For: 0.2.0 > > > 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 -- This message was sent by Atlassian JIRA (v7.6.3#76005)