Page History

...

• Any code in the nifi-api module not clearly documented as unstable.
• Any part of the REST API not clearly documented as unstable.
• Any extension such as Processor, Controller Service, Reporting Task.
• Any specialized protocols or formats such as:
  • Site-to-site
  • Serialized Flow File
  • Flow File Repository
  • Content Repository
  • Provenance Repository
  • State management
• Any configuration file necessary to operate NiFi such as:
  • All files found in the nifi/conf directory
  • Templates
  • The configuration parameters and intended behavior of a given component/extension point
• The nifi-mock  module supporting unit testing of extension components

Anything not listed above is not considered part of the API and is subject to change in a manner that may differ from the guidance below.  There are substantial portions of the codebase which are intentionally considered private from an API point of view.  If there are specific items not listed here which should be considered part of the API please raise a discussion about it on dev@nifi.apache.org so it can be considered for inclusion.  We want to keep the public surface of the Apache NiFi API well defined and well scoped so that those consuming the application either as a developer or user know what is considered safe and not safe to do but also so that our community can continue to rapidly evolve the codebase.

...