Merge branch 'RegistryImportExport'

docs/apiClients.rst

@@ -0,0 +1,11 @@
+===============
+NiFI API Client
+===============
+
+.. mdinclude:: nifiDocs.md
+
+========================
+NiFi-Registry API Client
+========================
+
+.. mdinclude:: registryDocs.md

docs/conf.py

@@ -35,18 +35,20 @@
 
 # -- General configuration ---------------------------------------------
 
+github_doc_root = 'https://github.com/Chaffelson/nipyapi/tree/master/docs'
+
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'm2r']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'
@@ -283,3 +285,8 @@
 # -- Custom Options -------------
 
 autoclass_content = 'both'
+
+
+# M2R
+no_underscore_emphasis = True
+m2r_parse_relative_links = True

docs/index.rst

@@ -9,6 +9,7 @@ Contents:
    readme
    installation
    usage
+   apiClients
    todo
    contributing
    devnotes

docs/nifi-docs/AboutDTO.md

@@ -13,6 +13,6 @@ Name | Type | Description | Notes
 **build_branch** | **str** | Build branch | [optional] 
 **build_timestamp** | **str** | Build timestamp | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/AboutEntity.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **about** | [**AboutDTO**](AboutDTO.md) |  | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/AccessApi.md

@@ -65,7 +65,7 @@ No authorization required
  - **Content-Type**: application/x-www-form-urlencoded
  - **Accept**: text/plain
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+[[Back to top]](#) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to README]](../nifiDocs.md)
 
 # **create_access_token_from_ticket**
 > str create_access_token_from_ticket()
@@ -109,7 +109,7 @@ No authorization required
  - **Content-Type**: text/plain
  - **Accept**: text/plain
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+[[Back to top]](#) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to README]](../nifiDocs.md)
 
 # **create_download_token**
 > str create_download_token()
@@ -153,7 +153,7 @@ No authorization required
  - **Content-Type**: application/x-www-form-urlencoded
  - **Accept**: text/plain
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+[[Back to top]](#) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to README]](../nifiDocs.md)
 
 # **create_ui_extension_token**
 > str create_ui_extension_token()
@@ -197,7 +197,7 @@ No authorization required
  - **Content-Type**: application/x-www-form-urlencoded
  - **Accept**: text/plain
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+[[Back to top]](#) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to README]](../nifiDocs.md)
 
 # **get_access_status**
 > AccessStatusEntity get_access_status()
@@ -241,7 +241,7 @@ No authorization required
  - **Content-Type**: */*
  - **Accept**: application/json
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+[[Back to top]](#) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to README]](../nifiDocs.md)
 
 # **get_login_config**
 > AccessConfigurationEntity get_login_config()
@@ -285,7 +285,7 @@ No authorization required
  - **Content-Type**: */*
  - **Accept**: application/json
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+[[Back to top]](#) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to README]](../nifiDocs.md)
 
 # **knox_callback**
 > knox_callback()
@@ -328,7 +328,7 @@ No authorization required
  - **Content-Type**: */*
  - **Accept**: */*
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+[[Back to top]](#) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to README]](../nifiDocs.md)
 
 # **knox_request**
 > knox_request()
@@ -371,7 +371,7 @@ No authorization required
  - **Content-Type**: */*
  - **Accept**: */*
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+[[Back to top]](#) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to README]](../nifiDocs.md)
 
 # **oidc_callback**
 > oidc_callback()
@@ -414,7 +414,7 @@ No authorization required
  - **Content-Type**: */*
  - **Accept**: */*
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+[[Back to top]](#) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to README]](../nifiDocs.md)
 
 # **oidc_exchange**
 > str oidc_exchange()
@@ -458,7 +458,7 @@ No authorization required
  - **Content-Type**: */*
  - **Accept**: text/plain
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+[[Back to top]](#) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to README]](../nifiDocs.md)
 
 # **oidc_request**
 > oidc_request()
@@ -501,5 +501,5 @@ No authorization required
  - **Content-Type**: */*
  - **Accept**: */*
 
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+[[Back to top]](#) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to README]](../nifiDocs.md)
 

docs/nifi-docs/AccessConfigurationDTO.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **supports_login** | **bool** | Indicates whether or not this NiFi supports user login. | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/AccessConfigurationEntity.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **config** | [**AccessConfigurationDTO**](AccessConfigurationDTO.md) |  | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/AccessPolicyDTO.md

@@ -14,6 +14,6 @@ Name | Type | Description | Notes
 **users** | [**list[TenantEntity]**](TenantEntity.md) | The set of user IDs associated with this access policy. | [optional] 
 **user_groups** | [**list[TenantEntity]**](TenantEntity.md) | The set of user group IDs associated with this access policy. | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/AccessPolicyEntity.md

@@ -12,6 +12,6 @@ Name | Type | Description | Notes
 **generated** | **str** | When this content was generated. | [optional] 
 **component** | [**AccessPolicyDTO**](AccessPolicyDTO.md) |  | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/AccessPolicySummaryDTO.md

@@ -12,6 +12,6 @@ Name | Type | Description | Notes
 **component_reference** | [**ComponentReferenceEntity**](ComponentReferenceEntity.md) | Component this policy references if applicable. | [optional] 
 **configurable** | **bool** | Whether this policy is configurable. | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/AccessPolicySummaryEntity.md

@@ -11,6 +11,6 @@ Name | Type | Description | Notes
 **bulletins** | [**list[BulletinEntity]**](BulletinEntity.md) | The bulletins for this component. | [optional] 
 **component** | [**AccessPolicySummaryDTO**](AccessPolicySummaryDTO.md) |  | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/AccessStatusDTO.md

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **status** | **str** | The user access status. | [optional] 
 **message** | **str** | Additional details about the user access status. | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/AccessStatusEntity.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **access_status** | [**AccessStatusDTO**](AccessStatusDTO.md) |  | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/ActionDTO.md

@@ -13,6 +13,6 @@ Name | Type | Description | Notes
 **operation** | **str** | The operation that was performed. | [optional] 
 **action_details** | [**ActionDetailsDTO**](ActionDetailsDTO.md) | The details of the action. | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/ActionDetailsDTO.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/ActionEntity.md

@@ -9,6 +9,6 @@ Name | Type | Description | Notes
 **can_read** | **bool** | Indicates whether the user can read a given resource. | [optional] 
 **action** | [**ActionDTO**](ActionDTO.md) |  | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/ActivateControllerServicesEntity.md

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **state** | **str** | The desired state of the descendant components | [optional] 
 **components** | [**dict(str, RevisionDTO)**](RevisionDTO.md) | Optional services to schedule. If not specified, all authorized descendant controller services will be used. | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/AffectedComponentDTO.md

@@ -11,6 +11,6 @@ Name | Type | Description | Notes
 **active_thread_count** | **int** | The number of active threads for the referencing component. | [optional] 
 **validation_errors** | **list[str]** | The validation errors for the component. | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/AffectedComponentEntity.md

@@ -11,6 +11,6 @@ Name | Type | Description | Notes
 **bulletins** | [**list[BulletinEntity]**](BulletinEntity.md) | The bulletins for this component. | [optional] 
 **component** | [**AffectedComponentDTO**](AffectedComponentDTO.md) |  | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/AllowableValueDTO.md

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **value** | **str** | A value that is allowed for the property descriptor. | [optional] 
 **description** | **str** | A description for this allowable value. | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/AllowableValueEntity.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 **allowable_value** | [**AllowableValueDTO**](AllowableValueDTO.md) |  | [optional] 
 **can_read** | **bool** | Indicates whether the user can read a given resource. | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/AttributeDTO.md

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **value** | **str** | The attribute value. | [optional] 
 **previous_value** | **str** | The value of the attribute before the event took place. | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/BannerDTO.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 **header_text** | **str** | The header text. | [optional] 
 **footer_text** | **str** | The footer text. | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/BannerEntity.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **banners** | [**BannerDTO**](BannerDTO.md) |  | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/BatchSettingsDTO.md

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **size** | **str** | Preferred number of bytes to include in a transaction. | [optional] 
 **duration** | **str** | Preferred amount of time that a transaction should span. | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)
 
 

docs/nifi-docs/BatchSize.md

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **size** | **str** | Preferred number of bytes to include in a transaction. | [optional] 
 **duration** | **str** | Preferred amount of time that a transaction should span. | [optional] 
 
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+[[Back to Model list]](../nifiDocs.md#documentation-for-models) [[Back to API list]](../nifiDocs.md#documentation-for-api-endpoints) [[Back to README]](../nifiDocs.md)