Matt Gilman created NIFI-1113:
---------------------------------
Summary: Address missing endpoints in REST API documentation
Key: NIFI-1113
URL: https://issues.apache.org/jira/browse/NIFI-1113
Project: Apache NiFi
Issue Type: Improvement
Components: Documentation & Website
Reporter: Matt Gilman
Due to a shortcoming in the tool used to generate the REST API documentation,
any endpoints that are overloaded (same path but consume different media types)
get ignored. Because of this, only a single media type is documented for each
endpoint that is overloaded. Here is a discussion of the issue [1].
I'm not sure that it is going to resolve itself in a timely manner. We may need
to consider another documentation option. Unfortunately, swagger was best in
class at the time.
Another option is that we could create new endpoints that aren't overloaded and
essentially deprecate the overloaded versions. Which we could remove when we
release 1.0.0. This would allow us to ensure everything is documented without
breaking any backwards compatibility.
[1] https://github.com/swagger-api/swagger-spec/issues/146
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
