[jira] [Commented] (NIFI-2893) Missing or wrong API doc

["Matt Gilman (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/NIFI-2893?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15572072#comment-15572072 ] 

Matt Gilman commented on NIFI-2893:
-----------------------------------

The controller services endpoint is not under /process-groups. The endpoints are grouped largely according to the resource that's used to authorize the request. Because controller services are a cross-cutting concern (meaning different processors with potentially different access policies can reference the same services) access to them is provided through

- /flow/process-groups/{id}/controller-services
- /flow/controller/controller-services

The /flow endpoints are authorized with the resource that provides access to the flow (flow structure... what components, including services, are connected but not including what the components actually are) and the UI.

Also, I looked into the documentation reporting a 200 response for all POSTs requests. This is a bug in swagger [1][2] that's generating the incorrect response code. I tried out a couple of the suggestions and none of them worked as I would like it. I'd like to keep this JIRA open until we're able to pull in a newer version of swagger that addresses the incorrect response code.

[1] https://github.com/kongchen/swagger-maven-plugin/issues/107
[2] https://github.com/kongchen/swagger-maven-plugin/issues/216

> Missing or wrong API doc
> ------------------------
>
>                 Key: NIFI-2893
>                 URL: https://issues.apache.org/jira/browse/NIFI-2893
>             Project: Apache NiFi
>          Issue Type: Bug
>          Components: Documentation & Website
>    Affects Versions: 1.0.0
>            Reporter: Stephane Maarek
>            Priority: Minor
>
> At:
> https://nifi.apache.org/docs/nifi-docs/rest-api/
> Missing:
> - GET  /process-groups/{id}/controller-services
> Erroneous:
> - POST /process-groups/{id}/templates/upload
>     > should give a 201 in case of created, returns Location in header so we can get the ID out of it
>     > it'd be good to have a description of the returned xml (nodes, etc)



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)