[jira] [Commented] (NIFI-2978) Rest Api - OpenApi spec

["Aleksander Eskilson (Jira)" <ji...@apache.org>]

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

Aleksander Eskilson commented on NIFI-2978:
-------------------------------------------

I also agree a generated OpenApi spec would be useful, especially since there are open-source projects that can generate Client libraries given such a spec.

> Rest Api - OpenApi spec
> -----------------------
>
>                 Key: NIFI-2978
>                 URL: https://issues.apache.org/jira/browse/NIFI-2978
>             Project: Apache NiFi
>          Issue Type: Bug
>          Components: Core Framework
>            Reporter: Matt Gilman
>            Priority: Major
>
> Review the Rest Api regarding the adherence of the OpenApi specification. Specifically, there are known issues around usages of dates/timestamps. To achieve adherence in the 1.x baseline we've updated the documentation (and the generated swagger.json) to report the fields as strings.
> This effort should be considered when possible. Because the Rest Api is a public API we cannot make backward breaking changes in minor/incremental version changes (unless the endpoint is marked as non-guaranteed). If possible, we could somehow version the Rest Api and essentially mark the old endpoints as deprecated prior to waiting for the next major version of Apache NiFi. 



--
This message was sent by Atlassian Jira
(v8.3.4#803005)