Skip to content

Commit

Permalink
Readme update on version and feature support
Browse files Browse the repository at this point in the history
Update registry client to 0.3.0
Updated History for 0.12.0 release
  • Loading branch information
Chaffelson committed Dec 20, 2018
1 parent 5786472 commit 9c673c8
Show file tree
Hide file tree
Showing 54 changed files with 219 additions and 130 deletions.
4 changes: 2 additions & 2 deletions README.rst
Expand Up @@ -44,7 +44,7 @@ Features
- Detailed documentation of the full SDK at all levels
- CRUD wrappers for common task areas like Processor Groups, Processors, Templates, Registry Clients, Registry Buckets, Registry Flows, etc.
- Convenience functions for inventory tasks, such as recursively retrieving the entire canvas, or a flat list of all Process Groups
- Support for scheduling and purging flows
- Support for scheduling and purging flows, controller services, and connections
- Support for fetching and updating Variable Registries
- Support for import/export of Versioned Flows from NiFi-Registry
- Docker Compose configurations for testing and deployment
Expand Down Expand Up @@ -97,7 +97,7 @@ Background and Documentation
NiFi Version Support
--------------------

| Currently we are testing against NiFi versions 1.1.2 - 1.7.1, and NiFi-Registry versions 0.1.0 - 0.3.0.
| Currently we are testing against NiFi versions 1.1.2 - 1.8.0, and NiFi-Registry versions 0.1.0 - 0.3.0.
| If you find a version compatibility problem please raise an `issue <https://github.com/Chaffelson/nipyapi/issues>`_
Python Requirements
Expand Down
24 changes: 24 additions & 0 deletions docs/history.rst
Expand Up @@ -2,6 +2,30 @@
History
=======

0.12.0 (2018-12-20)
-------------------

| Updated NiFi client for 1.8.0
| Updated NiFi-Registry client for 0.3.0
| Added Controller Service Management (experimental)
| Added Connections Management (experimental)
| New Project Logo! Kindly provided by KDoran
| Fixed several bugs around how the special root Process Group is handled when listing all Project Groups for various methods
* Various backwards compatibility improvements for handling calls going back to NiFi-1.1.2
* Various speedups for NiFi-1.7+ using descendants functionality to recurse the canvas
* Ability for various methods to specify a Process Group to use as the parent instead of always using root
* Better username/password handling in security.py and config.py
* Support for global ssl_verify squashing in config.py
* Added swagger for 1.8.0 to project resources against potential future validation requirements
* Added versioned deployment convenience functions for finding sensitive and invalid processors, should make it easier to update properties when importing to a new canvas
* Added summary options to several calls to return simple objects suitable for quick processing rather than full objects that need to be parsed
* Added utils.infer_object_label_from_class to make it easier to create connections between objects
* Updated compound methods like delete_process_group to also handle connections and controllers elegantly if requested
* Various codestyle and testing improvements



0.11.0 (2018-10-12)
-------------------

Expand Down
2 changes: 1 addition & 1 deletion nipyapi/config.py
Expand Up @@ -25,7 +25,7 @@
# convenience function for this in nipyapi.utils.set_endpoint

# Set Default Host for NiFi
default_host = 'localhost'
default_host = 'ec2-54-171-88-237.eu-west-1.compute.amazonaws.com'
#
nifi_config.host = 'http://' + default_host + ':8080/nifi-api'
# Set Default Host for NiFi-Registry
Expand Down
2 changes: 1 addition & 1 deletion nipyapi/registry/__init__.py
Expand Up @@ -5,7 +5,7 @@
The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.
OpenAPI spec version: 0.2.0
OUTPUTOpenAPI spec version: 0.3.0
Contact: dev@nifi.apache.org
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down
4 changes: 2 additions & 2 deletions nipyapi/registry/api_client.py
Expand Up @@ -4,7 +4,7 @@
The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.
OpenAPI spec version: 0.2.0
OUTPUTOpenAPI spec version: 0.3.0
Contact: dev@nifi.apache.org
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down Expand Up @@ -628,6 +628,6 @@ def __deserialize_model(self, data, klass):
value = data[klass.attribute_map[attr]]
kwargs[attr] = self.__deserialize(value, attr_type)

instance = klass(**kwargs)
instance = klass(**kwargs)

return instance
10 changes: 5 additions & 5 deletions nipyapi/registry/apis/access_api.py
Expand Up @@ -5,7 +5,7 @@
The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.
OpenAPI spec version: 0.2.0
OpenAPI spec version: 0.3.0
Contact: dev@nifi.apache.org
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down Expand Up @@ -435,7 +435,7 @@ def create_access_token_using_kerberos_ticket_with_http_info(self, **kwargs):
def get_access_status(self, **kwargs):
"""
Returns the current client's authenticated identity and permissions to top-level resources
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -460,7 +460,7 @@ def get_access_status(self, **kwargs):
def get_access_status_with_http_info(self, **kwargs):
"""
Returns the current client's authenticated identity and permissions to top-level resources
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -533,7 +533,7 @@ def get_access_status_with_http_info(self, **kwargs):
def get_identity_provider_usage_instructions(self, **kwargs):
"""
Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -558,7 +558,7 @@ def get_identity_provider_usage_instructions(self, **kwargs):
def get_identity_provider_usage_instructions_with_http_info(self, **kwargs):
"""
Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down
38 changes: 19 additions & 19 deletions nipyapi/registry/apis/bucket_flows_api.py
Expand Up @@ -5,7 +5,7 @@
The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.
OpenAPI spec version: 0.2.0
OpenAPI spec version: 0.3.0
Contact: dev@nifi.apache.org
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down Expand Up @@ -276,7 +276,7 @@ def create_flow_version_with_http_info(self, bucket_id, flow_id, body, **kwargs)
def delete_flow(self, bucket_id, flow_id, **kwargs):
"""
Deletes a flow, including all saved versions of that flow.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -303,7 +303,7 @@ def delete_flow(self, bucket_id, flow_id, **kwargs):
def delete_flow_with_http_info(self, bucket_id, flow_id, **kwargs):
"""
Deletes a flow, including all saved versions of that flow.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -389,7 +389,7 @@ def delete_flow_with_http_info(self, bucket_id, flow_id, **kwargs):
def get_flow(self, bucket_id, flow_id, **kwargs):
"""
Gets a flow
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -416,7 +416,7 @@ def get_flow(self, bucket_id, flow_id, **kwargs):
def get_flow_with_http_info(self, bucket_id, flow_id, **kwargs):
"""
Gets a flow
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -502,7 +502,7 @@ def get_flow_with_http_info(self, bucket_id, flow_id, **kwargs):
def get_flow_diff(self, bucket_id, flow_id, version_a, version_b, **kwargs):
"""
Returns a list of differences between 2 versions of a flow
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -531,7 +531,7 @@ def get_flow_diff(self, bucket_id, flow_id, version_a, version_b, **kwargs):
def get_flow_diff_with_http_info(self, bucket_id, flow_id, version_a, version_b, **kwargs):
"""
Returns a list of differences between 2 versions of a flow
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -633,7 +633,7 @@ def get_flow_diff_with_http_info(self, bucket_id, flow_id, version_a, version_b,
def get_flow_version(self, bucket_id, flow_id, version_number, **kwargs):
"""
Gets the given version of a flow
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -661,7 +661,7 @@ def get_flow_version(self, bucket_id, flow_id, version_number, **kwargs):
def get_flow_version_with_http_info(self, bucket_id, flow_id, version_number, **kwargs):
"""
Gets the given version of a flow
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -755,7 +755,7 @@ def get_flow_version_with_http_info(self, bucket_id, flow_id, version_number, **
def get_flow_versions(self, bucket_id, flow_id, **kwargs):
"""
Gets summary information for all versions of a flow. Versions are ordered newest->oldest.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -782,7 +782,7 @@ def get_flow_versions(self, bucket_id, flow_id, **kwargs):
def get_flow_versions_with_http_info(self, bucket_id, flow_id, **kwargs):
"""
Gets summary information for all versions of a flow. Versions are ordered newest->oldest.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -868,7 +868,7 @@ def get_flow_versions_with_http_info(self, bucket_id, flow_id, **kwargs):
def get_flows(self, bucket_id, **kwargs):
"""
Gets all flows in the given bucket
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -894,7 +894,7 @@ def get_flows(self, bucket_id, **kwargs):
def get_flows_with_http_info(self, bucket_id, **kwargs):
"""
Gets all flows in the given bucket
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -974,7 +974,7 @@ def get_flows_with_http_info(self, bucket_id, **kwargs):
def get_latest_flow_version(self, bucket_id, flow_id, **kwargs):
"""
Get the latest version of a flow
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -1001,7 +1001,7 @@ def get_latest_flow_version(self, bucket_id, flow_id, **kwargs):
def get_latest_flow_version_with_http_info(self, bucket_id, flow_id, **kwargs):
"""
Get the latest version of a flow
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -1087,7 +1087,7 @@ def get_latest_flow_version_with_http_info(self, bucket_id, flow_id, **kwargs):
def get_latest_flow_version_metadata(self, bucket_id, flow_id, **kwargs):
"""
Get the metadata for the latest version of a flow
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -1114,7 +1114,7 @@ def get_latest_flow_version_metadata(self, bucket_id, flow_id, **kwargs):
def get_latest_flow_version_metadata_with_http_info(self, bucket_id, flow_id, **kwargs):
"""
Get the metadata for the latest version of a flow
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -1200,7 +1200,7 @@ def get_latest_flow_version_metadata_with_http_info(self, bucket_id, flow_id, **
def update_flow(self, bucket_id, flow_id, body, **kwargs):
"""
Updates a flow
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -1228,7 +1228,7 @@ def update_flow(self, bucket_id, flow_id, body, **kwargs):
def update_flow_with_http_info(self, bucket_id, flow_id, body, **kwargs):
"""
Updates a flow
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down
22 changes: 11 additions & 11 deletions nipyapi/registry/apis/buckets_api.py
Expand Up @@ -5,7 +5,7 @@
The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.
OpenAPI spec version: 0.2.0
OpenAPI spec version: 0.3.0
Contact: dev@nifi.apache.org
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
Expand Down Expand Up @@ -43,7 +43,7 @@ def __init__(self, api_client=None):
def create_bucket(self, body, **kwargs):
"""
Creates a bucket
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -69,7 +69,7 @@ def create_bucket(self, body, **kwargs):
def create_bucket_with_http_info(self, body, **kwargs):
"""
Creates a bucket
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -149,7 +149,7 @@ def create_bucket_with_http_info(self, body, **kwargs):
def delete_bucket(self, bucket_id, **kwargs):
"""
Deletes a bucket along with all objects stored in the bucket
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -175,7 +175,7 @@ def delete_bucket(self, bucket_id, **kwargs):
def delete_bucket_with_http_info(self, bucket_id, **kwargs):
"""
Deletes a bucket along with all objects stored in the bucket
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -255,7 +255,7 @@ def delete_bucket_with_http_info(self, bucket_id, **kwargs):
def get_available_bucket_fields(self, **kwargs):
"""
Retrieves field names for searching or sorting on buckets.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -280,7 +280,7 @@ def get_available_bucket_fields(self, **kwargs):
def get_available_bucket_fields_with_http_info(self, **kwargs):
"""
Retrieves field names for searching or sorting on buckets.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -353,7 +353,7 @@ def get_available_bucket_fields_with_http_info(self, **kwargs):
def get_bucket(self, bucket_id, **kwargs):
"""
Gets a bucket
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -379,7 +379,7 @@ def get_bucket(self, bucket_id, **kwargs):
def get_bucket_with_http_info(self, bucket_id, **kwargs):
"""
Gets a bucket
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down Expand Up @@ -557,7 +557,7 @@ def get_buckets_with_http_info(self, **kwargs):
def update_bucket(self, bucket_id, body, **kwargs):
"""
Updates a bucket
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand All @@ -584,7 +584,7 @@ def update_bucket(self, bucket_id, body, **kwargs):
def update_bucket_with_http_info(self, bucket_id, body, **kwargs):
"""
Updates a bucket
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
to be invoked when receiving the response.
Expand Down

0 comments on commit 9c673c8

Please sign in to comment.