From cef094c3f15464a5549fa7b7f152ddc78af1b4f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Arnauts?= Date: Sat, 22 Jun 2024 09:27:19 +0200 Subject: [PATCH 01/11] Fix API model generator (#356) --- resources/client_gen/generate_api_client.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/resources/client_gen/generate_api_client.sh b/resources/client_gen/generate_api_client.sh index 7e5f2996..923ca592 100755 --- a/resources/client_gen/generate_api_client.sh +++ b/resources/client_gen/generate_api_client.sh @@ -10,13 +10,13 @@ echo Exporting Params export wv_client_name=${wv_client_name:-nifi} -export wv_codegen_filename=${wv_codegen_filename:-swagger-codegen-cli-2.3.1.jar} +export wv_codegen_filename=${wv_codegen_filename:-swagger-codegen-cli-2.4.41.jar} export wv_tmp_dir=${wv_tmp_dir:-${HOME}/Projects/tmp} export wv_client_dir=${wv_tmp_dir}/${wv_client_name} export wv_mustache_dir=./swagger_templates export wv_api_def_dir=./api_defs -export wv_codegen_url=central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.3.1/${wv_codegen_filename} +export wv_codegen_url=https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.41/${wv_codegen_filename} export wv_swagger_def=$(ls ${wv_api_def_dir} | grep ${wv_client_name} | sort -V | tail -1) echo Prepping Workspace From ca5cdc8a1f076557058b3773428520d938f2d7b7 Mon Sep 17 00:00:00 2001 From: Otto Fowler Date: Sat, 22 Jun 2024 13:21:23 -0400 Subject: [PATCH 02/11] issue-360: handle -9 error messages better (#361) closes 360 from https://github.com/JiKeidan --- nipyapi/security.py | 469 +++++++++++++++++++++----------------------- 1 file changed, 224 insertions(+), 245 deletions(-) diff --git a/nipyapi/security.py b/nipyapi/security.py index c507816e..59357f7b 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -16,34 +16,45 @@ log = logging.getLogger(__name__) -__all__ = ['create_service_user', 'create_service_user_group', - 'set_service_auth_token', 'service_logout', - 'get_service_access_status', 'add_user_to_access_policy', - 'update_access_policy', 'get_access_policy_for_resource', - 'create_access_policy', 'list_service_users', 'get_service_user', - 'set_service_ssl_context', 'add_user_group_to_access_policy', - 'bootstrap_security_policies', 'service_login', - 'remove_service_user', 'list_service_user_groups', - 'get_service_user_group', 'remove_service_user_group' - ] +__all__ = [ + "create_service_user", + "create_service_user_group", + "set_service_auth_token", + "service_logout", + "get_service_access_status", + "add_user_to_access_policy", + "update_access_policy", + "get_access_policy_for_resource", + "create_access_policy", + "list_service_users", + "get_service_user", + "set_service_ssl_context", + "add_user_group_to_access_policy", + "bootstrap_security_policies", + "service_login", + "remove_service_user", + "list_service_user_groups", + "get_service_user_group", + "remove_service_user_group", +] # These are the known-valid policy actions -_valid_actions = ['read', 'write', 'delete'] +_valid_actions = ["read", "write", "delete"] # These are the services that these functions know how to configure -_valid_services = ['nifi', 'registry'] +_valid_services = ["nifi", "registry"] -def list_service_users(service='nifi'): +def list_service_users(service="nifi"): """Lists all users of a given service, takes a service name as a string""" assert service in _valid_services with nipyapi.utils.rest_exceptions(): out = getattr(nipyapi, service).TenantsApi().get_users() - if service == 'nifi': + if service == "nifi": return out.users return out -def get_service_user(identifier, identifier_type='identity', service='nifi'): +def get_service_user(identifier, identifier_type="identity", service="nifi"): """ Gets the unique user matching to the given identifier and type. @@ -60,13 +71,11 @@ def get_service_user(identifier, identifier_type='identity', service='nifi'): assert isinstance(identifier, six.string_types) assert isinstance(identifier_type, six.string_types) obj = list_service_users(service) - out = nipyapi.utils.filter_obj( - obj, identifier, identifier_type, greedy=False - ) + out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=False) return out -def remove_service_user(user, service='nifi', strict=True): +def remove_service_user(user, service="nifi", strict=True): """ Removes a given User from the given Service @@ -79,29 +88,23 @@ def remove_service_user(user, service='nifi', strict=True): Updated User Entity or None """ assert service in _valid_services - if service == 'registry': + if service == "registry": assert isinstance(user, nipyapi.registry.User) - submit = { - 'id': user.identifier, - 'version': user.revision.version - } + submit = {"id": user.identifier, "version": user.revision.version} else: assert isinstance(user, nipyapi.nifi.UserEntity) - submit = { - 'id': user.id, - 'version': user.revision.version - } + submit = {"id": user.id, "version": user.revision.version} assert isinstance(strict, bool) try: return getattr(nipyapi, service).TenantsApi().remove_user(**submit) except getattr(nipyapi, service).rest.ApiException as e: - if 'Unable to find user' in e.body or 'does not exist' in e.body: + if "Unable to find user" in e.body or "does not exist" in e.body: if not strict: return None _raise(ValueError(e.body), e) -def create_service_user(identity, service='nifi', strict=True): +def create_service_user(identity, service="nifi", strict=True): """ Attempts to create a user with the provided identity in the given service @@ -117,31 +120,23 @@ def create_service_user(identity, service='nifi', strict=True): assert service in _valid_services assert isinstance(identity, six.string_types) assert isinstance(strict, bool) - if service == 'registry': - user_obj = nipyapi.registry.User( - identity=identity - ) + if service == "registry": + user_obj = nipyapi.registry.User(identity=identity) else: # must be nifi user_obj = nipyapi.nifi.UserEntity( - revision=nipyapi.nifi.RevisionDTO( - version=0 - ), - component=nipyapi.nifi.UserDTO( - identity=identity - ) + revision=nipyapi.nifi.RevisionDTO(version=0), + component=nipyapi.nifi.UserDTO(identity=identity), ) try: return getattr(nipyapi, service).TenantsApi().create_user(user_obj) - except (nipyapi.nifi.rest.ApiException, - nipyapi.registry.rest.ApiException) as e: - if 'already exists' in e.body and not strict: + except (nipyapi.nifi.rest.ApiException, nipyapi.registry.rest.ApiException) as e: + if "already exists" in e.body and not strict: return get_service_user(identity, service=service) _raise(ValueError(e.body), e) -def create_service_user_group(identity, service='nifi', - users=None, strict=True): +def create_service_user_group(identity, service="nifi", users=None, strict=True): """ Attempts to create a user with the provided identity and member users in the given service @@ -162,44 +157,29 @@ def create_service_user_group(identity, service='nifi', users_ids = None - if service == 'nifi': + if service == "nifi": if users: - assert all( - isinstance(user, nipyapi.nifi.UserEntity) for user in users - ) - users_ids = [{'id': user.id} for user in users] + assert all(isinstance(user, nipyapi.nifi.UserEntity) for user in users) + users_ids = [{"id": user.id} for user in users] user_group_obj = nipyapi.nifi.UserGroupEntity( - revision=nipyapi.nifi.RevisionDTO( - version=0 - ), - component=nipyapi.nifi.UserGroupDTO( - identity=identity, - users=users_ids - ) + revision=nipyapi.nifi.RevisionDTO(version=0), + component=nipyapi.nifi.UserGroupDTO(identity=identity, users=users_ids), ) else: if users: - assert all( - isinstance(user, nipyapi.registry.User) for user in users - ) - users_ids = [{'identifier': user.identifier} for user in users] - user_group_obj = nipyapi.registry.UserGroup( - identity=identity, - users=users_ids - ) + assert all(isinstance(user, nipyapi.registry.User) for user in users) + users_ids = [{"identifier": user.identifier} for user in users] + user_group_obj = nipyapi.registry.UserGroup(identity=identity, users=users_ids) try: - return getattr(nipyapi, service).TenantsApi().create_user_group( - user_group_obj - ) - except (nipyapi.nifi.rest.ApiException, - nipyapi.registry.rest.ApiException) as e: - if 'already exists' in e.body: + return getattr(nipyapi, service).TenantsApi().create_user_group(user_group_obj) + except (nipyapi.nifi.rest.ApiException, nipyapi.registry.rest.ApiException) as e: + if "already exists" in e.body: if not strict: return get_service_user_group(identity, service=service) _raise(ValueError(e.body), e) -def list_service_user_groups(service='nifi'): +def list_service_user_groups(service="nifi"): """ Returns list of service user groups for a given service Args: @@ -212,13 +192,12 @@ def list_service_user_groups(service='nifi'): assert service in _valid_services with nipyapi.utils.rest_exceptions(): out = getattr(nipyapi, service).TenantsApi().get_user_groups() - if service == 'nifi': + if service == "nifi": return out.user_groups return out -def get_service_user_group(identifier, identifier_type='identity', - service='nifi'): +def get_service_user_group(identifier, identifier_type="identity", service="nifi"): """ Gets the unique group matching to the given identifier and type. @@ -235,50 +214,40 @@ def get_service_user_group(identifier, identifier_type='identity', assert isinstance(identifier, six.string_types) assert isinstance(identifier_type, six.string_types) obj = list_service_user_groups(service) - out = nipyapi.utils.filter_obj( - obj, identifier, identifier_type, greedy=False) + out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=False) return out -def remove_service_user_group(group, service='nifi', strict=True): +def remove_service_user_group(group, service="nifi", strict=True): """ - Removes a given User Group from the given Service + Removes a given User Group from the given Service - Args: - group: [(nifi.UserEntity), (registry.User)] Target User object - service (str): 'nifi' or 'registry' - strict (bool): Whether to throw an error if User not found + Args: + group: [(nifi.UserEntity), (registry.User)] Target User object + service (str): 'nifi' or 'registry' + strict (bool): Whether to throw an error if User not found - Returns: - Updated User Group or None - """ + Returns: + Updated User Group or None + """ assert service in _valid_services - if service == 'registry': + if service == "registry": assert isinstance(group, nipyapi.registry.UserGroup) - submit = { - 'id': group.identifier, - 'version': group.revision.version - } + submit = {"id": group.identifier, "version": group.revision.version} else: assert isinstance(group, nipyapi.nifi.UserGroupEntity) - submit = { - 'id': group.id, - 'version': group.revision.version - } + submit = {"id": group.id, "version": group.revision.version} assert isinstance(strict, bool) try: - return getattr( - nipyapi, service - ).TenantsApi().remove_user_group(**submit) + return getattr(nipyapi, service).TenantsApi().remove_user_group(**submit) except getattr(nipyapi, service).rest.ApiException as e: - if 'Unable to find user' in e.body or 'does not exist' in e.body: + if "Unable to find user" in e.body or "does not exist" in e.body: if not strict: return None _raise(ValueError(e.body), e) -def service_login(service='nifi', username=None, password=None, - bool_response=False): +def service_login(service="nifi", username=None, password=None, bool_response=False): """ Login to the currently configured NiFi or NiFi-Registry server. @@ -306,7 +275,7 @@ def service_login(service='nifi', username=None, password=None, """ log_args = locals() - log_args['password'] = 'REDACTED' + log_args["password"] = "REDACTED" log.info("Called service_login with args %s", log_args) assert service in _valid_services assert username is None or isinstance(username, six.string_types) @@ -315,10 +284,11 @@ def service_login(service='nifi', username=None, password=None, configuration = getattr(nipyapi, service).configuration assert configuration.host, "Host must be set prior to logging in." - assert configuration.host.startswith("https"), \ - "Login is only available when connecting over HTTPS." - default_pword = getattr(nipyapi.config, 'default_' + service + '_password') - default_uname = getattr(nipyapi.config, 'default_' + service + '_username') + assert configuration.host.startswith( + "https" + ), "Login is only available when connecting over HTTPS." + default_pword = getattr(nipyapi.config, "default_" + service + "_password") + default_uname = getattr(nipyapi.config, "default_" + service + "_username") # We use copy so we don't clobber the default by mistake pword = password if password is not None else copy(default_pword) uname = username if username is not None else copy(default_uname) @@ -328,15 +298,18 @@ def service_login(service='nifi', username=None, password=None, # Registry pulls from config, NiFi allows submission configuration.username = uname configuration.password = pword - log.info("Attempting tokenAuth login with user identity [%s]", - configuration.username) + log.info( + "Attempting tokenAuth login with user identity [%s]", configuration.username + ) try: - if service == 'nifi': + if service == "nifi": token = nipyapi.nifi.AccessApi().create_access_token( - username=uname, password=pword) + username=uname, password=pword + ) else: - token = nipyapi.registry.AccessApi() \ - .create_access_token_using_basic_auth_credentials() + token = ( + nipyapi.registry.AccessApi().create_access_token_using_basic_auth_credentials() + ) set_service_auth_token(token=token, service=service) return True except getattr(nipyapi, service).rest.ApiException as e: @@ -345,7 +318,7 @@ def service_login(service='nifi', username=None, password=None, _raise(ValueError(e.body), e) -def set_service_auth_token(token=None, token_name='tokenAuth', service='nifi'): +def set_service_auth_token(token=None, token_name="tokenAuth", service="nifi"): """ Helper method to set the auth token correctly for the specified service @@ -361,13 +334,13 @@ def set_service_auth_token(token=None, token_name='tokenAuth', service='nifi'): assert service in _valid_services assert isinstance(token_name, six.string_types) assert token is None or isinstance(token, six.string_types) - if service == 'registry': + if service == "registry": configuration = nipyapi.config.registry_config else: configuration = nipyapi.config.nifi_config if token: configuration.api_key[token_name] = token - configuration.api_key_prefix[token_name] = 'Bearer' + configuration.api_key_prefix[token_name] = "Bearer" else: # If not token, then assume we are doing logout and cleanup if token_name in configuration.api_key: @@ -377,7 +350,7 @@ def set_service_auth_token(token=None, token_name='tokenAuth', service='nifi'): return True -def service_logout(service='nifi'): +def service_logout(service="nifi"): """ Logs out from the service by resetting the token Args: @@ -392,7 +365,7 @@ def service_logout(service='nifi'): try: status = get_service_access_status(service, bool_response=True) except ValueError as e: - if 'Cannot set verify_mode to CERT_NONE' in str(e): + if "Cannot set verify_mode to CERT_NONE" in str(e): status = None # Logout throws error with incorrect ssl setup else: @@ -402,7 +375,7 @@ def service_logout(service='nifi'): return False -def get_service_access_status(service='nifi', bool_response=False): +def get_service_access_status(service="nifi", bool_response=False): """ Gets the access status for the current session @@ -423,7 +396,7 @@ def get_service_access_status(service='nifi', bool_response=False): # Assume we are using this as a connection test and therefore disable # the Warnings urllib3 will shower us with log.debug("- bool_response is True, disabling urllib3 warnings") - logging.getLogger('urllib3').setLevel(logging.ERROR) + logging.getLogger("urllib3").setLevel(logging.ERROR) try: out = getattr(nipyapi, service).AccessApi().get_access_status() log.info("Got server response, returning") @@ -431,15 +404,18 @@ def get_service_access_status(service='nifi', bool_response=False): except urllib3.exceptions.MaxRetryError as e: log.debug("- Caught exception %s", type(e)) if bool_response: - log.debug("Connection failed with error %s and bool_response is " - "True, returning False", e) + log.debug( + "Connection failed with error %s and bool_response is " + "True, returning False", + e, + ) return False log.debug("- bool_response is False, raising Exception") raise e except getattr(nipyapi, service).rest.ApiException as e: expected_errors = [ - 'Authentication object was not found', - 'only supported when running over HTTPS' + "Authentication object was not found", + "only supported when running over HTTPS", ] if any(x in e.body for x in expected_errors): if bool_response: @@ -447,8 +423,7 @@ def get_service_access_status(service='nifi', bool_response=False): raise e -def add_user_to_access_policy(user, policy, service='nifi', refresh=True, - strict=True): +def add_user_to_access_policy(user, policy, service="nifi", refresh=True, strict=True): """ Attempts to add the given user object to the given access policy @@ -467,48 +442,55 @@ def add_user_to_access_policy(user, policy, service='nifi', refresh=True, assert service in _valid_services assert isinstance( policy, - nipyapi.registry.AccessPolicy if service == 'registry' - else nipyapi.nifi.AccessPolicyEntity + ( + nipyapi.registry.AccessPolicy + if service == "registry" + else nipyapi.nifi.AccessPolicyEntity + ), ) assert isinstance( user, - nipyapi.registry.User if service == 'registry' - else nipyapi.nifi.UserEntity + nipyapi.registry.User if service == "registry" else nipyapi.nifi.UserEntity, ) - user_id = user.id if service == 'nifi' else user.identifier + user_id = user.id if service == "nifi" else user.identifier if refresh: - policy_tgt = getattr(nipyapi, service).PoliciesApi().get_access_policy( - policy.id if service == 'nifi' else policy.identifier + policy_tgt = ( + getattr(nipyapi, service) + .PoliciesApi() + .get_access_policy(policy.id if service == "nifi" else policy.identifier) ) else: policy_tgt = policy assert isinstance( policy_tgt, - nipyapi.registry.AccessPolicy if service == 'registry' else - nipyapi.nifi.AccessPolicyEntity + ( + nipyapi.registry.AccessPolicy + if service == "registry" + else nipyapi.nifi.AccessPolicyEntity + ), ) - policy_users = policy_tgt.users if service == 'registry' else\ - policy_tgt.component.users + policy_users = ( + policy_tgt.users if service == "registry" else policy_tgt.component.users + ) policy_user_ids = [ - i.identifier if service == 'registry' else i.id for i in policy_users + i.identifier if service == "registry" else i.id for i in policy_users ] if user_id not in policy_user_ids: - if service == 'registry': + if service == "registry": policy_tgt.users.append(user) - elif service == 'nifi': - policy_tgt.component.users.append({'id': user_id}) + elif service == "nifi": + policy_tgt.component.users.append({"id": user_id}) return nipyapi.security.update_access_policy(policy_tgt, service) if strict and user_id in policy_user_ids: raise ValueError("Strict is True and User ID already in Policy") -def add_user_group_to_access_policy(user_group, policy, service='nifi', - refresh=True): +def add_user_group_to_access_policy(user_group, policy, service="nifi", refresh=True): """ Attempts to add the given user group object to the given access policy @@ -525,48 +507,58 @@ def add_user_group_to_access_policy(user_group, policy, service='nifi', assert service in _valid_services assert isinstance( policy, - nipyapi.registry.AccessPolicy if service == 'registry' - else nipyapi.nifi.AccessPolicyEntity + ( + nipyapi.registry.AccessPolicy + if service == "registry" + else nipyapi.nifi.AccessPolicyEntity + ), ) assert isinstance( user_group, - nipyapi.registry.UserGroup if service == 'registry' - else nipyapi.nifi.UserGroupEntity + ( + nipyapi.registry.UserGroup + if service == "registry" + else nipyapi.nifi.UserGroupEntity + ), ) - user_group_id = user_group.id if service == 'nifi' else \ - user_group.identifier + user_group_id = user_group.id if service == "nifi" else user_group.identifier if refresh: - policy_tgt = getattr(nipyapi, service).PoliciesApi().get_access_policy( - policy.id if service == 'nifi' else policy.identifier + policy_tgt = ( + getattr(nipyapi, service) + .PoliciesApi() + .get_access_policy(policy.id if service == "nifi" else policy.identifier) ) else: policy_tgt = policy assert isinstance( policy_tgt, - nipyapi.registry.AccessPolicy if service == 'registry' else - nipyapi.nifi.AccessPolicyEntity + ( + nipyapi.registry.AccessPolicy + if service == "registry" + else nipyapi.nifi.AccessPolicyEntity + ), ) - policy_user_groups = policy_tgt.users if service == 'registry' else\ - policy_tgt.component.user_groups + policy_user_groups = ( + policy_tgt.users if service == "registry" else policy_tgt.component.user_groups + ) policy_user_group_ids = [ - i.identifier if service == 'registry' else i.id - for i in policy_user_groups + i.identifier if service == "registry" else i.id for i in policy_user_groups ] assert user_group_id not in policy_user_group_ids - if service == 'registry': + if service == "registry": policy_tgt.user_groups.append(user_group) - elif service == 'nifi': - policy_tgt.component.user_groups.append({'id': user_group_id}) + elif service == "nifi": + policy_tgt.component.user_groups.append({"id": user_group_id}) return nipyapi.security.update_access_policy(policy_tgt, service) -def update_access_policy(policy, service='nifi'): +def update_access_policy(policy, service="nifi"): """ Applies an updated access policy to the service indicated @@ -581,21 +573,25 @@ def update_access_policy(policy, service='nifi'): assert service in _valid_services assert isinstance( policy, - nipyapi.registry.AccessPolicy if service == 'registry' - else nipyapi.nifi.AccessPolicyEntity + ( + nipyapi.registry.AccessPolicy + if service == "registry" + else nipyapi.nifi.AccessPolicyEntity + ), ), "Policy type {0} not valid.".format(type(policy)) with nipyapi.utils.rest_exceptions(): - return getattr(nipyapi, service).PoliciesApi().update_access_policy( - id=policy.id if service == 'nifi' else policy.identifier, - body=policy + return ( + getattr(nipyapi, service) + .PoliciesApi() + .update_access_policy( + id=policy.id if service == "nifi" else policy.identifier, body=policy + ) ) -def get_access_policy_for_resource(resource, - action, - r_id=None, - service='nifi', - auto_create=False): +def get_access_policy_for_resource( + resource, action, r_id=None, service="nifi", auto_create=False +): """ Attempts to retrieve the access policy for a given resource and action, and optionally resource_id if targeting NiFi. Optionally creates the policy @@ -622,25 +618,23 @@ def get_access_policy_for_resource(resource, log.info("Called get_access_policy_for_resource with Args %s", locals()) # Strip leading '/' from resource as lookup endpoint prepends a '/' - resource = resource[1:] if resource.startswith('/') else resource - log.info("Getting %s Policy for %s:%s:%s", service, action, - resource, str(r_id)) - if service == 'nifi': + resource = resource[1:] if resource.startswith("/") else resource + log.info("Getting %s Policy for %s:%s:%s", service, action, resource, str(r_id)) + if service == "nifi": pol_api = nipyapi.nifi.PoliciesApi() else: pol_api = nipyapi.registry.PoliciesApi() try: nipyapi.utils.bypass_slash_encoding(service, True) response = pol_api.get_access_policy_for_resource( - action=action, - resource='/'.join([resource, r_id]) if r_id else resource + action=action, resource="/".join([resource, r_id]) if r_id else resource ) nipyapi.utils.bypass_slash_encoding(service, False) return response except nipyapi.nifi.rest.ApiException as e: if any( - pol_string in e.body for pol_string in - ['Unable to find access policy', 'No policy found'] + pol_string in e.body + for pol_string in ["Unable to find access policy", "No policy found"] ): log.info("Access policy not found") if not auto_create: @@ -654,7 +648,7 @@ def get_access_policy_for_resource(resource, nipyapi.utils.bypass_slash_encoding(service, False) -def create_access_policy(resource, action, r_id=None, service='nifi'): +def create_access_policy(resource, action, r_id=None, service="nifi"): """ Creates an access policy for the given resource, action and optionally resource_id for NiFi. @@ -674,37 +668,34 @@ def create_access_policy(resource, action, r_id=None, service='nifi'): assert action in _valid_actions assert r_id is None or isinstance(r_id, six.string_types) assert service in _valid_services - if resource[0] != '/': - r = '/' + resource + if resource[0] != "/": + r = "/" + resource else: r = resource with nipyapi.utils.rest_exceptions(): - if service == 'nifi': + if service == "nifi": return nipyapi.nifi.PoliciesApi().create_access_policy( body=nipyapi.nifi.AccessPolicyEntity( revision=nipyapi.nifi.RevisionDTO(version=0), component=nipyapi.nifi.AccessPolicyDTO( - action=action, - resource='/'.join([r, r_id]) if r_id else r - ) + action=action, resource="/".join([r, r_id]) if r_id else r + ), ) ) # elif service == 'registry': return nipyapi.registry.PoliciesApi().create_access_policy( - body=nipyapi.registry.AccessPolicy( - action=action, - resource=r - ) + body=nipyapi.registry.AccessPolicy(action=action, resource=r) ) def set_service_ssl_context( - service='nifi', - ca_file=None, - client_cert_file=None, - client_key_file=None, - client_key_password=None, - check_hostname=None): + service="nifi", + ca_file=None, + client_cert_file=None, + client_key_file=None, + client_key_password=None, + check_hostname=None, +): """ Create an SSLContext for connecting over https to a secured NiFi or NiFi-Registry instance. @@ -736,7 +727,7 @@ def set_service_ssl_context( Returns: (None) """ - assert service in ['nifi', 'registry'] + assert service in ["nifi", "registry"] if client_key_file is None: ssl_context = ssl.create_default_context(ssl.Purpose.SERVER_AUTH) else: @@ -745,13 +736,25 @@ def set_service_ssl_context( ssl_context.load_cert_chain( certfile=client_cert_file, keyfile=client_key_file, - password=client_key_password + password=client_key_password, ) except FileNotFoundError as e: _raise( FileNotFoundError( - "Unable to read keyfile {0} or certfile {1}" - .format(client_key_file, client_cert_file)), e) + "Unable to read keyfile {0} or certfile {1}".format( + client_key_file, client_cert_file + ) + ), + e, + ) + except ssl.SSLError as e: + if e.errno == 9: + _raise( + ssl.SSLError( + "This error possibly pertains to a mis-typed or incorrect key password" + ), + e, + ) if ca_file is not None: ssl_context.load_verify_locations(cafile=ca_file) @@ -761,15 +764,14 @@ def set_service_ssl_context( else: ssl_context.check_hostname = nipyapi.config.global_ssl_host_check - if service == 'registry': + if service == "registry": nipyapi.config.registry_config.ssl_context = ssl_context - elif service == 'nifi': + elif service == "nifi": nipyapi.config.nifi_config.ssl_context = ssl_context # pylint: disable=W0702,R0912 -def bootstrap_security_policies(service, user_identity=None, - group_identity=None): +def bootstrap_security_policies(service, user_identity=None, group_identity=None): """ Creates a default security context within NiFi or Nifi-Registry @@ -786,29 +788,28 @@ def bootstrap_security_policies(service, user_identity=None, valid_ident_obj = [nipyapi.nifi.UserEntity, nipyapi.registry.User] if user_identity is not None: assert type(user_identity) in valid_ident_obj - if 'nifi' in service: + if "nifi" in service: rpg_id = nipyapi.canvas.get_root_pg_id() if user_identity is None and group_identity is None: nifi_user_identity = nipyapi.security.get_service_user( - nipyapi.config.default_nifi_username, - service='nifi' + nipyapi.config.default_nifi_username, service="nifi" ) else: nifi_user_identity = user_identity access_policies = [ - ('write', 'process-groups', rpg_id), - ('read', 'process-groups', rpg_id), - ('write', 'data/process-groups', rpg_id), - ('read', 'data/process-groups', rpg_id), - ('read', 'system', None), + ("write", "process-groups", rpg_id), + ("read", "process-groups", rpg_id), + ("write", "data/process-groups", rpg_id), + ("read", "data/process-groups", rpg_id), + ("read", "system", None), ] for pol in access_policies: ap = nipyapi.security.get_access_policy_for_resource( action=pol[0], resource=pol[1], r_id=pol[2], - service='nifi', - auto_create=True + service="nifi", + auto_create=True, ) if nifi_user_identity is None: # I should not rely upon a try/catch there @@ -816,57 +817,41 @@ def bootstrap_security_policies(service, user_identity=None, # break the server :-) ) try: nipyapi.security.add_user_group_to_access_policy( - user_group=group_identity, - policy=ap, - service='nifi' + user_group=group_identity, policy=ap, service="nifi" ) except: # noqa pass else: nipyapi.security.add_user_to_access_policy( - user=nifi_user_identity, - policy=ap, - service='nifi', - strict=False + user=nifi_user_identity, policy=ap, service="nifi", strict=False ) else: if user_identity is None and group_identity is None: reg_user_identity = nipyapi.security.get_service_user( - nipyapi.config.default_registry_username, - service='registry' + nipyapi.config.default_registry_username, service="registry" ) else: reg_user_identity = user_identity all_buckets_access_policies = [ ("read", "/buckets"), ("write", "/buckets"), - ("delete", "/buckets") + ("delete", "/buckets"), ] for action, resource in all_buckets_access_policies: pol = nipyapi.security.get_access_policy_for_resource( - resource=resource, - action=action, - service='registry', - auto_create=True + resource=resource, action=action, service="registry", auto_create=True ) if reg_user_identity is None: nipyapi.security.add_user_group_to_access_policy( - user_group=group_identity, - policy=pol, - service='registry' + user_group=group_identity, policy=pol, service="registry" ) else: nipyapi.security.add_user_to_access_policy( - user=reg_user_identity, - policy=pol, - service='registry', - strict=False + user=reg_user_identity, policy=pol, service="registry", strict=False ) # Setup Proxy Access nifi_proxy = nipyapi.security.create_service_user( - identity=nipyapi.config.default_proxy_user, - service='registry', - strict=False + identity=nipyapi.config.default_proxy_user, service="registry", strict=False ) proxy_access_policies = [ ("read", "/proxy"), @@ -875,14 +860,8 @@ def bootstrap_security_policies(service, user_identity=None, ] for action, resource in proxy_access_policies: pol = nipyapi.security.get_access_policy_for_resource( - resource=resource, - action=action, - service='registry', - auto_create=True + resource=resource, action=action, service="registry", auto_create=True ) nipyapi.security.add_user_to_access_policy( - user=nifi_proxy, - policy=pol, - service='registry', - strict=False + user=nifi_proxy, policy=pol, service="registry", strict=False ) From 6907d86e889c295066c50e5ebd49f1b85f6051ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Arnauts?= Date: Wed, 2 Oct 2024 23:03:44 +0200 Subject: [PATCH 03/11] Handle plain text response types so json values are properly returned (#358) --- nipyapi/nifi/api_client.py | 4 ++++ resources/client_gen/swagger_templates/api_client.mustache | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/nipyapi/nifi/api_client.py b/nipyapi/nifi/api_client.py index b3aedf2b..b65a70a9 100644 --- a/nipyapi/nifi/api_client.py +++ b/nipyapi/nifi/api_client.py @@ -235,6 +235,10 @@ def deserialize(self, response, response_type): if response_type == "file": return self.__deserialize_file(response) + # handle plain text response + if response_type == "str": + return response.data + # fetch data from response object try: data = json.loads(response.data) diff --git a/resources/client_gen/swagger_templates/api_client.mustache b/resources/client_gen/swagger_templates/api_client.mustache index d017061f..de0eff27 100644 --- a/resources/client_gen/swagger_templates/api_client.mustache +++ b/resources/client_gen/swagger_templates/api_client.mustache @@ -226,6 +226,10 @@ class ApiClient(object): if response_type == "file": return self.__deserialize_file(response) + # handle plain text response + if response_type == "str": + return response.data + # fetch data from response object try: data = json.loads(response.data) From 93514f7fa35fc4fe6aeabbaffaa83dc56ed86a12 Mon Sep 17 00:00:00 2001 From: Dan Chaffelson Date: Thu, 3 Oct 2024 16:33:03 +0100 Subject: [PATCH 04/11] 202410 updates (#364) * regenerate pylintrc for newer standards. * Remove outdated setattr usages. * Remove outdated todo statements. * Fix whitespace and line length linting. * Update ruamel.yaml usage to avoid deprecation warnings. * add default timeout to requets calls for registry swagger. * Fixes #351 * Fixes #342 * Fix HTTPResponse.getheaders() deprecation warning with py2/py3 compatitbility * Call Configuration() once in rest clients * added explanation about safe yaml loader * ensure latest flow version by sorting. Fixes #326 * set py>-1.11.0 to avoid false positive cve warning * bump pytest>=7.2.0 to remove py dependency --- nipyapi/canvas.py | 13 +- nipyapi/demo/fdlc.py | 1 - nipyapi/demo/secure_connection.py | 1 - nipyapi/nifi/configuration.py | 2 + nipyapi/nifi/rest.py | 31 +- nipyapi/parameters.py | 2 +- nipyapi/registry/configuration.py | 2 + nipyapi/registry/rest.py | 31 +- nipyapi/security.py | 137 +++- nipyapi/utils.py | 31 +- nipyapi/versioning.py | 30 +- pylintrc | 689 ++++++++++++------ requirements_dev.txt | 4 +- .../swagger_templates/configuration.mustache | 2 + .../swagger_templates/rest.mustache | 31 +- 15 files changed, 648 insertions(+), 359 deletions(-) diff --git a/nipyapi/canvas.py b/nipyapi/canvas.py index 982a7067..ee4086b1 100644 --- a/nipyapi/canvas.py +++ b/nipyapi/canvas.py @@ -67,10 +67,7 @@ def recurse_flow(pg_id='root'): while tasks: this_pg_id, this_parent_obj = tasks.pop() this_flow = get_flow(this_pg_id) - this_parent_obj.__setattr__( - 'nipyapi_extended', - this_flow - ) + setattr(this_parent_obj, 'nipyapi_extended', this_flow) tasks += [(x.id, x) for x in this_flow.process_group_flow.flow.process_groups] return out @@ -182,8 +179,7 @@ def flatten(parent_pg): Generator for all ProcessGroupEntities, eventually """ for child_pg in parent_pg.process_group_flow.flow.process_groups: - for sub in flatten(child_pg.nipyapi_extended): - yield sub + yield from flatten(child_pg.nipyapi_extended) yield child_pg # Recurse children @@ -192,7 +188,7 @@ def flatten(parent_pg): out = list(flatten(root_flow)) # update parent with flattened list of extended child detail root_entity = get_process_group(pg_id, 'id') - root_entity.__setattr__('nipyapi_extended', root_flow) + setattr(root_entity, 'nipyapi_extended', root_flow) out.append(root_entity) return out # @@ -995,7 +991,6 @@ def purge_connection(con_id): """ - # TODO: Reimplement to batched instead of single threaded def _autumn_leaves(con_id_, drop_request_): test_obj = nipyapi.nifi.FlowfileQueuesApi().get_drop_request( con_id_, @@ -1368,7 +1363,7 @@ def list_all_by_kind(kind, pg_id='root', descendants=True): else: pgs = [get_process_group(pg_id, 'id')] for pg in pgs: - out += call_function(pg.id).__getattribute__(kind) + out += getattr(call_function(pg.id), kind) return out diff --git a/nipyapi/demo/fdlc.py b/nipyapi/demo/fdlc.py index ebb4989c..e46c26cf 100644 --- a/nipyapi/demo/fdlc.py +++ b/nipyapi/demo/fdlc.py @@ -446,7 +446,6 @@ def step_f_set_sensitive_values(): " process. Typically these values will be looked up in a Config DB " "or some other secured service." "\nPlease now call 'step_g_check_invalid_processors()'\n") - # Todo: update sensitive to return properites list precreated def step_g_check_invalid_processors(): diff --git a/nipyapi/demo/secure_connection.py b/nipyapi/demo/secure_connection.py index d03b4a04..47996a5e 100644 --- a/nipyapi/demo/secure_connection.py +++ b/nipyapi/demo/secure_connection.py @@ -91,7 +91,6 @@ host_certs_path: {'bind': '/opt/certs', 'mode': 'ro'} }, ), - # TODO add ldap docker container. # For now this uses a publicly available LDAP test server ] diff --git a/nipyapi/nifi/configuration.py b/nipyapi/nifi/configuration.py index 929de51c..5eae1576 100644 --- a/nipyapi/nifi/configuration.py +++ b/nipyapi/nifi/configuration.py @@ -86,6 +86,8 @@ def __init__(self): self.cert_file = None # client key file self.key_file = None + # client key password + self.key_password = None # Alternative TLS configuration: set this to an instance of ssl.SSLContext or urllib3.util.ssl_.SSLContext self.ssl_context = None diff --git a/nipyapi/nifi/rest.py b/nipyapi/nifi/rest.py index 2781c1ac..c5b11c92 100644 --- a/nipyapi/nifi/rest.py +++ b/nipyapi/nifi/rest.py @@ -66,30 +66,29 @@ def __init__(self, pools_size=4, maxsize=4): # ca_certs vs cert_file vs key_file # http://stackoverflow.com/a/23957365/2985775 + config = Configuration() + # cert_reqs - if Configuration().verify_ssl: - cert_reqs = ssl.CERT_REQUIRED - else: - cert_reqs = ssl.CERT_NONE + cert_reqs = ssl.CERT_REQUIRED if config.verify_ssl else ssl.CERT_NONE # ca_certs - if Configuration().ssl_ca_cert: - ca_certs = Configuration().ssl_ca_cert - else: - # if not set certificate file, use Mozilla's root certificates. - ca_certs = certifi.where() + ca_certs = (config.ssl_ca_cert if config.ssl_ca_cert + else certifi.where()) # cert_file - cert_file = Configuration().cert_file + cert_file = config.cert_file # key file - key_file = Configuration().key_file + key_file = config.key_file + + # key password + key_password = config.key_password # ssl_context - ssl_context = Configuration().ssl_context + ssl_context = config.ssl_context # proxy - proxy = Configuration().proxy + proxy = config.proxy # https pool manager if proxy and "socks" not in str(proxy): @@ -100,6 +99,7 @@ def __init__(self, pools_size=4, maxsize=4): ca_certs=ca_certs, cert_file=cert_file, key_file=key_file, + key_password=key_password, ssl_context=ssl_context, proxy_url=proxy ) @@ -111,6 +111,7 @@ def __init__(self, pools_size=4, maxsize=4): ca_certs=ca_certs, cert_file=cert_file, key_file=key_file, + key_password=key_password, ssl_context=ssl_context, proxy_url=proxy ) @@ -122,6 +123,7 @@ def __init__(self, pools_size=4, maxsize=4): ca_certs=ca_certs, cert_file=cert_file, key_file=key_file, + key_password=key_password, ssl_context=ssl_context ) @@ -306,7 +308,8 @@ def __init__(self, status=None, reason=None, http_resp=None): self.status = http_resp.status self.reason = http_resp.reason self.body = http_resp.data - self.headers = http_resp.getheaders() + self.headers = (http_resp.headers if hasattr(http_resp, 'headers') + else http_resp.getheaders()) else: self.status = status self.reason = reason diff --git a/nipyapi/parameters.py b/nipyapi/parameters.py index e3993bc4..47e02297 100644 --- a/nipyapi/parameters.py +++ b/nipyapi/parameters.py @@ -9,7 +9,7 @@ import six import nipyapi from nipyapi.utils import exception_handler, enforce_min_ver -from nipyapi.nifi import ParameterContextEntity, ParameterDTO,\ +from nipyapi.nifi import ParameterContextEntity, ParameterDTO, \ ParameterEntity, ParameterContextDTO log = logging.getLogger(__name__) diff --git a/nipyapi/registry/configuration.py b/nipyapi/registry/configuration.py index 00f7b2e1..e4edcd84 100644 --- a/nipyapi/registry/configuration.py +++ b/nipyapi/registry/configuration.py @@ -86,6 +86,8 @@ def __init__(self): self.cert_file = None # client key file self.key_file = None + # client key password + self.key_password = None # Alternative TLS configuration: set this to an instance of ssl.SSLContext or urllib3.util.ssl_.SSLContext self.ssl_context = None diff --git a/nipyapi/registry/rest.py b/nipyapi/registry/rest.py index 289065d5..9a43f7b5 100644 --- a/nipyapi/registry/rest.py +++ b/nipyapi/registry/rest.py @@ -66,30 +66,29 @@ def __init__(self, pools_size=4, maxsize=4): # ca_certs vs cert_file vs key_file # http://stackoverflow.com/a/23957365/2985775 + config = Configuration() + # cert_reqs - if Configuration().verify_ssl: - cert_reqs = ssl.CERT_REQUIRED - else: - cert_reqs = ssl.CERT_NONE + cert_reqs = ssl.CERT_REQUIRED if config.verify_ssl else ssl.CERT_NONE # ca_certs - if Configuration().ssl_ca_cert: - ca_certs = Configuration().ssl_ca_cert - else: - # if not set certificate file, use Mozilla's root certificates. - ca_certs = certifi.where() + ca_certs = (config.ssl_ca_cert if config.ssl_ca_cert + else certifi.where()) # cert_file - cert_file = Configuration().cert_file + cert_file = config.cert_file # key file - key_file = Configuration().key_file + key_file = config.key_file + + # key password + key_password = config.key_password # ssl_context - ssl_context = Configuration().ssl_context + ssl_context = config.ssl_context # proxy - proxy = Configuration().proxy + proxy = config.proxy # https pool manager if proxy and "socks" not in str(proxy): @@ -100,6 +99,7 @@ def __init__(self, pools_size=4, maxsize=4): ca_certs=ca_certs, cert_file=cert_file, key_file=key_file, + key_password=key_password, ssl_context=ssl_context, proxy_url=proxy ) @@ -111,6 +111,7 @@ def __init__(self, pools_size=4, maxsize=4): ca_certs=ca_certs, cert_file=cert_file, key_file=key_file, + key_password=key_password, ssl_context=ssl_context, proxy_url=proxy ) @@ -122,6 +123,7 @@ def __init__(self, pools_size=4, maxsize=4): ca_certs=ca_certs, cert_file=cert_file, key_file=key_file, + key_password=key_password, ssl_context=ssl_context ) @@ -306,7 +308,8 @@ def __init__(self, status=None, reason=None, http_resp=None): self.status = http_resp.status self.reason = http_resp.reason self.body = http_resp.data - self.headers = http_resp.getheaders() + self.headers = (http_resp.headers if hasattr(http_resp, 'headers') + else http_resp.getheaders()) else: self.status = status self.reason = reason diff --git a/nipyapi/security.py b/nipyapi/security.py index 59357f7b..f10598a9 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -71,7 +71,8 @@ def get_service_user(identifier, identifier_type="identity", service="nifi"): assert isinstance(identifier, six.string_types) assert isinstance(identifier_type, six.string_types) obj = list_service_users(service) - out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=False) + out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, + greedy=False) return out @@ -130,13 +131,15 @@ def create_service_user(identity, service="nifi", strict=True): ) try: return getattr(nipyapi, service).TenantsApi().create_user(user_obj) - except (nipyapi.nifi.rest.ApiException, nipyapi.registry.rest.ApiException) as e: + except (nipyapi.nifi.rest.ApiException, + nipyapi.registry.rest.ApiException) as e: if "already exists" in e.body and not strict: return get_service_user(identity, service=service) _raise(ValueError(e.body), e) -def create_service_user_group(identity, service="nifi", users=None, strict=True): +def create_service_user_group(identity, service="nifi", users=None, + strict=True): """ Attempts to create a user with the provided identity and member users in the given service @@ -159,20 +162,26 @@ def create_service_user_group(identity, service="nifi", users=None, strict=True) if service == "nifi": if users: - assert all(isinstance(user, nipyapi.nifi.UserEntity) for user in users) + assert all(isinstance(user, nipyapi.nifi.UserEntity) + for user in users) users_ids = [{"id": user.id} for user in users] user_group_obj = nipyapi.nifi.UserGroupEntity( revision=nipyapi.nifi.RevisionDTO(version=0), - component=nipyapi.nifi.UserGroupDTO(identity=identity, users=users_ids), + component=nipyapi.nifi.UserGroupDTO(identity=identity, + users=users_ids), ) else: if users: - assert all(isinstance(user, nipyapi.registry.User) for user in users) + assert all(isinstance(user, nipyapi.registry.User) + for user in users) users_ids = [{"identifier": user.identifier} for user in users] - user_group_obj = nipyapi.registry.UserGroup(identity=identity, users=users_ids) + user_group_obj = nipyapi.registry.UserGroup(identity=identity, + users=users_ids) try: - return getattr(nipyapi, service).TenantsApi().create_user_group(user_group_obj) - except (nipyapi.nifi.rest.ApiException, nipyapi.registry.rest.ApiException) as e: + return getattr(nipyapi, service).TenantsApi().create_user_group( + user_group_obj) + except (nipyapi.nifi.rest.ApiException, + nipyapi.registry.rest.ApiException) as e: if "already exists" in e.body: if not strict: return get_service_user_group(identity, service=service) @@ -197,7 +206,8 @@ def list_service_user_groups(service="nifi"): return out -def get_service_user_group(identifier, identifier_type="identity", service="nifi"): +def get_service_user_group(identifier, identifier_type="identity", + service="nifi"): """ Gets the unique group matching to the given identifier and type. @@ -214,7 +224,8 @@ def get_service_user_group(identifier, identifier_type="identity", service="nifi assert isinstance(identifier, six.string_types) assert isinstance(identifier_type, six.string_types) obj = list_service_user_groups(service) - out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, greedy=False) + out = nipyapi.utils.filter_obj(obj, identifier, identifier_type, + greedy=False) return out @@ -239,7 +250,8 @@ def remove_service_user_group(group, service="nifi", strict=True): submit = {"id": group.id, "version": group.revision.version} assert isinstance(strict, bool) try: - return getattr(nipyapi, service).TenantsApi().remove_user_group(**submit) + return getattr(nipyapi, service).TenantsApi().remove_user_group( + **submit) except getattr(nipyapi, service).rest.ApiException as e: if "Unable to find user" in e.body or "does not exist" in e.body: if not strict: @@ -247,7 +259,8 @@ def remove_service_user_group(group, service="nifi", strict=True): _raise(ValueError(e.body), e) -def service_login(service="nifi", username=None, password=None, bool_response=False): +def service_login(service="nifi", username=None, password=None, + bool_response=False): """ Login to the currently configured NiFi or NiFi-Registry server. @@ -299,7 +312,8 @@ def service_login(service="nifi", username=None, password=None, bool_response=Fa configuration.username = uname configuration.password = pword log.info( - "Attempting tokenAuth login with user identity [%s]", configuration.username + "Attempting tokenAuth login with user identity [%s]", + configuration.username ) try: if service == "nifi": @@ -308,7 +322,8 @@ def service_login(service="nifi", username=None, password=None, bool_response=Fa ) else: token = ( - nipyapi.registry.AccessApi().create_access_token_using_basic_auth_credentials() + nipyapi.registry.AccessApi() + .create_access_token_using_basic_auth_credentials() ) set_service_auth_token(token=token, service=service) return True @@ -423,7 +438,8 @@ def get_service_access_status(service="nifi", bool_response=False): raise e -def add_user_to_access_policy(user, policy, service="nifi", refresh=True, strict=True): +def add_user_to_access_policy(user, policy, service="nifi", refresh=True, + strict=True): """ Attempts to add the given user object to the given access policy @@ -450,7 +466,8 @@ def add_user_to_access_policy(user, policy, service="nifi", refresh=True, strict ) assert isinstance( user, - nipyapi.registry.User if service == "registry" else nipyapi.nifi.UserEntity, + nipyapi.registry.User if service == "registry" + else nipyapi.nifi.UserEntity, ) user_id = user.id if service == "nifi" else user.identifier @@ -459,7 +476,8 @@ def add_user_to_access_policy(user, policy, service="nifi", refresh=True, strict policy_tgt = ( getattr(nipyapi, service) .PoliciesApi() - .get_access_policy(policy.id if service == "nifi" else policy.identifier) + .get_access_policy(policy.id if service == "nifi" + else policy.identifier) ) else: policy_tgt = policy @@ -474,7 +492,8 @@ def add_user_to_access_policy(user, policy, service="nifi", refresh=True, strict ) policy_users = ( - policy_tgt.users if service == "registry" else policy_tgt.component.users + policy_tgt.users if service == "registry" + else policy_tgt.component.users ) policy_user_ids = [ i.identifier if service == "registry" else i.id for i in policy_users @@ -490,7 +509,8 @@ def add_user_to_access_policy(user, policy, service="nifi", refresh=True, strict raise ValueError("Strict is True and User ID already in Policy") -def add_user_group_to_access_policy(user_group, policy, service="nifi", refresh=True): +def add_user_group_to_access_policy(user_group, policy, service="nifi", + refresh=True): """ Attempts to add the given user group object to the given access policy @@ -521,13 +541,16 @@ def add_user_group_to_access_policy(user_group, policy, service="nifi", refresh= else nipyapi.nifi.UserGroupEntity ), ) - user_group_id = user_group.id if service == "nifi" else user_group.identifier + user_group_id = ( + user_group.id if service == "nifi" else user_group.identifier + ) if refresh: policy_tgt = ( getattr(nipyapi, service) .PoliciesApi() - .get_access_policy(policy.id if service == "nifi" else policy.identifier) + .get_access_policy(policy.id if service == "nifi" + else policy.identifier) ) else: policy_tgt = policy @@ -542,10 +565,12 @@ def add_user_group_to_access_policy(user_group, policy, service="nifi", refresh= ) policy_user_groups = ( - policy_tgt.users if service == "registry" else policy_tgt.component.user_groups + policy_tgt.users if service == "registry" + else policy_tgt.component.user_groups ) policy_user_group_ids = [ - i.identifier if service == "registry" else i.id for i in policy_user_groups + i.identifier if service == "registry" else i.id + for i in policy_user_groups ] assert user_group_id not in policy_user_group_ids @@ -584,7 +609,8 @@ def update_access_policy(policy, service="nifi"): getattr(nipyapi, service) .PoliciesApi() .update_access_policy( - id=policy.id if service == "nifi" else policy.identifier, body=policy + id=policy.id if service == "nifi" else policy.identifier, + body=policy ) ) @@ -619,7 +645,8 @@ def get_access_policy_for_resource( # Strip leading '/' from resource as lookup endpoint prepends a '/' resource = resource[1:] if resource.startswith("/") else resource - log.info("Getting %s Policy for %s:%s:%s", service, action, resource, str(r_id)) + log.info("Getting %s Policy for %s:%s:%s", service, action, resource, + str(r_id)) if service == "nifi": pol_api = nipyapi.nifi.PoliciesApi() else: @@ -627,14 +654,19 @@ def get_access_policy_for_resource( try: nipyapi.utils.bypass_slash_encoding(service, True) response = pol_api.get_access_policy_for_resource( - action=action, resource="/".join([resource, r_id]) if r_id else resource + action=action, + resource="/".join([resource, r_id]) if r_id else resource ) nipyapi.utils.bypass_slash_encoding(service, False) return response except nipyapi.nifi.rest.ApiException as e: if any( pol_string in e.body - for pol_string in ["Unable to find access policy", "No policy found"] + for pol_string in [ + "Unable to find access policy", + "No policy found", + "No access policy found", + ] ): log.info("Access policy not found") if not auto_create: @@ -678,7 +710,8 @@ def create_access_policy(resource, action, r_id=None, service="nifi"): body=nipyapi.nifi.AccessPolicyEntity( revision=nipyapi.nifi.RevisionDTO(version=0), component=nipyapi.nifi.AccessPolicyDTO( - action=action, resource="/".join([r, r_id]) if r_id else r + action=action, + resource="/".join([r, r_id]) if r_id else r ), ) ) @@ -688,6 +721,7 @@ def create_access_policy(resource, action, r_id=None, service="nifi"): ) +# pylint: disable=R0913 def set_service_ssl_context( service="nifi", ca_file=None, @@ -751,7 +785,8 @@ def set_service_ssl_context( if e.errno == 9: _raise( ssl.SSLError( - "This error possibly pertains to a mis-typed or incorrect key password" + "This error possibly pertains to a mis-typed or " + "incorrect key password" ), e, ) @@ -771,7 +806,8 @@ def set_service_ssl_context( # pylint: disable=W0702,R0912 -def bootstrap_security_policies(service, user_identity=None, group_identity=None): +def bootstrap_security_policies(service, user_identity=None, + group_identity=None): """ Creates a default security context within NiFi or Nifi-Registry @@ -817,18 +853,24 @@ def bootstrap_security_policies(service, user_identity=None, group_identity=None # break the server :-) ) try: nipyapi.security.add_user_group_to_access_policy( - user_group=group_identity, policy=ap, service="nifi" + user_group=group_identity, + policy=ap, + service="nifi" ) except: # noqa pass else: nipyapi.security.add_user_to_access_policy( - user=nifi_user_identity, policy=ap, service="nifi", strict=False + user=nifi_user_identity, + policy=ap, + service="nifi", + strict=False ) else: if user_identity is None and group_identity is None: reg_user_identity = nipyapi.security.get_service_user( - nipyapi.config.default_registry_username, service="registry" + nipyapi.config.default_registry_username, + service="registry" ) else: reg_user_identity = user_identity @@ -839,19 +881,28 @@ def bootstrap_security_policies(service, user_identity=None, group_identity=None ] for action, resource in all_buckets_access_policies: pol = nipyapi.security.get_access_policy_for_resource( - resource=resource, action=action, service="registry", auto_create=True + resource=resource, + action=action, + service="registry", + auto_create=True ) if reg_user_identity is None: nipyapi.security.add_user_group_to_access_policy( - user_group=group_identity, policy=pol, service="registry" + user_group=group_identity, + policy=pol, + service="registry" ) else: nipyapi.security.add_user_to_access_policy( - user=reg_user_identity, policy=pol, service="registry", strict=False + user=reg_user_identity, policy=pol, + service="registry", + strict=False ) # Setup Proxy Access nifi_proxy = nipyapi.security.create_service_user( - identity=nipyapi.config.default_proxy_user, service="registry", strict=False + identity=nipyapi.config.default_proxy_user, + service="registry", + strict=False ) proxy_access_policies = [ ("read", "/proxy"), @@ -860,8 +911,14 @@ def bootstrap_security_policies(service, user_identity=None, group_identity=None ] for action, resource in proxy_access_policies: pol = nipyapi.security.get_access_policy_for_resource( - resource=resource, action=action, service="registry", auto_create=True + resource=resource, + action=action, + service="registry", + auto_create=True ) nipyapi.security.add_user_to_access_policy( - user=nifi_proxy, policy=pol, service="registry", strict=False + user=nifi_proxy, + policy=pol, + service="registry", + strict=False ) diff --git a/nipyapi/utils.py b/nipyapi/utils.py index a05cf76c..330ceabd 100644 --- a/nipyapi/utils.py +++ b/nipyapi/utils.py @@ -17,7 +17,7 @@ from contextlib import contextmanager from packaging import version import six -import ruamel.yaml +from ruamel.yaml import YAML import docker from docker.errors import ImageNotFound import requests @@ -57,17 +57,20 @@ def dump(obj, mode='json'): obj=prepared_obj, sort_keys=True, indent=4 - # default=_json_default ) except TypeError as e: raise e if mode == 'json': return out if mode == 'yaml': - return ruamel.yaml.safe_dump( - json.loads(out), - default_flow_style=False - ) + # Use 'safe' loading to prevent arbitrary code execution + yaml = YAML(typ='safe', pure=True) + # Create a StringIO object to act as the stream + stream = io.StringIO() + # Dump to the StringIO stream + yaml.dump(json.loads(out), stream) + # Return the contents of the stream as a string + return stream.getvalue() raise ValueError("Invalid dump Mode specified {0}".format(mode)) @@ -93,12 +96,8 @@ def load(obj, dto=None): """ assert isinstance(obj, (six.string_types, bytes)) assert dto is None or isinstance(dto, tuple) - # ensure object is standard json before reusing the api_client deserializer - # safe_load from ruamel.yaml as it doesn't accidentally convert str - # to unicode in py2. It also manages both json and yaml equally well - # Good explanation: https://stackoverflow.com/a/16373377/4717963 - # Safe Load also helps prevent code injection - loaded_obj = ruamel.yaml.safe_load(obj) + yaml = YAML(typ='safe', pure=True) + loaded_obj = yaml.load(obj) if dto: assert dto[0] in ['nifi', 'registry'] assert isinstance(dto[1], six.string_types) @@ -369,9 +368,11 @@ def get_test_url_status(self): :return: status code if available, String 'ConnectionError' if not """ try: - return requests.get(self.test_url).status_code + return requests.get(self.test_url, timeout=10).status_code except requests.ConnectionError: return 'ConnectionError' + except requests.Timeout: + return 'Timeout' def set_container(self, container): """Set the container object""" @@ -514,8 +515,8 @@ def check_version(base, comparator=None, service='nifi', ver_b = version.parse(reg_json['info']['version']) except nipyapi.registry.rest.ApiException: log.warning( - "Unable to retrieve registry swagger.json, assuming version %s" - % default_version) + "Unable to get registry swagger.json, assuming version %s", + default_version) ver_b = version.parse(default_version) else: # Working with NiFi diff --git a/nipyapi/versioning.py b/nipyapi/versioning.py index 795e4965..6bd985ee 100644 --- a/nipyapi/versioning.py +++ b/nipyapi/versioning.py @@ -305,7 +305,6 @@ def revert_flow_ver(process_group): Returns: (VersionedFlowUpdateRequestEntity) """ - # ToDo: Add handling for flows with live data assert isinstance(process_group, nipyapi.nifi.ProcessGroupEntity) with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.VersionsApi().initiate_revert_flow_version( @@ -519,7 +518,7 @@ def create_flow_version(flow, flow_snapshot, refresh=True): bad_params = ['link'] for obj in [target_bucket, target_flow]: for p in bad_params: - obj.__setattr__(p, None) + setattr(obj, p, None) nipyapi.utils.validate_parameters_versioning_support(verify_nifi=False) ecs = flow_snapshot.external_controller_services return nipyapi.registry.BucketFlowsApi().create_flow_version( @@ -719,6 +718,8 @@ def deploy_flow_version(parent_id, location, bucket_id, flow_id, reg_client_id, Returns: (ProcessGroupEntity) of the newly deployed Process Group """ + # Default location to (0, 0) if not provided per Issue #342 + location = location or (0, 0) assert isinstance(location, tuple) # check reg client is valid target_reg_client = get_registry_client(reg_client_id, 'id') @@ -731,23 +732,32 @@ def deploy_flow_version(parent_id, location, bucket_id, flow_id, reg_client_id, service='nifi' ) if not flow_versions: - raise ValueError("Could not find Flows matching Bucket ID [{0}] and" + raise ValueError("Could not find Flows matching Bucket ID [{0}] and " "Flow ID [{1}] on Registry Client [{2}]" .format(bucket_id, flow_id, reg_client_id)) if version is None: target_flow = flow_versions.versioned_flow_snapshot_metadata_set else: - target_flow = [x for x - in flow_versions.versioned_flow_snapshot_metadata_set - if x.versioned_flow_snapshot_metadata.version == version - ] + target_flow = [ + x for x in flow_versions.versioned_flow_snapshot_metadata_set + if str(x.versioned_flow_snapshot_metadata.version) == str(version) + ] if not target_flow: + available_versions = [ + str(x.versioned_flow_snapshot_metadata.version) + for x in flow_versions.versioned_flow_snapshot_metadata_set + ] raise ValueError( "Could not find Version [{0}] for Flow [{1}] in Bucket [{2}] on " - "Registry Client [{3}]" - .format(str(version), flow_id, bucket_id, reg_client_id) + "Registry Client [{3}]. Available versions are: {4}" + .format(str(version), flow_id, bucket_id, reg_client_id, + ", ".join(available_versions)) ) - target_flow = target_flow[0].versioned_flow_snapshot_metadata + target_flow = sorted( + target_flow, + key=lambda x: x.versioned_flow_snapshot_metadata.version, + reverse=True + )[0].versioned_flow_snapshot_metadata # Issue deploy statement with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ProcessGroupsApi().create_process_group( diff --git a/pylintrc b/pylintrc index e1f0c7d9..e8e0ca4c 100644 --- a/pylintrc +++ b/pylintrc @@ -1,163 +1,225 @@ -[MASTER] +[MAIN] + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Clear in-memory caches upon conclusion of linting. Useful if running pylint +# in a server-like mode. +clear-cache-post-run=no + +# Load and enable all available extensions. Use --list-extensions to see a list +# all available extensions. +#enable-all-extensions= + +# In error mode, messages with a category besides ERROR or FATAL are +# suppressed, and no reports are done by default. Error mode is compatible with +# disabling specific errors. +#errors-only= + +# Always return a 0 (non-error) status code, even if lint errors are found. +# This is primarily useful in continuous integration scripts. +#exit-zero= # A comma-separated list of package or module names from where C extensions may # be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist=lxml +# run arbitrary code. +extension-pkg-allow-list=lxml.etree -# Add files or directories to the blacklist. They should be base names, not -# paths. +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold under which the program will exit with error. +fail-under=10 + +# Interpret the stdin as a python script, whose filename needs to be passed as +# the module_or_package argument. +#from-stdin= + +# Files or directories to be skipped. They should be base names, not paths. ignore=CVS, nifi, registry, tests -# Add files or directories matching the regex patterns to the blacklist. The -# regex matches against base names, not paths. -ignore-patterns= +# Add files or directories matching the regular expressions patterns to the +# ignore-list. The regex matches against paths and can be in Posix or Windows +# format. Because '\\' represents the directory delimiter on Windows systems, +# it can't be used as an escape character. +ignore-paths= + +# Files or directories matching the regular expression patterns are skipped. +# The regex matches against base names, not paths. The default value ignores +# Emacs file locks +ignore-patterns=^\.# + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= # Python code to execute, usually for sys.path manipulation such as # pygtk.require(). #init-hook= -# Use multiple processes to speed up Pylint. +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use, and will cap the count on Windows to +# avoid hangs. jobs=1 -# List of plugins (as comma separated values of python modules names) to load, +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, # usually to register additional checkers. load-plugins= # Pickle collected data for later comparisons. persistent=yes -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call, C0103, E1101, R1710, E0401, C0209 - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.9 -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) +# Discover python modules and packages in the file system subtree. +recursive=no -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= +# Add paths to the list of the source roots. Supports globbing patterns. The +# source root is an absolute path or a path relative to the current working +# directory used to determine a package namespace for modules located under the +# source root. +source-roots= -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=parseable +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes -# Tells whether to display a full report or only the messages -reports=no +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no -# Activate the evaluation score. -score=yes +# In verbose mode, extra non-checker-related info will be displayed. +#verbose= -[REFACTORING] +[BASIC] -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 +# Naming style matching correct argument names. +argument-naming-style=snake_case +# Regular expression matching correct argument names. Overrides argument- +# naming-style. If left empty, argument names will be checked with the set +# naming style. +#argument-rgx= -[BASIC] +# Naming style matching correct attribute names. +attr-naming-style=snake_case -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. If left empty, attribute names will be checked with the set naming +# style. +#attr-rgx= -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata -# Naming hint for attribute names -attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ +# Naming style matching correct class attribute names. +class-attribute-naming-style=any -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. If left empty, class attribute names will be checked +# with the set naming style. +#class-attribute-rgx= -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. If left empty, class constant names will be checked with +# the set naming style. +#class-const-rgx= -# Naming hint for class names -class-name-hint=[A-Z_][a-zA-Z0-9]+$ +# Naming style matching correct class names. +class-naming-style=PascalCase -# Regular expression matching correct class names -class-rgx=[A-Z_][a-zA-Z0-9]+$ +# Regular expression matching correct class names. Overrides class-naming- +# style. If left empty, class names will be checked with the set naming style. +class-rgx=[A-Z][a-z]+ -# Naming hint for constant names -const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ +# Regular expression matching correct constant names. Overrides const-naming- +# style. If left empty, constant names will be checked with the set naming +# style. +#const-rgx= # Minimum line length for functions/classes that require docstrings, shorter # ones are exempt. docstring-min-length=-1 -# Naming hint for function names -function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. If left empty, function names will be checked with the set +# naming style. +#function-rgx= -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ -# Good variable names which should always be accepted, separated by a comma -good-names=i,j,k,ex,Run,_ +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= -# Include a hint for the correct naming format with invalid-name +# Include a hint for the correct naming format with invalid-name. include-naming-hint=no -# Naming hint for inline iteration names -inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. If left empty, inline iteration names will be checked +# with the set naming style. +#inlinevar-rgx= -# Naming hint for method names -method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ +# Naming style matching correct method names. +method-naming-style=snake_case -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ +# Regular expression matching correct method names. Overrides method-naming- +# style. If left empty, method names will be checked with the set naming style. +#method-rgx= -# Naming hint for module names -module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ +# Naming style matching correct module names. +module-naming-style=snake_case -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ +# Regular expression matching correct module names. Overrides module-naming- +# style. If left empty, module names will be checked with the set naming style. +#module-rgx= # Colon-delimited sets of names that determine each other's naming style when # the name regexes allow several styles. @@ -169,13 +231,94 @@ no-docstring-rgx=^_ # List of decorators that produce properties, such as abc.abstractproperty. Add # to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. property-classes=abc.abstractproperty -# Naming hint for variable names -variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ +# Regular expression matching correct type alias names. If left empty, type +# alias names will be checked with the set naming style. +#typealias-rgx= + +# Regular expression matching correct type variable names. If left empty, type +# variable names will be checked with the set naming style. +#typevar-rgx= + +# Naming style matching correct variable names. +variable-naming-style=snake_case -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ +# Regular expression matching correct variable names. Overrides variable- +# naming-style. If left empty, variable names will be checked with the set +# naming style. +#variable-rgx= + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + asyncSetUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= + +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when caught. +overgeneral-exceptions=builtins.BaseException,builtins.Exception [FORMAT] @@ -186,7 +329,7 @@ expected-line-ending-format= # Regexp for a line that is allowed to be longer than the limit. ignore-long-lines=^\s*(# )??$ -# Number of spaces of indent required inside a hanging or continued line. +# Number of spaces of indent required inside a hanging or continued line. indent-after-paren=4 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 @@ -196,15 +339,9 @@ indent-string=' ' # Maximum number of characters on a single line. max-line-length=100 -# Maximum number of lines in a module +# Maximum number of lines in a module. max-module-lines=1000 -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma,dict-separator - # Allow the body of a class to be on the same line as the declaration if body # contains single statement. single-line-class-stmt=no @@ -214,29 +351,171 @@ single-line-class-stmt=no single-line-if-stmt=no +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow explicit reexports by alias from a package __init__. +allow-reexport-from-package=no + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + [LOGGING] +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + # Logging modules to check that the string format arguments are in logging -# function parameter format +# function parameter format. logging-modules=logging +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, +# UNDEFINED. +confidence=HIGH, + CONTROL_FLOW, + INFERENCE, + INFERENCE_FAILURE, + UNDEFINED + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then re-enable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + use-implicit-booleaness-not-comparison-to-string, + use-implicit-booleaness-not-comparison-to-zero, + bare-except, + invalid-name, + C0103, E1101, R1710, E0401, C0209 + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable= + + +[METHOD_ARGS] + +# List of qualified names (i.e., library.method) which require a timeout +# parameter e.g. 'requests.api.get,requests.api.post' +timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request + + [MISCELLANEOUS] # List of note tags to take in consideration, separated by a comma. -notes=FIXME,XXX,TODO +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +notes-rgx= + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + +# Let 'consider-using-join' be raised when the separator to join on would be +# non-empty (resulting in expected fixes of the type: ``"- " + " - +# ".join(items)``) +suggest-join-with-non-empty-separator=yes + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'fatal', 'error', 'warning', 'refactor', +# 'convention', and 'info' which contain the number of messages in each +# category, as well as 'statement' which is the total number of statements +# analyzed. This score is used by the global evaluation report (RP0004). +evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +msg-template= + +# Set the output format. Available formats are: text, parseable, colorized, +# json2 (improved json format), json (old json format) and msvs (visual +# studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +#output-format= + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes [SIMILARITIES] -# Ignore comments when computing similarities. +# Comments are removed from the similarity computation ignore-comments=yes -# Ignore docstrings when computing similarities. +# Docstrings are removed from the similarity computation ignore-docstrings=yes -# Ignore imports when computing similarities. -ignore-imports=no +# Imports are removed from the similarity computation +ignore-imports=yes + +# Signatures are removed from the similarity computation +ignore-signatures=yes # Minimum lines number of a similarity. min-similarity-lines=4 @@ -244,21 +523,39 @@ min-similarity-lines=4 [SPELLING] -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. No available dictionaries : You need to install +# both the python package and the system dependency for enchant to work. spelling-dict= +# List of comma separated words that should be considered directives if they +# appear at the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + # List of comma separated words that should not be checked. spelling-ignore-words= -# A path to a file that contains private dictionary; one word per line. +# A path to a file that contains the private dictionary; one word per line. spelling-private-dict-file= -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. spelling-store-unknown-words=no +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + [TYPECHECK] # List of decorators that produce context managers, such as @@ -271,9 +568,9 @@ contextmanager-decorators=contextlib.contextmanager # expressions are accepted. generated-members= -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes # This flag controls whether pylint should warn about no-member and similar # checks whenever an opaque object is returned when inferring. The inference @@ -283,16 +580,16 @@ ignore-mixin-members=yes # the rest of the inferred objects. ignore-on-opaque-inference=yes +# List of symbolic message names to ignore for Mixin members. +ignored-checks-for-mixins=no-member, + not-async-context-manager, + not-context-manager, + attribute-defined-outside-init + # List of class names for which member attributes should not be checked (useful # for classes with dynamically set attributes). This supports the use of # qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules= +ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace # Show a hint with possible names when a member name was not found. The aspect # of finding the hint is based on edit distance. @@ -306,26 +603,35 @@ missing-member-hint-distance=1 # showing a hint for a missing member. missing-member-max-choices=1 +# Regex pattern to define which classes are considered mixins. +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + [VARIABLES] # List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. +# you should avoid defining new builtins when possible. additional-builtins= # Tells whether unused global variables should be treated as a violation. allow-global-unused-variables=yes +# List of names allowed to shadow builtins +allowed-redefined-builtins= + # List of strings which can identify a callback function by name. A callback # name must start or end with one of those strings. -callbacks=cb_,_cb +callbacks=cb_, + _cb -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ -# Argument names that match this expression will be ignored. Default to name -# with leading underscore +# Argument names that match this expression will be ignored. ignored-argument-names=_.*|^ignored_|^unused_ # Tells whether we should check for unused import in __init__ files. @@ -333,97 +639,4 @@ init-import=no # List of qualified module names which can have objects that can redefine # builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=8 - -# Maximum number of attributes for a class (see R0902). -max-attributes=8 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=2 - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=Exception - - -# Bugfixes -optimize-ast=y +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io diff --git a/requirements_dev.txt b/requirements_dev.txt index f7808d86..f58328fc 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -14,7 +14,7 @@ tox>=2.9.1 flake8>=3.6.0 coverage>=4.4.1 coveralls>=1.2.0 -pytest>=3.2.3 +pytest>=7.2.0 nose>=1.3.7 pluggy>=0.3.1 pylint>=1.7.4 @@ -26,6 +26,6 @@ sphinx_rtd_theme>=0.2.5b1 # Code Deps cryptography>=2.1.2 -py>=1.4.31 +py>=1.11.0 randomize>=0.13 certifi>=2017.7.27.1 diff --git a/resources/client_gen/swagger_templates/configuration.mustache b/resources/client_gen/swagger_templates/configuration.mustache index 032af170..c6d1e434 100644 --- a/resources/client_gen/swagger_templates/configuration.mustache +++ b/resources/client_gen/swagger_templates/configuration.mustache @@ -80,6 +80,8 @@ class Configuration(object): self.cert_file = None # client key file self.key_file = None + # client key password + self.key_password = None # Alternative TLS configuration: set this to an instance of ssl.SSLContext or urllib3.util.ssl_.SSLContext self.ssl_context = None diff --git a/resources/client_gen/swagger_templates/rest.mustache b/resources/client_gen/swagger_templates/rest.mustache index ff492148..d41b0acf 100644 --- a/resources/client_gen/swagger_templates/rest.mustache +++ b/resources/client_gen/swagger_templates/rest.mustache @@ -57,30 +57,29 @@ class RESTClientObject(object): # ca_certs vs cert_file vs key_file # http://stackoverflow.com/a/23957365/2985775 + config = Configuration() + # cert_reqs - if Configuration().verify_ssl: - cert_reqs = ssl.CERT_REQUIRED - else: - cert_reqs = ssl.CERT_NONE + cert_reqs = ssl.CERT_REQUIRED if config.verify_ssl else ssl.CERT_NONE # ca_certs - if Configuration().ssl_ca_cert: - ca_certs = Configuration().ssl_ca_cert - else: - # if not set certificate file, use Mozilla's root certificates. - ca_certs = certifi.where() + ca_certs = (config.ssl_ca_cert if config.ssl_ca_cert + else certifi.where()) # cert_file - cert_file = Configuration().cert_file + cert_file = config.cert_file # key file - key_file = Configuration().key_file + key_file = config.key_file + + # key password + key_password = config.key_password # ssl_context - ssl_context = Configuration().ssl_context + ssl_context = config.ssl_context # proxy - proxy = Configuration().proxy + proxy = config.proxy # https pool manager if proxy and "socks" not in str(proxy): @@ -91,6 +90,7 @@ class RESTClientObject(object): ca_certs=ca_certs, cert_file=cert_file, key_file=key_file, + key_password=key_password, ssl_context=ssl_context, proxy_url=proxy ) @@ -102,6 +102,7 @@ class RESTClientObject(object): ca_certs=ca_certs, cert_file=cert_file, key_file=key_file, + key_password=key_password, ssl_context=ssl_context, proxy_url=proxy ) @@ -113,6 +114,7 @@ class RESTClientObject(object): ca_certs=ca_certs, cert_file=cert_file, key_file=key_file, + key_password=key_password, ssl_context=ssl_context ) @@ -297,7 +299,8 @@ class ApiException(Exception): self.status = http_resp.status self.reason = http_resp.reason self.body = http_resp.data - self.headers = http_resp.getheaders() + self.headers = (http_resp.headers if hasattr(http_resp, 'headers') + else http_resp.getheaders()) else: self.status = status self.reason = reason From 6a94c6b9c0a7edb09502dbb776a2a5e5fa8b4ddf Mon Sep 17 00:00:00 2001 From: Dan Chaffelson Date: Sun, 6 Oct 2024 13:22:39 +0100 Subject: [PATCH 05/11] update clients to 1.27.0 (#365) * update clients to 1.27.0 * deprecate py.test in favour of newer pytest * move docker requirement to extras * linting fixes * set latest python version to 3.12 --- README.rst | 5 +- nipyapi/demo/fdlc.py | 17 +- nipyapi/demo/secure_connection.py | 17 +- nipyapi/nifi/__init__.py | 4 +- nipyapi/nifi/api_client.py | 2 +- nipyapi/nifi/apis/access_api.py | 2 +- nipyapi/nifi/apis/connections_api.py | 2 +- nipyapi/nifi/apis/controller_api.py | 2 +- nipyapi/nifi/apis/controller_services_api.py | 2 +- nipyapi/nifi/apis/counters_api.py | 2 +- nipyapi/nifi/apis/data_transfer_api.py | 2 +- nipyapi/nifi/apis/flow_api.py | 350 +- nipyapi/nifi/apis/flowfile_queues_api.py | 2 +- nipyapi/nifi/apis/funnel_api.py | 2 +- nipyapi/nifi/apis/input_ports_api.py | 2 +- nipyapi/nifi/apis/labels_api.py | 2 +- nipyapi/nifi/apis/output_ports_api.py | 2 +- nipyapi/nifi/apis/parameter_contexts_api.py | 2 +- nipyapi/nifi/apis/parameter_providers_api.py | 2 +- nipyapi/nifi/apis/policies_api.py | 2 +- nipyapi/nifi/apis/process_groups_api.py | 89 +- nipyapi/nifi/apis/processors_api.py | 2 +- nipyapi/nifi/apis/provenance_api.py | 2 +- nipyapi/nifi/apis/provenance_events_api.py | 2 +- .../nifi/apis/remote_process_groups_api.py | 2 +- nipyapi/nifi/apis/reporting_tasks_api.py | 2 +- nipyapi/nifi/apis/resources_api.py | 2 +- nipyapi/nifi/apis/site_to_site_api.py | 2 +- nipyapi/nifi/apis/snippets_api.py | 2 +- nipyapi/nifi/apis/system_diagnostics_api.py | 2 +- nipyapi/nifi/apis/templates_api.py | 2 +- nipyapi/nifi/apis/tenants_api.py | 2 +- nipyapi/nifi/apis/versions_api.py | 2 +- nipyapi/nifi/configuration.py | 6 +- nipyapi/nifi/models/__init__.py | 4 +- nipyapi/nifi/models/about_dto.py | 2 +- nipyapi/nifi/models/about_entity.py | 2 +- .../nifi/models/access_configuration_dto.py | 2 +- .../models/access_configuration_entity.py | 2 +- nipyapi/nifi/models/access_policy_dto.py | 2 +- nipyapi/nifi/models/access_policy_entity.py | 2 +- .../nifi/models/access_policy_summary_dto.py | 2 +- .../models/access_policy_summary_entity.py | 2 +- nipyapi/nifi/models/access_status_dto.py | 2 +- nipyapi/nifi/models/access_status_entity.py | 2 +- .../models/access_token_expiration_dto.py | 2 +- .../models/access_token_expiration_entity.py | 2 +- nipyapi/nifi/models/action_details_dto.py | 2 +- nipyapi/nifi/models/action_dto.py | 2 +- nipyapi/nifi/models/action_entity.py | 2 +- .../activate_controller_services_entity.py | 2 +- nipyapi/nifi/models/affected_component_dto.py | 2 +- .../nifi/models/affected_component_entity.py | 2 +- nipyapi/nifi/models/allowable_value_dto.py | 2 +- nipyapi/nifi/models/allowable_value_entity.py | 2 +- nipyapi/nifi/models/attribute.py | 2 +- nipyapi/nifi/models/attribute_dto.py | 2 +- nipyapi/nifi/models/banner_dto.py | 2 +- nipyapi/nifi/models/banner_entity.py | 2 +- nipyapi/nifi/models/batch_settings_dto.py | 2 +- nipyapi/nifi/models/batch_size.py | 2 +- nipyapi/nifi/models/build_info.py | 2 +- nipyapi/nifi/models/bulletin_board_dto.py | 2 +- nipyapi/nifi/models/bulletin_board_entity.py | 2 +- nipyapi/nifi/models/bulletin_dto.py | 2 +- nipyapi/nifi/models/bulletin_entity.py | 2 +- nipyapi/nifi/models/bundle.py | 2 +- nipyapi/nifi/models/bundle_dto.py | 2 +- .../models/class_loader_diagnostics_dto.py | 2 +- nipyapi/nifi/models/cluste_summary_entity.py | 2 +- nipyapi/nifi/models/cluster_dto.py | 2 +- nipyapi/nifi/models/cluster_entity.py | 2 +- .../models/cluster_search_results_entity.py | 2 +- nipyapi/nifi/models/cluster_summary_dto.py | 2 +- nipyapi/nifi/models/component_details_dto.py | 2 +- .../nifi/models/component_difference_dto.py | 2 +- nipyapi/nifi/models/component_history_dto.py | 2 +- .../nifi/models/component_history_entity.py | 2 +- nipyapi/nifi/models/component_lifecycle.py | 2 +- nipyapi/nifi/models/component_manifest.py | 2 +- .../nifi/models/component_reference_dto.py | 2 +- .../nifi/models/component_reference_entity.py | 2 +- .../component_restriction_permission_dto.py | 2 +- .../models/component_search_result_dto.py | 2 +- nipyapi/nifi/models/component_state_dto.py | 2 +- nipyapi/nifi/models/component_state_entity.py | 2 +- .../models/component_validation_result_dto.py | 2 +- .../component_validation_result_entity.py | 2 +- .../component_validation_results_entity.py | 2 +- .../models/config_verification_result_dto.py | 2 +- .../nifi/models/configuration_analysis_dto.py | 2 +- .../models/configuration_analysis_entity.py | 2 +- nipyapi/nifi/models/connectable_component.py | 2 +- nipyapi/nifi/models/connectable_dto.py | 2 +- .../nifi/models/connection_diagnostics_dto.py | 2 +- .../connection_diagnostics_snapshot_dto.py | 2 +- nipyapi/nifi/models/connection_dto.py | 2 +- nipyapi/nifi/models/connection_entity.py | 2 +- .../nifi/models/connection_statistics_dto.py | 2 +- .../models/connection_statistics_entity.py | 2 +- .../connection_statistics_snapshot_dto.py | 2 +- nipyapi/nifi/models/connection_status_dto.py | 2 +- .../nifi/models/connection_status_entity.py | 2 +- ...nection_status_predictions_snapshot_dto.py | 2 +- .../models/connection_status_snapshot_dto.py | 2 +- .../connection_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/connections_entity.py | 2 +- .../models/controller_bulletins_entity.py | 2 +- .../models/controller_configuration_dto.py | 2 +- .../models/controller_configuration_entity.py | 2 +- nipyapi/nifi/models/controller_dto.py | 2 +- nipyapi/nifi/models/controller_entity.py | 2 +- nipyapi/nifi/models/controller_service_api.py | 2 +- .../nifi/models/controller_service_api_dto.py | 2 +- .../models/controller_service_definition.py | 2 +- .../controller_service_diagnostics_dto.py | 2 +- nipyapi/nifi/models/controller_service_dto.py | 2 +- .../nifi/models/controller_service_entity.py | 2 +- ...oller_service_referencing_component_dto.py | 2 +- ...er_service_referencing_component_entity.py | 2 +- ...r_service_referencing_components_entity.py | 2 +- .../controller_service_run_status_entity.py | 2 +- .../models/controller_service_status_dto.py | 2 +- .../models/controller_service_types_entity.py | 2 +- .../nifi/models/controller_services_entity.py | 2 +- nipyapi/nifi/models/controller_status_dto.py | 2 +- .../nifi/models/controller_status_entity.py | 2 +- .../models/copy_snippet_request_entity.py | 2 +- nipyapi/nifi/models/counter_dto.py | 2 +- nipyapi/nifi/models/counter_entity.py | 2 +- nipyapi/nifi/models/counters_dto.py | 2 +- nipyapi/nifi/models/counters_entity.py | 2 +- nipyapi/nifi/models/counters_snapshot_dto.py | 2 +- .../models/create_active_request_entity.py | 2 +- .../models/create_template_request_entity.py | 2 +- nipyapi/nifi/models/current_user_entity.py | 2 +- nipyapi/nifi/models/defined_type.py | 2 +- nipyapi/nifi/models/difference_dto.py | 2 +- nipyapi/nifi/models/dimensions_dto.py | 2 +- nipyapi/nifi/models/documented_type_dto.py | 2 +- nipyapi/nifi/models/drop_request_dto.py | 2 +- nipyapi/nifi/models/drop_request_entity.py | 2 +- nipyapi/nifi/models/dto_factory.py | 2 +- nipyapi/nifi/models/dynamic_property.py | 2 +- nipyapi/nifi/models/dynamic_relationship.py | 2 +- nipyapi/nifi/models/entity.py | 2 +- .../nifi/models/explicit_restriction_dto.py | 2 +- .../external_controller_service_reference.py | 2 +- nipyapi/nifi/models/flow_breadcrumb_dto.py | 2 +- nipyapi/nifi/models/flow_breadcrumb_entity.py | 2 +- nipyapi/nifi/models/flow_comparison_entity.py | 2 +- nipyapi/nifi/models/flow_configuration_dto.py | 2 +- .../nifi/models/flow_configuration_entity.py | 2 +- nipyapi/nifi/models/flow_dto.py | 2 +- nipyapi/nifi/models/flow_entity.py | 2 +- nipyapi/nifi/models/flow_file_dto.py | 2 +- nipyapi/nifi/models/flow_file_entity.py | 2 +- nipyapi/nifi/models/flow_file_summary_dto.py | 2 +- nipyapi/nifi/models/flow_registry_bucket.py | 2 +- .../nifi/models/flow_registry_bucket_dto.py | 2 +- .../models/flow_registry_bucket_entity.py | 2 +- .../models/flow_registry_buckets_entity.py | 2 +- .../nifi/models/flow_registry_client_dto.py | 62 +- .../models/flow_registry_client_entity.py | 2 +- .../flow_registry_client_types_entity.py | 2 +- .../models/flow_registry_clients_entity.py | 2 +- .../nifi/models/flow_registry_permissions.py | 2 +- nipyapi/nifi/models/flow_snippet_dto.py | 2 +- nipyapi/nifi/models/funnel_dto.py | 2 +- nipyapi/nifi/models/funnel_entity.py | 2 +- nipyapi/nifi/models/funnels_entity.py | 2 +- .../garbage_collection_diagnostics_dto.py | 2 +- nipyapi/nifi/models/garbage_collection_dto.py | 2 +- .../models/gc_diagnostics_snapshot_dto.py | 2 +- nipyapi/nifi/models/history_dto.py | 2 +- nipyapi/nifi/models/history_entity.py | 2 +- nipyapi/nifi/models/input_ports_entity.py | 2 +- nipyapi/nifi/models/input_stream.py | 2 +- .../instantiate_template_request_entity.py | 2 +- nipyapi/nifi/models/jmx_metrics_result_dto.py | 2 +- .../nifi/models/jmx_metrics_results_entity.py | 2 +- ...jvm_controller_diagnostics_snapshot_dto.py | 2 +- nipyapi/nifi/models/jvm_diagnostics_dto.py | 2 +- .../models/jvm_diagnostics_snapshot_dto.py | 2 +- .../jvm_flow_diagnostics_snapshot_dto.py | 2 +- .../jvm_system_diagnostics_snapshot_dto.py | 2 +- nipyapi/nifi/models/label_dto.py | 2 +- nipyapi/nifi/models/label_entity.py | 2 +- nipyapi/nifi/models/labels_entity.py | 2 +- nipyapi/nifi/models/lineage_dto.py | 2 +- nipyapi/nifi/models/lineage_entity.py | 2 +- nipyapi/nifi/models/lineage_request_dto.py | 2 +- nipyapi/nifi/models/lineage_results_dto.py | 2 +- nipyapi/nifi/models/listing_request_dto.py | 62 +- nipyapi/nifi/models/listing_request_entity.py | 2 +- .../nifi/models/local_queue_partition_dto.py | 2 +- ...node_connection_statistics_snapshot_dto.py | 2 +- .../node_connection_status_snapshot_dto.py | 2 +- .../nifi/models/node_counters_snapshot_dto.py | 2 +- nipyapi/nifi/models/node_dto.py | 2 +- nipyapi/nifi/models/node_entity.py | 2 +- nipyapi/nifi/models/node_event_dto.py | 2 +- nipyapi/nifi/models/node_identifier.py | 2 +- .../node_jvm_diagnostics_snapshot_dto.py | 2 +- .../models/node_port_status_snapshot_dto.py | 2 +- .../node_process_group_status_snapshot_dto.py | 2 +- .../node_processor_status_snapshot_dto.py | 2 +- ...emote_process_group_status_snapshot_dto.py | 2 +- .../node_replay_last_event_snapshot_dto.py | 2 +- nipyapi/nifi/models/node_response.py | 60 +- nipyapi/nifi/models/node_search_result_dto.py | 2 +- .../nifi/models/node_status_snapshots_dto.py | 2 +- .../node_system_diagnostics_snapshot_dto.py | 2 +- nipyapi/nifi/models/output_ports_entity.py | 2 +- nipyapi/nifi/models/parameter_context_dto.py | 2 +- .../nifi/models/parameter_context_entity.py | 2 +- .../models/parameter_context_reference_dto.py | 2 +- .../parameter_context_reference_entity.py | 2 +- .../models/parameter_context_update_entity.py | 2 +- .../parameter_context_update_request_dto.py | 2 +- ...parameter_context_update_request_entity.py | 2 +- .../parameter_context_update_step_dto.py | 2 +- ...arameter_context_validation_request_dto.py | 2 +- ...meter_context_validation_request_entity.py | 2 +- .../parameter_context_validation_step_dto.py | 2 +- .../nifi/models/parameter_contexts_entity.py | 2 +- nipyapi/nifi/models/parameter_dto.py | 2 +- nipyapi/nifi/models/parameter_entity.py | 2 +- .../parameter_group_configuration_entity.py | 2 +- ...r_provider_apply_parameters_request_dto.py | 2 +- ...rovider_apply_parameters_request_entity.py | 2 +- ...ovider_apply_parameters_update_step_dto.py | 2 +- .../parameter_provider_configuration_dto.py | 2 +- ...parameter_provider_configuration_entity.py | 2 +- nipyapi/nifi/models/parameter_provider_dto.py | 2 +- .../nifi/models/parameter_provider_entity.py | 2 +- ...r_provider_parameter_application_entity.py | 2 +- ...rameter_provider_parameter_fetch_entity.py | 2 +- .../models/parameter_provider_reference.py | 2 +- ...eter_provider_referencing_component_dto.py | 2 +- ...r_provider_referencing_component_entity.py | 2 +- ..._provider_referencing_components_entity.py | 2 +- .../models/parameter_provider_types_entity.py | 2 +- .../nifi/models/parameter_providers_entity.py | 2 +- nipyapi/nifi/models/parameter_status_dto.py | 2 +- nipyapi/nifi/models/peer_dto.py | 2 +- nipyapi/nifi/models/peers_entity.py | 2 +- nipyapi/nifi/models/permissions_dto.py | 2 +- nipyapi/nifi/models/port_dto.py | 2 +- nipyapi/nifi/models/port_entity.py | 2 +- nipyapi/nifi/models/port_run_status_entity.py | 2 +- nipyapi/nifi/models/port_status_dto.py | 2 +- nipyapi/nifi/models/port_status_entity.py | 2 +- .../nifi/models/port_status_snapshot_dto.py | 2 +- .../models/port_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/position.py | 2 +- nipyapi/nifi/models/position_dto.py | 2 +- nipyapi/nifi/models/previous_value_dto.py | 2 +- .../nifi/models/prioritizer_types_entity.py | 2 +- nipyapi/nifi/models/process_group_dto.py | 2 +- nipyapi/nifi/models/process_group_entity.py | 38 +- nipyapi/nifi/models/process_group_flow_dto.py | 2 +- .../nifi/models/process_group_flow_entity.py | 2 +- .../models/process_group_import_entity.py | 2 +- nipyapi/nifi/models/process_group_name_dto.py | 2 +- .../process_group_replace_request_dto.py | 2 +- .../process_group_replace_request_entity.py | 2 +- .../nifi/models/process_group_status_dto.py | 2 +- .../models/process_group_status_entity.py | 2 +- .../process_group_status_snapshot_dto.py | 2 +- .../process_group_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/process_groups_entity.py | 2 +- nipyapi/nifi/models/processor_config_dto.py | 2 +- nipyapi/nifi/models/processor_definition.py | 2 +- .../nifi/models/processor_diagnostics_dto.py | 2 +- .../models/processor_diagnostics_entity.py | 2 +- nipyapi/nifi/models/processor_dto.py | 2 +- nipyapi/nifi/models/processor_entity.py | 2 +- .../processor_run_status_details_dto.py | 2 +- .../processor_run_status_details_entity.py | 2 +- .../models/processor_run_status_entity.py | 2 +- nipyapi/nifi/models/processor_status_dto.py | 2 +- .../nifi/models/processor_status_entity.py | 2 +- .../models/processor_status_snapshot_dto.py | 2 +- .../processor_status_snapshot_entity.py | 2 +- nipyapi/nifi/models/processor_types_entity.py | 2 +- nipyapi/nifi/models/processors_entity.py | 2 +- .../processors_run_status_details_entity.py | 2 +- .../nifi/models/property_allowable_value.py | 2 +- nipyapi/nifi/models/property_dependency.py | 2 +- .../nifi/models/property_dependency_dto.py | 2 +- nipyapi/nifi/models/property_descriptor.py | 2 +- .../nifi/models/property_descriptor_dto.py | 2 +- .../nifi/models/property_descriptor_entity.py | 2 +- nipyapi/nifi/models/property_history_dto.py | 2 +- .../models/property_resource_definition.py | 2 +- nipyapi/nifi/models/provenance_dto.py | 2 +- nipyapi/nifi/models/provenance_entity.py | 2 +- nipyapi/nifi/models/provenance_event_dto.py | 2 +- .../nifi/models/provenance_event_entity.py | 2 +- nipyapi/nifi/models/provenance_link_dto.py | 2 +- nipyapi/nifi/models/provenance_node_dto.py | 2 +- nipyapi/nifi/models/provenance_options_dto.py | 2 +- .../nifi/models/provenance_options_entity.py | 2 +- nipyapi/nifi/models/provenance_request_dto.py | 2 +- nipyapi/nifi/models/provenance_results_dto.py | 2 +- .../models/provenance_search_value_dto.py | 2 +- .../models/provenance_searchable_field_dto.py | 2 +- nipyapi/nifi/models/queue_size_dto.py | 2 +- nipyapi/nifi/models/registered_flow.py | 2 +- .../nifi/models/registered_flow_snapshot.py | 2 +- .../registered_flow_snapshot_metadata.py | 2 +- .../models/registered_flow_version_info.py | 2 +- nipyapi/nifi/models/relationship.py | 2 +- nipyapi/nifi/models/relationship_dto.py | 2 +- .../models/remote_port_run_status_entity.py | 2 +- .../remote_process_group_contents_dto.py | 2 +- .../nifi/models/remote_process_group_dto.py | 2 +- .../models/remote_process_group_entity.py | 2 +- .../models/remote_process_group_port_dto.py | 2 +- .../remote_process_group_port_entity.py | 2 +- .../models/remote_process_group_status_dto.py | 2 +- .../remote_process_group_status_entity.py | 2 +- ...emote_process_group_status_snapshot_dto.py | 2 +- ...te_process_group_status_snapshot_entity.py | 2 +- .../models/remote_process_groups_entity.py | 2 +- .../nifi/models/remote_queue_partition_dto.py | 2 +- .../replay_last_event_request_entity.py | 2 +- .../replay_last_event_response_entity.py | 2 +- .../models/replay_last_event_snapshot_dto.py | 2 +- .../nifi/models/reporting_task_definition.py | 2 +- nipyapi/nifi/models/reporting_task_dto.py | 2 +- nipyapi/nifi/models/reporting_task_entity.py | 2 +- .../reporting_task_run_status_entity.py | 2 +- .../nifi/models/reporting_task_status_dto.py | 2 +- .../models/reporting_task_types_entity.py | 2 +- nipyapi/nifi/models/reporting_tasks_entity.py | 2 +- nipyapi/nifi/models/repository_usage_dto.py | 2 +- .../nifi/models/required_permission_dto.py | 2 +- nipyapi/nifi/models/resource_dto.py | 2 +- nipyapi/nifi/models/resources_entity.py | 2 +- nipyapi/nifi/models/response.py | 56 +- nipyapi/nifi/models/restriction.py | 2 +- nipyapi/nifi/models/revision_dto.py | 2 +- .../run_status_details_request_entity.py | 2 +- nipyapi/nifi/models/runtime_manifest.py | 2 +- .../nifi/models/runtime_manifest_entity.py | 2 +- .../nifi/models/schedule_components_entity.py | 2 +- nipyapi/nifi/models/scheduling_defaults.py | 2 +- .../nifi/models/search_result_group_dto.py | 2 +- nipyapi/nifi/models/search_results_dto.py | 2 +- nipyapi/nifi/models/search_results_entity.py | 2 +- nipyapi/nifi/models/snippet_dto.py | 2 +- nipyapi/nifi/models/snippet_entity.py | 2 +- nipyapi/nifi/models/stack_trace_element.py | 60 +- .../start_version_control_request_entity.py | 2 +- nipyapi/nifi/models/state_entry_dto.py | 2 +- nipyapi/nifi/models/state_map_dto.py | 2 +- nipyapi/nifi/models/stateful.py | 2 +- nipyapi/nifi/models/status_descriptor_dto.py | 2 +- nipyapi/nifi/models/status_history_dto.py | 2 +- nipyapi/nifi/models/status_history_entity.py | 2 +- nipyapi/nifi/models/status_snapshot_dto.py | 2 +- nipyapi/nifi/models/storage_usage_dto.py | 2 +- nipyapi/nifi/models/streaming_output.py | 2 +- .../models/submit_replay_request_entity.py | 2 +- nipyapi/nifi/models/system_diagnostics_dto.py | 2 +- .../nifi/models/system_diagnostics_entity.py | 2 +- .../models/system_diagnostics_snapshot_dto.py | 2 +- .../models/system_resource_consideration.py | 2 +- nipyapi/nifi/models/template_dto.py | 2 +- nipyapi/nifi/models/template_entity.py | 2 +- nipyapi/nifi/models/templates_entity.py | 2 +- nipyapi/nifi/models/tenant_dto.py | 2 +- nipyapi/nifi/models/tenant_entity.py | 2 +- nipyapi/nifi/models/tenants_entity.py | 2 +- nipyapi/nifi/models/thread_dump_dto.py | 2 +- nipyapi/nifi/models/throwable.py | 2 +- .../nifi/models/transaction_result_entity.py | 2 +- ...roller_service_reference_request_entity.py | 2 +- nipyapi/nifi/models/user_dto.py | 2 +- nipyapi/nifi/models/user_entity.py | 2 +- nipyapi/nifi/models/user_group_dto.py | 2 +- nipyapi/nifi/models/user_group_entity.py | 2 +- nipyapi/nifi/models/user_groups_entity.py | 2 +- nipyapi/nifi/models/users_entity.py | 2 +- nipyapi/nifi/models/variable_dto.py | 2 +- nipyapi/nifi/models/variable_entity.py | 2 +- nipyapi/nifi/models/variable_registry_dto.py | 2 +- .../nifi/models/variable_registry_entity.py | 2 +- .../variable_registry_update_request_dto.py | 2 +- ...variable_registry_update_request_entity.py | 2 +- .../variable_registry_update_step_dto.py | 2 +- .../nifi/models/verify_config_request_dto.py | 2 +- .../models/verify_config_request_entity.py | 2 +- .../models/verify_config_update_step_dto.py | 2 +- ...ersion_control_component_mapping_entity.py | 2 +- .../models/version_control_information_dto.py | 2 +- .../version_control_information_entity.py | 2 +- nipyapi/nifi/models/version_info_dto.py | 2 +- nipyapi/nifi/models/versioned_connection.py | 2 +- .../models/versioned_controller_service.py | 2 +- .../nifi/models/versioned_flow_coordinates.py | 2 +- nipyapi/nifi/models/versioned_flow_dto.py | 2 +- nipyapi/nifi/models/versioned_flow_entity.py | 2 +- .../models/versioned_flow_snapshot_entity.py | 2 +- ...versioned_flow_snapshot_metadata_entity.py | 2 +- ...ioned_flow_snapshot_metadata_set_entity.py | 2 +- .../versioned_flow_update_request_dto.py | 2 +- .../versioned_flow_update_request_entity.py | 2 +- nipyapi/nifi/models/versioned_flows_entity.py | 2 +- nipyapi/nifi/models/versioned_funnel.py | 2 +- nipyapi/nifi/models/versioned_label.py | 2 +- nipyapi/nifi/models/versioned_parameter.py | 2 +- .../models/versioned_parameter_context.py | 2 +- nipyapi/nifi/models/versioned_port.py | 2 +- .../nifi/models/versioned_process_group.py | 58 +- nipyapi/nifi/models/versioned_processor.py | 2 +- .../models/versioned_property_descriptor.py | 2 +- .../models/versioned_remote_group_port.py | 2 +- .../models/versioned_remote_process_group.py | 2 +- .../nifi/models/versioned_reporting_task.py | 527 + .../versioned_reporting_task_snapshot.py | 153 + .../models/versioned_resource_definition.py | 2 +- nipyapi/nifi/rest.py | 2 +- nipyapi/registry/__init__.py | 2 +- nipyapi/registry/api_client.py | 6 +- nipyapi/registry/apis/about_api.py | 2 +- nipyapi/registry/apis/access_api.py | 2 +- nipyapi/registry/apis/bucket_bundles_api.py | 27 +- nipyapi/registry/apis/bucket_flows_api.py | 2 +- nipyapi/registry/apis/buckets_api.py | 2 +- nipyapi/registry/apis/bundles_api.py | 2 +- nipyapi/registry/apis/config_api.py | 2 +- .../registry/apis/extension_repository_api.py | 2 +- nipyapi/registry/apis/extensions_api.py | 2 +- nipyapi/registry/apis/flows_api.py | 2 +- nipyapi/registry/apis/items_api.py | 2 +- nipyapi/registry/apis/policies_api.py | 2 +- nipyapi/registry/apis/tenants_api.py | 2 +- nipyapi/registry/configuration.py | 6 +- nipyapi/registry/models/__init__.py | 2 +- nipyapi/registry/models/access_policy.py | 2 +- .../registry/models/access_policy_summary.py | 2 +- nipyapi/registry/models/allowable_value.py | 2 +- nipyapi/registry/models/attribute.py | 2 +- nipyapi/registry/models/batch_size.py | 2 +- nipyapi/registry/models/bucket.py | 2 +- nipyapi/registry/models/bucket_item.py | 2 +- nipyapi/registry/models/build_info.py | 2 +- nipyapi/registry/models/bundle.py | 2 +- nipyapi/registry/models/bundle_info.py | 2 +- nipyapi/registry/models/bundle_version.py | 2 +- .../models/bundle_version_dependency.py | 2 +- .../models/bundle_version_metadata.py | 2 +- .../registry/models/component_difference.py | 2 +- .../models/component_difference_group.py | 2 +- .../registry/models/connectable_component.py | 2 +- .../registry/models/controller_service_api.py | 2 +- .../models/controller_service_definition.py | 2 +- nipyapi/registry/models/current_user.py | 2 +- nipyapi/registry/models/default_schedule.py | 2 +- nipyapi/registry/models/default_settings.py | 2 +- nipyapi/registry/models/dependency.py | 2 +- nipyapi/registry/models/dependent_values.py | 2 +- nipyapi/registry/models/deprecation_notice.py | 2 +- nipyapi/registry/models/dynamic_property.py | 2 +- .../registry/models/dynamic_relationship.py | 2 +- nipyapi/registry/models/extension.py | 2 +- nipyapi/registry/models/extension_bundle.py | 2 +- .../models/extension_filter_params.py | 2 +- nipyapi/registry/models/extension_metadata.py | 2 +- .../models/extension_metadata_container.py | 2 +- .../models/extension_repo_artifact.py | 2 +- .../registry/models/extension_repo_bucket.py | 2 +- .../registry/models/extension_repo_group.py | 2 +- .../registry/models/extension_repo_version.py | 2 +- .../models/extension_repo_version_summary.py | 2 +- .../external_controller_service_reference.py | 2 +- nipyapi/registry/models/fields.py | 2 +- nipyapi/registry/models/jaxb_link.py | 2 +- nipyapi/registry/models/model_property.py | 2 +- .../models/parameter_provider_reference.py | 2 +- nipyapi/registry/models/permissions.py | 2 +- nipyapi/registry/models/position.py | 2 +- .../registry/models/provided_service_api.py | 2 +- nipyapi/registry/models/registry_about.py | 2 +- .../registry/models/registry_configuration.py | 2 +- nipyapi/registry/models/relationship.py | 2 +- nipyapi/registry/models/resource.py | 2 +- .../registry/models/resource_definition.py | 2 +- .../registry/models/resource_permissions.py | 2 +- nipyapi/registry/models/restricted.py | 2 +- nipyapi/registry/models/restriction.py | 2 +- nipyapi/registry/models/revision_info.py | 2 +- nipyapi/registry/models/stateful.py | 2 +- .../models/system_resource_consideration.py | 2 +- nipyapi/registry/models/tag_count.py | 2 +- nipyapi/registry/models/tenant.py | 2 +- nipyapi/registry/models/user.py | 2 +- nipyapi/registry/models/user_group.py | 2 +- .../registry/models/versioned_connection.py | 2 +- .../models/versioned_controller_service.py | 2 +- nipyapi/registry/models/versioned_flow.py | 2 +- .../models/versioned_flow_coordinates.py | 2 +- .../models/versioned_flow_difference.py | 2 +- .../models/versioned_flow_snapshot.py | 2 +- .../versioned_flow_snapshot_metadata.py | 2 +- nipyapi/registry/models/versioned_funnel.py | 2 +- nipyapi/registry/models/versioned_label.py | 2 +- .../registry/models/versioned_parameter.py | 2 +- .../models/versioned_parameter_context.py | 2 +- nipyapi/registry/models/versioned_port.py | 2 +- .../models/versioned_process_group.py | 58 +- .../registry/models/versioned_processor.py | 2 +- .../models/versioned_property_descriptor.py | 2 +- .../models/versioned_remote_group_port.py | 2 +- .../models/versioned_remote_process_group.py | 2 +- .../models/versioned_resource_definition.py | 2 +- nipyapi/registry/rest.py | 2 +- nipyapi/security.py | 2 +- nipyapi/utils.py | 26 +- nipyapi/versioning.py | 3 +- requirements.txt | 2 +- requirements_dev.txt | 1 - .../client_gen/api_defs/nifi-1.27.0.json | 26499 ++++++++++++++++ .../client_gen/api_defs/registry-1.27.0.json | 7129 +++++ resources/docker/latest/docker-compose.yml | 4 +- resources/docker/secure/docker-compose.yml | 4 +- resources/docker/tox-full/docker-compose.yml | 4 +- setup.py | 3 + tox.ini | 4 +- 532 files changed, 35556 insertions(+), 788 deletions(-) create mode 100644 nipyapi/nifi/models/versioned_reporting_task.py create mode 100644 nipyapi/nifi/models/versioned_reporting_task_snapshot.py create mode 100644 resources/client_gen/api_defs/nifi-1.27.0.json create mode 100644 resources/client_gen/api_defs/registry-1.27.0.json diff --git a/README.rst b/README.rst index 088caa64..bf426770 100644 --- a/README.rst +++ b/README.rst @@ -60,6 +60,9 @@ The easiest way to install NiPyApi is with pip:: # in bash pip install nipyapi + + # or with docker support for demos + pip install nipyapi[demo] You can set the config for your endpoints in the central config file:: @@ -93,7 +96,7 @@ Background and Documentation NiFi Version Support -------------------- -| Currently we are testing against NiFi versions 1.1.2 - 1.23.2, and NiFi-Registry versions 0.1.0 - 1.23.2. +| Currently we are testing against NiFi versions 1.1.2 - 1.27.0, and NiFi-Registry versions 0.1.0 - 1.27.0. | If you find a version compatibility problem please raise an `issue `_ Python Support diff --git a/nipyapi/demo/fdlc.py b/nipyapi/demo/fdlc.py index e46c26cf..884e5d05 100644 --- a/nipyapi/demo/fdlc.py +++ b/nipyapi/demo/fdlc.py @@ -7,10 +7,19 @@ """ from __future__ import absolute_import +from __future__ import print_function # For Python 2 and 3 compatibility import logging from time import sleep import nipyapi -from nipyapi.utils import DockerContainer + +try: + from nipyapi.utils import DockerContainer +except ImportError: + print("The 'docker' package is required for this demo. " + "Please install nipyapi with the 'demo' extra: " + "pip install nipyapi[demo]") + import sys + sys.exit(1) log = logging.getLogger(__name__) log.setLevel(logging.INFO) @@ -38,14 +47,14 @@ DockerContainer( name='nifi-dev', image_name='apache/nifi', - image_tag='latest', + image_tag='1.27.0', ports={str(dev_nifi_port) + '/tcp': dev_nifi_port}, env={'NIFI_WEB_HTTP_PORT': str(dev_nifi_port)} ), DockerContainer( name='nifi-prod', image_name='apache/nifi', - image_tag='latest', + image_tag='1.27.0', ports={str(prod_nifi_port) + '/tcp': prod_nifi_port}, env={'NIFI_WEB_HTTP_PORT': str(prod_nifi_port)} ), @@ -289,7 +298,7 @@ def step_9_deploy_prod_flow_to_nifi(): identifier=prod_ver_flow_name ) reg_client = nipyapi.versioning.get_registry_client(prod_reg_client_name) - nipyapi.versioning.deploy_flow_version( + nipyapi.versioning.deploy_flow_ver( parent_id=nipyapi.canvas.get_root_pg_id(), location=(0, 0), bucket_id=bucket.identifier, diff --git a/nipyapi/demo/secure_connection.py b/nipyapi/demo/secure_connection.py index 47996a5e..53dd8d7a 100644 --- a/nipyapi/demo/secure_connection.py +++ b/nipyapi/demo/secure_connection.py @@ -9,11 +9,22 @@ """ from __future__ import absolute_import +from __future__ import print_function # For Python 2 and 3 compatibility import logging from pprint import pprint from os import path +import sys import nipyapi -from nipyapi.utils import DockerContainer + +try: + from nipyapi.utils import DockerContainer + DOCKER_AVAILABLE = True +except ImportError: + DOCKER_AVAILABLE = False + print("The 'docker' package is required for this demo. " + "Please install nipyapi with the 'demo' extra: " + "pip install nipyapi[demo]") + sys.exit(1) log = logging.getLogger(__name__) log.setLevel(logging.INFO) @@ -74,7 +85,7 @@ DockerContainer( name='secure-nifi', image_name='apache/nifi', - image_tag='1.9.1', + image_tag='1.27.0', ports={'8443/tcp': 8443}, env=ldap_env_vars, volumes={ @@ -84,7 +95,7 @@ DockerContainer( name='secure-registry', image_name='apache/nifi-registry', - image_tag='0.3.0', + image_tag='1.27.0', ports={'18443/tcp': 18443}, env=tls_env_vars, volumes={ diff --git a/nipyapi/nifi/__init__.py b/nipyapi/nifi/__init__.py index a18e52b8..196ecbd5 100644 --- a/nipyapi/nifi/__init__.py +++ b/nipyapi/nifi/__init__.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -400,6 +400,8 @@ from .models.versioned_property_descriptor import VersionedPropertyDescriptor from .models.versioned_remote_group_port import VersionedRemoteGroupPort from .models.versioned_remote_process_group import VersionedRemoteProcessGroup +from .models.versioned_reporting_task import VersionedReportingTask +from .models.versioned_reporting_task_snapshot import VersionedReportingTaskSnapshot from .models.versioned_resource_definition import VersionedResourceDefinition # import apis into sdk package diff --git a/nipyapi/nifi/api_client.py b/nipyapi/nifi/api_client.py index b65a70a9..4ae28cc0 100644 --- a/nipyapi/nifi/api_client.py +++ b/nipyapi/nifi/api_client.py @@ -4,7 +4,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/access_api.py b/nipyapi/nifi/apis/access_api.py index ceada09a..9d3a2b2f 100644 --- a/nipyapi/nifi/apis/access_api.py +++ b/nipyapi/nifi/apis/access_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/connections_api.py b/nipyapi/nifi/apis/connections_api.py index 52d3b639..0aa3c693 100644 --- a/nipyapi/nifi/apis/connections_api.py +++ b/nipyapi/nifi/apis/connections_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/controller_api.py b/nipyapi/nifi/apis/controller_api.py index bb2b3bb6..94507278 100644 --- a/nipyapi/nifi/apis/controller_api.py +++ b/nipyapi/nifi/apis/controller_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/controller_services_api.py b/nipyapi/nifi/apis/controller_services_api.py index 97830202..42caf982 100644 --- a/nipyapi/nifi/apis/controller_services_api.py +++ b/nipyapi/nifi/apis/controller_services_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/counters_api.py b/nipyapi/nifi/apis/counters_api.py index f2d79bb4..8cf79f73 100644 --- a/nipyapi/nifi/apis/counters_api.py +++ b/nipyapi/nifi/apis/counters_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/data_transfer_api.py b/nipyapi/nifi/apis/data_transfer_api.py index b827d23c..d862a558 100644 --- a/nipyapi/nifi/apis/data_transfer_api.py +++ b/nipyapi/nifi/apis/data_transfer_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/flow_api.py b/nipyapi/nifi/apis/flow_api.py index 1deab7ae..7dfb4926 100644 --- a/nipyapi/nifi/apis/flow_api.py +++ b/nipyapi/nifi/apis/flow_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -153,6 +153,109 @@ def activate_controller_services_with_http_info(self, id, body, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def download_reporting_task_snapshot(self, **kwargs): + """ + Download a snapshot of the given reporting tasks and any controller services they use + + 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. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.download_reporting_task_snapshot(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str reporting_task_id: Specifies a reporting task id to export. If not specified, all reporting tasks will be exported. + :return: list[str] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.download_reporting_task_snapshot_with_http_info(**kwargs) + else: + (data) = self.download_reporting_task_snapshot_with_http_info(**kwargs) + return data + + def download_reporting_task_snapshot_with_http_info(self, **kwargs): + """ + Download a snapshot of the given reporting tasks and any controller services they use + + 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. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.download_reporting_task_snapshot_with_http_info(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str reporting_task_id: Specifies a reporting task id to export. If not specified, all reporting tasks will be exported. + :return: list[str] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['reporting_task_id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method download_reporting_task_snapshot" % key + ) + params[key] = val + del params['kwargs'] + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'reporting_task_id' in params: + query_params.append(('reportingTaskId', params['reporting_task_id'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/flow/reporting-tasks/download', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[str]', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def generate_client_id(self, **kwargs): """ Generates a client id. @@ -4040,6 +4143,109 @@ def get_remote_process_group_status_history_with_http_info(self, id, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_reporting_task_snapshot(self, **kwargs): + """ + Get a snapshot of the given reporting tasks and any controller services they use + + 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. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_reporting_task_snapshot(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str reporting_task_id: Specifies a reporting task id to export. If not specified, all reporting tasks will be exported. + :return: VersionedReportingTaskSnapshot + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_reporting_task_snapshot_with_http_info(**kwargs) + else: + (data) = self.get_reporting_task_snapshot_with_http_info(**kwargs) + return data + + def get_reporting_task_snapshot_with_http_info(self, **kwargs): + """ + Get a snapshot of the given reporting tasks and any controller services they use + + 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. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_reporting_task_snapshot_with_http_info(callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str reporting_task_id: Specifies a reporting task id to export. If not specified, all reporting tasks will be exported. + :return: VersionedReportingTaskSnapshot + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['reporting_task_id'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_reporting_task_snapshot" % key + ) + params[key] = val + del params['kwargs'] + + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'reporting_task_id' in params: + query_params.append(('reportingTaskId', params['reporting_task_id'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/flow/reporting-tasks/snapshot', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='VersionedReportingTaskSnapshot', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_reporting_task_types(self, **kwargs): """ Retrieves the types of reporting tasks that this NiFi supports @@ -4445,6 +4651,148 @@ def get_templates_with_http_info(self, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def get_version_differences(self, registry_id, bucket_id, flow_id, version_a, version_b, **kwargs): + """ + Gets the differences between two versions of the same versioned flow, the basis of the comparison will be the first version + + 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. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_version_differences(registry_id, bucket_id, flow_id, version_a, version_b, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str registry_id: The registry client id. (required) + :param str bucket_id: The bucket id. (required) + :param str flow_id: The flow id. (required) + :param int version_a: The base version. (required) + :param int version_b: The compared version. (required) + :param int offset: Must be a non-negative number. Specifies the starting point of the listing. 0 means start from the beginning. + :param int limit: Limits the number of differences listed. This might lead to partial result. 0 means no limitation is applied. + :return: FlowComparisonEntity + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_version_differences_with_http_info(registry_id, bucket_id, flow_id, version_a, version_b, **kwargs) + else: + (data) = self.get_version_differences_with_http_info(registry_id, bucket_id, flow_id, version_a, version_b, **kwargs) + return data + + def get_version_differences_with_http_info(self, registry_id, bucket_id, flow_id, version_a, version_b, **kwargs): + """ + Gets the differences between two versions of the same versioned flow, the basis of the comparison will be the first version + + 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. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_version_differences_with_http_info(registry_id, bucket_id, flow_id, version_a, version_b, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param str registry_id: The registry client id. (required) + :param str bucket_id: The bucket id. (required) + :param str flow_id: The flow id. (required) + :param int version_a: The base version. (required) + :param int version_b: The compared version. (required) + :param int offset: Must be a non-negative number. Specifies the starting point of the listing. 0 means start from the beginning. + :param int limit: Limits the number of differences listed. This might lead to partial result. 0 means no limitation is applied. + :return: FlowComparisonEntity + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['registry_id', 'bucket_id', 'flow_id', 'version_a', 'version_b', 'offset', 'limit'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_version_differences" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'registry_id' is set + if ('registry_id' not in params) or (params['registry_id'] is None): + raise ValueError("Missing the required parameter `registry_id` when calling `get_version_differences`") + # verify the required parameter 'bucket_id' is set + if ('bucket_id' not in params) or (params['bucket_id'] is None): + raise ValueError("Missing the required parameter `bucket_id` when calling `get_version_differences`") + # verify the required parameter 'flow_id' is set + if ('flow_id' not in params) or (params['flow_id'] is None): + raise ValueError("Missing the required parameter `flow_id` when calling `get_version_differences`") + # verify the required parameter 'version_a' is set + if ('version_a' not in params) or (params['version_a'] is None): + raise ValueError("Missing the required parameter `version_a` when calling `get_version_differences`") + # verify the required parameter 'version_b' is set + if ('version_b' not in params) or (params['version_b'] is None): + raise ValueError("Missing the required parameter `version_b` when calling `get_version_differences`") + + + collection_formats = {} + + path_params = {} + if 'registry_id' in params: + path_params['registry-id'] = params['registry_id'] + if 'bucket_id' in params: + path_params['bucket-id'] = params['bucket_id'] + if 'flow_id' in params: + path_params['flow-id'] = params['flow_id'] + if 'version_a' in params: + path_params['version-a'] = params['version_a'] + if 'version_b' in params: + path_params['version-b'] = params['version_b'] + + query_params = [] + if 'offset' in params: + query_params.append(('offset', params['offset'])) + if 'limit' in params: + query_params.append(('limit', params['limit'])) + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.\ + select_header_accept(['application/json']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.\ + select_header_content_type(['*/*']) + + # Authentication setting + auth_settings = ['tokenAuth'] + + return self.api_client.call_api('/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/{version-a}/diff/{version-b}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='FlowComparisonEntity', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def get_versions(self, registry_id, bucket_id, flow_id, **kwargs): """ Gets the flow versions from the specified registry and bucket for the specified flow for the current user diff --git a/nipyapi/nifi/apis/flowfile_queues_api.py b/nipyapi/nifi/apis/flowfile_queues_api.py index 273ed113..51e09250 100644 --- a/nipyapi/nifi/apis/flowfile_queues_api.py +++ b/nipyapi/nifi/apis/flowfile_queues_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/funnel_api.py b/nipyapi/nifi/apis/funnel_api.py index 9dfea3f0..25b81c53 100644 --- a/nipyapi/nifi/apis/funnel_api.py +++ b/nipyapi/nifi/apis/funnel_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/input_ports_api.py b/nipyapi/nifi/apis/input_ports_api.py index e0f5af15..2d7ba39f 100644 --- a/nipyapi/nifi/apis/input_ports_api.py +++ b/nipyapi/nifi/apis/input_ports_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/labels_api.py b/nipyapi/nifi/apis/labels_api.py index 42960953..5c11d245 100644 --- a/nipyapi/nifi/apis/labels_api.py +++ b/nipyapi/nifi/apis/labels_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/output_ports_api.py b/nipyapi/nifi/apis/output_ports_api.py index c22fd6d7..71fb0b1f 100644 --- a/nipyapi/nifi/apis/output_ports_api.py +++ b/nipyapi/nifi/apis/output_ports_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/parameter_contexts_api.py b/nipyapi/nifi/apis/parameter_contexts_api.py index 6c723c4b..ebaaed40 100644 --- a/nipyapi/nifi/apis/parameter_contexts_api.py +++ b/nipyapi/nifi/apis/parameter_contexts_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/parameter_providers_api.py b/nipyapi/nifi/apis/parameter_providers_api.py index 285d8ac2..c89f8421 100644 --- a/nipyapi/nifi/apis/parameter_providers_api.py +++ b/nipyapi/nifi/apis/parameter_providers_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/policies_api.py b/nipyapi/nifi/apis/policies_api.py index 71174e28..0bbfe21c 100644 --- a/nipyapi/nifi/apis/policies_api.py +++ b/nipyapi/nifi/apis/policies_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/process_groups_api.py b/nipyapi/nifi/apis/process_groups_api.py index a4bd0e7c..40b7b9be 100644 --- a/nipyapi/nifi/apis/process_groups_api.py +++ b/nipyapi/nifi/apis/process_groups_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -4357,7 +4357,7 @@ def update_variable_registry_with_http_info(self, id, body, **kwargs): _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def upload_process_group(self, id, body, body2, body3, body4, **kwargs): + def upload_process_group(self, id, group_name, position_x, position_y, client_id, file, **kwargs): """ Uploads a versioned flow definition and creates a process group @@ -4367,28 +4367,29 @@ def upload_process_group(self, id, body, body2, body3, body4, **kwargs): >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.upload_process_group(id, body, body2, body3, body4, callback=callback_function) + >>> thread = api.upload_process_group(id, group_name, position_x, position_y, client_id, file, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str id: The process group id. (required) - :param str body: The process group name. (required) - :param float body2: The process group X position. (required) - :param float body3: The process group Y position. (required) - :param str body4: The client id. (required) - :param bool body5: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :param str group_name: The process group name. (required) + :param float position_x: The process group X position. (required) + :param float position_y: The process group Y position. (required) + :param str client_id: The client id. (required) + :param file file: The binary content of the versioned flow definition file being uploaded. (required) + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. :return: ProcessGroupEntity If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.upload_process_group_with_http_info(id, body, body2, body3, body4, **kwargs) + return self.upload_process_group_with_http_info(id, group_name, position_x, position_y, client_id, file, **kwargs) else: - (data) = self.upload_process_group_with_http_info(id, body, body2, body3, body4, **kwargs) + (data) = self.upload_process_group_with_http_info(id, group_name, position_x, position_y, client_id, file, **kwargs) return data - def upload_process_group_with_http_info(self, id, body, body2, body3, body4, **kwargs): + def upload_process_group_with_http_info(self, id, group_name, position_x, position_y, client_id, file, **kwargs): """ Uploads a versioned flow definition and creates a process group @@ -4398,22 +4399,23 @@ def upload_process_group_with_http_info(self, id, body, body2, body3, body4, **k >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.upload_process_group_with_http_info(id, body, body2, body3, body4, callback=callback_function) + >>> thread = api.upload_process_group_with_http_info(id, group_name, position_x, position_y, client_id, file, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str id: The process group id. (required) - :param str body: The process group name. (required) - :param float body2: The process group X position. (required) - :param float body3: The process group Y position. (required) - :param str body4: The client id. (required) - :param bool body5: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :param str group_name: The process group name. (required) + :param float position_x: The process group X position. (required) + :param float position_y: The process group Y position. (required) + :param str client_id: The client id. (required) + :param file file: The binary content of the versioned flow definition file being uploaded. (required) + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. :return: ProcessGroupEntity If the method is called asynchronously, returns the request thread. """ - all_params = ['id', 'body', 'body2', 'body3', 'body4', 'body5'] + all_params = ['id', 'group_name', 'position_x', 'position_y', 'client_id', 'file', 'disconnected_node_acknowledged'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4431,18 +4433,21 @@ def upload_process_group_with_http_info(self, id, body, body2, body3, body4, **k # verify the required parameter 'id' is set if ('id' not in params) or (params['id'] is None): raise ValueError("Missing the required parameter `id` when calling `upload_process_group`") - # verify the required parameter 'body' is set - if ('body' not in params) or (params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `upload_process_group`") - # verify the required parameter 'body2' is set - if ('body2' not in params) or (params['body2'] is None): - raise ValueError("Missing the required parameter `body2` when calling `upload_process_group`") - # verify the required parameter 'body3' is set - if ('body3' not in params) or (params['body3'] is None): - raise ValueError("Missing the required parameter `body3` when calling `upload_process_group`") - # verify the required parameter 'body4' is set - if ('body4' not in params) or (params['body4'] is None): - raise ValueError("Missing the required parameter `body4` when calling `upload_process_group`") + # verify the required parameter 'group_name' is set + if ('group_name' not in params) or (params['group_name'] is None): + raise ValueError("Missing the required parameter `group_name` when calling `upload_process_group`") + # verify the required parameter 'position_x' is set + if ('position_x' not in params) or (params['position_x'] is None): + raise ValueError("Missing the required parameter `position_x` when calling `upload_process_group`") + # verify the required parameter 'position_y' is set + if ('position_y' not in params) or (params['position_y'] is None): + raise ValueError("Missing the required parameter `position_y` when calling `upload_process_group`") + # verify the required parameter 'client_id' is set + if ('client_id' not in params) or (params['client_id'] is None): + raise ValueError("Missing the required parameter `client_id` when calling `upload_process_group`") + # verify the required parameter 'file' is set + if ('file' not in params) or (params['file'] is None): + raise ValueError("Missing the required parameter `file` when calling `upload_process_group`") collection_formats = {} @@ -4457,10 +4462,20 @@ def upload_process_group_with_http_info(self, id, body, body2, body3, body4, **k form_params = [] local_var_files = {} + if 'group_name' in params: + form_params.append(('groupName', params['group_name'])) + if 'position_x' in params: + form_params.append(('positionX', params['position_x'])) + if 'position_y' in params: + form_params.append(('positionY', params['position_y'])) + if 'client_id' in params: + form_params.append(('clientId', params['client_id'])) + if 'disconnected_node_acknowledged' in params: + form_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) + if 'file' in params: + local_var_files['file'] = params['file'] body_params = None - if 'body5' in params: - body_params = params['body5'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/json']) @@ -4503,7 +4518,7 @@ def upload_template(self, id, template, **kwargs): for asynchronous request. (optional) :param str id: The process group id. (required) :param file template: The binary content of the template file being uploaded. (required) - :param bool body: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. :return: TemplateEntity If the method is called asynchronously, returns the request thread. @@ -4531,13 +4546,13 @@ def upload_template_with_http_info(self, id, template, **kwargs): for asynchronous request. (optional) :param str id: The process group id. (required) :param file template: The binary content of the template file being uploaded. (required) - :param bool body: Acknowledges that this node is disconnected to allow for mutable requests to proceed. + :param bool disconnected_node_acknowledged: Acknowledges that this node is disconnected to allow for mutable requests to proceed. :return: TemplateEntity If the method is called asynchronously, returns the request thread. """ - all_params = ['id', 'template', 'body'] + all_params = ['id', 'template', 'disconnected_node_acknowledged'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -4572,12 +4587,12 @@ def upload_template_with_http_info(self, id, template, **kwargs): form_params = [] local_var_files = {} + if 'disconnected_node_acknowledged' in params: + form_params.append(('disconnectedNodeAcknowledged', params['disconnected_node_acknowledged'])) if 'template' in params: local_var_files['template'] = params['template'] body_params = None - if 'body' in params: - body_params = params['body'] # HTTP header `Accept` header_params['Accept'] = self.api_client.\ select_header_accept(['application/xml']) diff --git a/nipyapi/nifi/apis/processors_api.py b/nipyapi/nifi/apis/processors_api.py index 9d1362d2..423a53cb 100644 --- a/nipyapi/nifi/apis/processors_api.py +++ b/nipyapi/nifi/apis/processors_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/provenance_api.py b/nipyapi/nifi/apis/provenance_api.py index 8def012e..e324790a 100644 --- a/nipyapi/nifi/apis/provenance_api.py +++ b/nipyapi/nifi/apis/provenance_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/provenance_events_api.py b/nipyapi/nifi/apis/provenance_events_api.py index ffb19e1d..802473de 100644 --- a/nipyapi/nifi/apis/provenance_events_api.py +++ b/nipyapi/nifi/apis/provenance_events_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/remote_process_groups_api.py b/nipyapi/nifi/apis/remote_process_groups_api.py index a2d17062..d534a8b0 100644 --- a/nipyapi/nifi/apis/remote_process_groups_api.py +++ b/nipyapi/nifi/apis/remote_process_groups_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/reporting_tasks_api.py b/nipyapi/nifi/apis/reporting_tasks_api.py index 367fdc7e..058e5953 100644 --- a/nipyapi/nifi/apis/reporting_tasks_api.py +++ b/nipyapi/nifi/apis/reporting_tasks_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/resources_api.py b/nipyapi/nifi/apis/resources_api.py index 343cab73..c6dbc7b8 100644 --- a/nipyapi/nifi/apis/resources_api.py +++ b/nipyapi/nifi/apis/resources_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/site_to_site_api.py b/nipyapi/nifi/apis/site_to_site_api.py index 4dc32bd1..f019e175 100644 --- a/nipyapi/nifi/apis/site_to_site_api.py +++ b/nipyapi/nifi/apis/site_to_site_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/snippets_api.py b/nipyapi/nifi/apis/snippets_api.py index 11e697f1..535f9287 100644 --- a/nipyapi/nifi/apis/snippets_api.py +++ b/nipyapi/nifi/apis/snippets_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/system_diagnostics_api.py b/nipyapi/nifi/apis/system_diagnostics_api.py index 0f6094da..3b621db4 100644 --- a/nipyapi/nifi/apis/system_diagnostics_api.py +++ b/nipyapi/nifi/apis/system_diagnostics_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/templates_api.py b/nipyapi/nifi/apis/templates_api.py index 96f453a9..da3643c5 100644 --- a/nipyapi/nifi/apis/templates_api.py +++ b/nipyapi/nifi/apis/templates_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/tenants_api.py b/nipyapi/nifi/apis/tenants_api.py index f93716ce..eb9d1ff1 100644 --- a/nipyapi/nifi/apis/tenants_api.py +++ b/nipyapi/nifi/apis/tenants_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/apis/versions_api.py b/nipyapi/nifi/apis/versions_api.py index 0cee73e7..2ca2f6ec 100644 --- a/nipyapi/nifi/apis/versions_api.py +++ b/nipyapi/nifi/apis/versions_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/configuration.py b/nipyapi/nifi/configuration.py index 5eae1576..d4c1507d 100644 --- a/nipyapi/nifi/configuration.py +++ b/nipyapi/nifi/configuration.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -64,7 +64,7 @@ def __init__(self): # Logging Settings self.logger = {} - self.logger["package_logger"] = logging.getLogger("swagger_client") + self.logger["package_logger"] = logging.getLogger("nifi") self.logger["urllib3_logger"] = logging.getLogger("urllib3") # Log format self.logger_format = '%(asctime)s %(levelname)s %(message)s' @@ -238,6 +238,6 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 1.23.2\n"\ + "Version of the API: 1.27.0\n"\ "SDK Package Version: 1.0.0".\ format(env=sys.platform, pyversion=sys.version) diff --git a/nipyapi/nifi/models/__init__.py b/nipyapi/nifi/models/__init__.py index 578fe571..67b022bf 100644 --- a/nipyapi/nifi/models/__init__.py +++ b/nipyapi/nifi/models/__init__.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -400,4 +400,6 @@ from .versioned_property_descriptor import VersionedPropertyDescriptor from .versioned_remote_group_port import VersionedRemoteGroupPort from .versioned_remote_process_group import VersionedRemoteProcessGroup +from .versioned_reporting_task import VersionedReportingTask +from .versioned_reporting_task_snapshot import VersionedReportingTaskSnapshot from .versioned_resource_definition import VersionedResourceDefinition diff --git a/nipyapi/nifi/models/about_dto.py b/nipyapi/nifi/models/about_dto.py index 17719ab4..589d81cb 100644 --- a/nipyapi/nifi/models/about_dto.py +++ b/nipyapi/nifi/models/about_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/about_entity.py b/nipyapi/nifi/models/about_entity.py index 09811a83..62e5f895 100644 --- a/nipyapi/nifi/models/about_entity.py +++ b/nipyapi/nifi/models/about_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_configuration_dto.py b/nipyapi/nifi/models/access_configuration_dto.py index a3e791d7..f5b17e89 100644 --- a/nipyapi/nifi/models/access_configuration_dto.py +++ b/nipyapi/nifi/models/access_configuration_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_configuration_entity.py b/nipyapi/nifi/models/access_configuration_entity.py index cbea8c05..7c981bf2 100644 --- a/nipyapi/nifi/models/access_configuration_entity.py +++ b/nipyapi/nifi/models/access_configuration_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_dto.py b/nipyapi/nifi/models/access_policy_dto.py index 1a0baf91..33a757e4 100644 --- a/nipyapi/nifi/models/access_policy_dto.py +++ b/nipyapi/nifi/models/access_policy_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_entity.py b/nipyapi/nifi/models/access_policy_entity.py index 200b0cf9..942292ee 100644 --- a/nipyapi/nifi/models/access_policy_entity.py +++ b/nipyapi/nifi/models/access_policy_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_summary_dto.py b/nipyapi/nifi/models/access_policy_summary_dto.py index b60a32d1..f6e5d051 100644 --- a/nipyapi/nifi/models/access_policy_summary_dto.py +++ b/nipyapi/nifi/models/access_policy_summary_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_policy_summary_entity.py b/nipyapi/nifi/models/access_policy_summary_entity.py index aa184f77..e560fcd6 100644 --- a/nipyapi/nifi/models/access_policy_summary_entity.py +++ b/nipyapi/nifi/models/access_policy_summary_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_status_dto.py b/nipyapi/nifi/models/access_status_dto.py index f69957a7..2fae5907 100644 --- a/nipyapi/nifi/models/access_status_dto.py +++ b/nipyapi/nifi/models/access_status_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_status_entity.py b/nipyapi/nifi/models/access_status_entity.py index c01aa07a..6b3a2589 100644 --- a/nipyapi/nifi/models/access_status_entity.py +++ b/nipyapi/nifi/models/access_status_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_token_expiration_dto.py b/nipyapi/nifi/models/access_token_expiration_dto.py index dfdb1298..36959d48 100644 --- a/nipyapi/nifi/models/access_token_expiration_dto.py +++ b/nipyapi/nifi/models/access_token_expiration_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/access_token_expiration_entity.py b/nipyapi/nifi/models/access_token_expiration_entity.py index cdcf8adf..202fda9f 100644 --- a/nipyapi/nifi/models/access_token_expiration_entity.py +++ b/nipyapi/nifi/models/access_token_expiration_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/action_details_dto.py b/nipyapi/nifi/models/action_details_dto.py index 98d5502a..686f16f7 100644 --- a/nipyapi/nifi/models/action_details_dto.py +++ b/nipyapi/nifi/models/action_details_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/action_dto.py b/nipyapi/nifi/models/action_dto.py index 34a07038..c29b292f 100644 --- a/nipyapi/nifi/models/action_dto.py +++ b/nipyapi/nifi/models/action_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/action_entity.py b/nipyapi/nifi/models/action_entity.py index bfb3a315..95dd744e 100644 --- a/nipyapi/nifi/models/action_entity.py +++ b/nipyapi/nifi/models/action_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/activate_controller_services_entity.py b/nipyapi/nifi/models/activate_controller_services_entity.py index a9bbba7a..19571f5b 100644 --- a/nipyapi/nifi/models/activate_controller_services_entity.py +++ b/nipyapi/nifi/models/activate_controller_services_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/affected_component_dto.py b/nipyapi/nifi/models/affected_component_dto.py index 930b322a..cf20f906 100644 --- a/nipyapi/nifi/models/affected_component_dto.py +++ b/nipyapi/nifi/models/affected_component_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/affected_component_entity.py b/nipyapi/nifi/models/affected_component_entity.py index af753b82..88f2947e 100644 --- a/nipyapi/nifi/models/affected_component_entity.py +++ b/nipyapi/nifi/models/affected_component_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/allowable_value_dto.py b/nipyapi/nifi/models/allowable_value_dto.py index ae8803ab..0850a08b 100644 --- a/nipyapi/nifi/models/allowable_value_dto.py +++ b/nipyapi/nifi/models/allowable_value_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/allowable_value_entity.py b/nipyapi/nifi/models/allowable_value_entity.py index 648c18f9..64766ab4 100644 --- a/nipyapi/nifi/models/allowable_value_entity.py +++ b/nipyapi/nifi/models/allowable_value_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/attribute.py b/nipyapi/nifi/models/attribute.py index e31274b2..ee353ab0 100644 --- a/nipyapi/nifi/models/attribute.py +++ b/nipyapi/nifi/models/attribute.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/attribute_dto.py b/nipyapi/nifi/models/attribute_dto.py index 235fb720..5e6b2fcc 100644 --- a/nipyapi/nifi/models/attribute_dto.py +++ b/nipyapi/nifi/models/attribute_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/banner_dto.py b/nipyapi/nifi/models/banner_dto.py index e1c28693..6f033635 100644 --- a/nipyapi/nifi/models/banner_dto.py +++ b/nipyapi/nifi/models/banner_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/banner_entity.py b/nipyapi/nifi/models/banner_entity.py index b096f079..6fcebb21 100644 --- a/nipyapi/nifi/models/banner_entity.py +++ b/nipyapi/nifi/models/banner_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/batch_settings_dto.py b/nipyapi/nifi/models/batch_settings_dto.py index a8f9f054..a412bb9e 100644 --- a/nipyapi/nifi/models/batch_settings_dto.py +++ b/nipyapi/nifi/models/batch_settings_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/batch_size.py b/nipyapi/nifi/models/batch_size.py index 7510b1c9..7bb02682 100644 --- a/nipyapi/nifi/models/batch_size.py +++ b/nipyapi/nifi/models/batch_size.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/build_info.py b/nipyapi/nifi/models/build_info.py index f40209b4..dd1e50f4 100644 --- a/nipyapi/nifi/models/build_info.py +++ b/nipyapi/nifi/models/build_info.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_board_dto.py b/nipyapi/nifi/models/bulletin_board_dto.py index 7799385e..2c25c05b 100644 --- a/nipyapi/nifi/models/bulletin_board_dto.py +++ b/nipyapi/nifi/models/bulletin_board_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_board_entity.py b/nipyapi/nifi/models/bulletin_board_entity.py index a5b40bff..a0b36ea6 100644 --- a/nipyapi/nifi/models/bulletin_board_entity.py +++ b/nipyapi/nifi/models/bulletin_board_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_dto.py b/nipyapi/nifi/models/bulletin_dto.py index 19ddcfa0..86c4baaf 100644 --- a/nipyapi/nifi/models/bulletin_dto.py +++ b/nipyapi/nifi/models/bulletin_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bulletin_entity.py b/nipyapi/nifi/models/bulletin_entity.py index 56c25e25..07989720 100644 --- a/nipyapi/nifi/models/bulletin_entity.py +++ b/nipyapi/nifi/models/bulletin_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bundle.py b/nipyapi/nifi/models/bundle.py index 59923938..e3b7331c 100644 --- a/nipyapi/nifi/models/bundle.py +++ b/nipyapi/nifi/models/bundle.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/bundle_dto.py b/nipyapi/nifi/models/bundle_dto.py index ca887920..94edccde 100644 --- a/nipyapi/nifi/models/bundle_dto.py +++ b/nipyapi/nifi/models/bundle_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/class_loader_diagnostics_dto.py b/nipyapi/nifi/models/class_loader_diagnostics_dto.py index 90419a2f..dca35456 100644 --- a/nipyapi/nifi/models/class_loader_diagnostics_dto.py +++ b/nipyapi/nifi/models/class_loader_diagnostics_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluste_summary_entity.py b/nipyapi/nifi/models/cluste_summary_entity.py index 92696d04..09047b27 100644 --- a/nipyapi/nifi/models/cluste_summary_entity.py +++ b/nipyapi/nifi/models/cluste_summary_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_dto.py b/nipyapi/nifi/models/cluster_dto.py index 450de830..e5383891 100644 --- a/nipyapi/nifi/models/cluster_dto.py +++ b/nipyapi/nifi/models/cluster_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_entity.py b/nipyapi/nifi/models/cluster_entity.py index c21bf539..f23dd50d 100644 --- a/nipyapi/nifi/models/cluster_entity.py +++ b/nipyapi/nifi/models/cluster_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_search_results_entity.py b/nipyapi/nifi/models/cluster_search_results_entity.py index ae3ba151..93c5d4c0 100644 --- a/nipyapi/nifi/models/cluster_search_results_entity.py +++ b/nipyapi/nifi/models/cluster_search_results_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/cluster_summary_dto.py b/nipyapi/nifi/models/cluster_summary_dto.py index 734ef767..81ced537 100644 --- a/nipyapi/nifi/models/cluster_summary_dto.py +++ b/nipyapi/nifi/models/cluster_summary_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_details_dto.py b/nipyapi/nifi/models/component_details_dto.py index b05081cc..50d8278b 100644 --- a/nipyapi/nifi/models/component_details_dto.py +++ b/nipyapi/nifi/models/component_details_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_difference_dto.py b/nipyapi/nifi/models/component_difference_dto.py index bafa9268..43477f4a 100644 --- a/nipyapi/nifi/models/component_difference_dto.py +++ b/nipyapi/nifi/models/component_difference_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_history_dto.py b/nipyapi/nifi/models/component_history_dto.py index 7764315f..c9e0b642 100644 --- a/nipyapi/nifi/models/component_history_dto.py +++ b/nipyapi/nifi/models/component_history_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_history_entity.py b/nipyapi/nifi/models/component_history_entity.py index 82c74ce5..10f322ca 100644 --- a/nipyapi/nifi/models/component_history_entity.py +++ b/nipyapi/nifi/models/component_history_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_lifecycle.py b/nipyapi/nifi/models/component_lifecycle.py index 1a61ab6e..68d4c478 100644 --- a/nipyapi/nifi/models/component_lifecycle.py +++ b/nipyapi/nifi/models/component_lifecycle.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_manifest.py b/nipyapi/nifi/models/component_manifest.py index ca4a207c..7718f10f 100644 --- a/nipyapi/nifi/models/component_manifest.py +++ b/nipyapi/nifi/models/component_manifest.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_reference_dto.py b/nipyapi/nifi/models/component_reference_dto.py index 7f115e49..e7128e7d 100644 --- a/nipyapi/nifi/models/component_reference_dto.py +++ b/nipyapi/nifi/models/component_reference_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_reference_entity.py b/nipyapi/nifi/models/component_reference_entity.py index 66a342e4..a425b586 100644 --- a/nipyapi/nifi/models/component_reference_entity.py +++ b/nipyapi/nifi/models/component_reference_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_restriction_permission_dto.py b/nipyapi/nifi/models/component_restriction_permission_dto.py index a8e0094d..e029b33a 100644 --- a/nipyapi/nifi/models/component_restriction_permission_dto.py +++ b/nipyapi/nifi/models/component_restriction_permission_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_search_result_dto.py b/nipyapi/nifi/models/component_search_result_dto.py index b5d2d19c..5ba34419 100644 --- a/nipyapi/nifi/models/component_search_result_dto.py +++ b/nipyapi/nifi/models/component_search_result_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_state_dto.py b/nipyapi/nifi/models/component_state_dto.py index 5c3bfd7d..129c6de0 100644 --- a/nipyapi/nifi/models/component_state_dto.py +++ b/nipyapi/nifi/models/component_state_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_state_entity.py b/nipyapi/nifi/models/component_state_entity.py index ead2053c..7e32ec01 100644 --- a/nipyapi/nifi/models/component_state_entity.py +++ b/nipyapi/nifi/models/component_state_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_validation_result_dto.py b/nipyapi/nifi/models/component_validation_result_dto.py index 1609b750..43f8a2e0 100644 --- a/nipyapi/nifi/models/component_validation_result_dto.py +++ b/nipyapi/nifi/models/component_validation_result_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_validation_result_entity.py b/nipyapi/nifi/models/component_validation_result_entity.py index 5e6b1a5f..9a02ec3e 100644 --- a/nipyapi/nifi/models/component_validation_result_entity.py +++ b/nipyapi/nifi/models/component_validation_result_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/component_validation_results_entity.py b/nipyapi/nifi/models/component_validation_results_entity.py index f574adaa..a16c60f0 100644 --- a/nipyapi/nifi/models/component_validation_results_entity.py +++ b/nipyapi/nifi/models/component_validation_results_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/config_verification_result_dto.py b/nipyapi/nifi/models/config_verification_result_dto.py index 6c364b04..82296820 100644 --- a/nipyapi/nifi/models/config_verification_result_dto.py +++ b/nipyapi/nifi/models/config_verification_result_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/configuration_analysis_dto.py b/nipyapi/nifi/models/configuration_analysis_dto.py index 79eb39ec..64288caf 100644 --- a/nipyapi/nifi/models/configuration_analysis_dto.py +++ b/nipyapi/nifi/models/configuration_analysis_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/configuration_analysis_entity.py b/nipyapi/nifi/models/configuration_analysis_entity.py index 690cfbc4..a8b675f9 100644 --- a/nipyapi/nifi/models/configuration_analysis_entity.py +++ b/nipyapi/nifi/models/configuration_analysis_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connectable_component.py b/nipyapi/nifi/models/connectable_component.py index a264b9fb..176b1a50 100644 --- a/nipyapi/nifi/models/connectable_component.py +++ b/nipyapi/nifi/models/connectable_component.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connectable_dto.py b/nipyapi/nifi/models/connectable_dto.py index da189680..489016ef 100644 --- a/nipyapi/nifi/models/connectable_dto.py +++ b/nipyapi/nifi/models/connectable_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_diagnostics_dto.py b/nipyapi/nifi/models/connection_diagnostics_dto.py index bd7c1268..7939a128 100644 --- a/nipyapi/nifi/models/connection_diagnostics_dto.py +++ b/nipyapi/nifi/models/connection_diagnostics_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/connection_diagnostics_snapshot_dto.py index 57e853bd..185f5115 100644 --- a/nipyapi/nifi/models/connection_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_dto.py b/nipyapi/nifi/models/connection_dto.py index 7e83556f..ee911347 100644 --- a/nipyapi/nifi/models/connection_dto.py +++ b/nipyapi/nifi/models/connection_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_entity.py b/nipyapi/nifi/models/connection_entity.py index 1ec4cf39..9fc28c57 100644 --- a/nipyapi/nifi/models/connection_entity.py +++ b/nipyapi/nifi/models/connection_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_statistics_dto.py b/nipyapi/nifi/models/connection_statistics_dto.py index 11d394fc..102d8340 100644 --- a/nipyapi/nifi/models/connection_statistics_dto.py +++ b/nipyapi/nifi/models/connection_statistics_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_statistics_entity.py b/nipyapi/nifi/models/connection_statistics_entity.py index 7aff5f1c..11a67e34 100644 --- a/nipyapi/nifi/models/connection_statistics_entity.py +++ b/nipyapi/nifi/models/connection_statistics_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_statistics_snapshot_dto.py b/nipyapi/nifi/models/connection_statistics_snapshot_dto.py index 468a35bf..b6032e29 100644 --- a/nipyapi/nifi/models/connection_statistics_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_statistics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_dto.py b/nipyapi/nifi/models/connection_status_dto.py index 56b704a6..9ac52287 100644 --- a/nipyapi/nifi/models/connection_status_dto.py +++ b/nipyapi/nifi/models/connection_status_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_entity.py b/nipyapi/nifi/models/connection_status_entity.py index 4dbb74e5..777fbb51 100644 --- a/nipyapi/nifi/models/connection_status_entity.py +++ b/nipyapi/nifi/models/connection_status_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py b/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py index 243ed8e4..cdfa7fbf 100644 --- a/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_status_predictions_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_snapshot_dto.py b/nipyapi/nifi/models/connection_status_snapshot_dto.py index 49bb1199..d1143021 100644 --- a/nipyapi/nifi/models/connection_status_snapshot_dto.py +++ b/nipyapi/nifi/models/connection_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connection_status_snapshot_entity.py b/nipyapi/nifi/models/connection_status_snapshot_entity.py index 57c5d1d5..6402562e 100644 --- a/nipyapi/nifi/models/connection_status_snapshot_entity.py +++ b/nipyapi/nifi/models/connection_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/connections_entity.py b/nipyapi/nifi/models/connections_entity.py index 6de883fb..88deaecf 100644 --- a/nipyapi/nifi/models/connections_entity.py +++ b/nipyapi/nifi/models/connections_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_bulletins_entity.py b/nipyapi/nifi/models/controller_bulletins_entity.py index b8410dd7..76c84595 100644 --- a/nipyapi/nifi/models/controller_bulletins_entity.py +++ b/nipyapi/nifi/models/controller_bulletins_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_configuration_dto.py b/nipyapi/nifi/models/controller_configuration_dto.py index 0e774eae..ec322102 100644 --- a/nipyapi/nifi/models/controller_configuration_dto.py +++ b/nipyapi/nifi/models/controller_configuration_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_configuration_entity.py b/nipyapi/nifi/models/controller_configuration_entity.py index f19e672f..7cb43d5e 100644 --- a/nipyapi/nifi/models/controller_configuration_entity.py +++ b/nipyapi/nifi/models/controller_configuration_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_dto.py b/nipyapi/nifi/models/controller_dto.py index bf6b1317..5ac75e28 100644 --- a/nipyapi/nifi/models/controller_dto.py +++ b/nipyapi/nifi/models/controller_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_entity.py b/nipyapi/nifi/models/controller_entity.py index 7783609f..c2daa915 100644 --- a/nipyapi/nifi/models/controller_entity.py +++ b/nipyapi/nifi/models/controller_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_api.py b/nipyapi/nifi/models/controller_service_api.py index 24e828ae..f39b9f1a 100644 --- a/nipyapi/nifi/models/controller_service_api.py +++ b/nipyapi/nifi/models/controller_service_api.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_api_dto.py b/nipyapi/nifi/models/controller_service_api_dto.py index 1182b193..18e87ff9 100644 --- a/nipyapi/nifi/models/controller_service_api_dto.py +++ b/nipyapi/nifi/models/controller_service_api_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_definition.py b/nipyapi/nifi/models/controller_service_definition.py index dc30d49d..7fc7651c 100644 --- a/nipyapi/nifi/models/controller_service_definition.py +++ b/nipyapi/nifi/models/controller_service_definition.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_diagnostics_dto.py b/nipyapi/nifi/models/controller_service_diagnostics_dto.py index 822d93e5..c5820e4a 100644 --- a/nipyapi/nifi/models/controller_service_diagnostics_dto.py +++ b/nipyapi/nifi/models/controller_service_diagnostics_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_dto.py b/nipyapi/nifi/models/controller_service_dto.py index 816c4c19..cb18f392 100644 --- a/nipyapi/nifi/models/controller_service_dto.py +++ b/nipyapi/nifi/models/controller_service_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_entity.py b/nipyapi/nifi/models/controller_service_entity.py index f4b42783..de137bd1 100644 --- a/nipyapi/nifi/models/controller_service_entity.py +++ b/nipyapi/nifi/models/controller_service_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_referencing_component_dto.py b/nipyapi/nifi/models/controller_service_referencing_component_dto.py index 27d33255..98d625ba 100644 --- a/nipyapi/nifi/models/controller_service_referencing_component_dto.py +++ b/nipyapi/nifi/models/controller_service_referencing_component_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_referencing_component_entity.py b/nipyapi/nifi/models/controller_service_referencing_component_entity.py index aab33eb4..778389e6 100644 --- a/nipyapi/nifi/models/controller_service_referencing_component_entity.py +++ b/nipyapi/nifi/models/controller_service_referencing_component_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_referencing_components_entity.py b/nipyapi/nifi/models/controller_service_referencing_components_entity.py index 623567e1..7de7cd0e 100644 --- a/nipyapi/nifi/models/controller_service_referencing_components_entity.py +++ b/nipyapi/nifi/models/controller_service_referencing_components_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_run_status_entity.py b/nipyapi/nifi/models/controller_service_run_status_entity.py index d5691ec1..c27f3a7e 100644 --- a/nipyapi/nifi/models/controller_service_run_status_entity.py +++ b/nipyapi/nifi/models/controller_service_run_status_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_status_dto.py b/nipyapi/nifi/models/controller_service_status_dto.py index 4f2a5c6d..c0d454e8 100644 --- a/nipyapi/nifi/models/controller_service_status_dto.py +++ b/nipyapi/nifi/models/controller_service_status_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_service_types_entity.py b/nipyapi/nifi/models/controller_service_types_entity.py index b089dffa..2d248a13 100644 --- a/nipyapi/nifi/models/controller_service_types_entity.py +++ b/nipyapi/nifi/models/controller_service_types_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_services_entity.py b/nipyapi/nifi/models/controller_services_entity.py index 234ea584..2a0716bd 100644 --- a/nipyapi/nifi/models/controller_services_entity.py +++ b/nipyapi/nifi/models/controller_services_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_status_dto.py b/nipyapi/nifi/models/controller_status_dto.py index efc6aa75..04e8ae37 100644 --- a/nipyapi/nifi/models/controller_status_dto.py +++ b/nipyapi/nifi/models/controller_status_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/controller_status_entity.py b/nipyapi/nifi/models/controller_status_entity.py index 443658d5..4e366fc1 100644 --- a/nipyapi/nifi/models/controller_status_entity.py +++ b/nipyapi/nifi/models/controller_status_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/copy_snippet_request_entity.py b/nipyapi/nifi/models/copy_snippet_request_entity.py index 7ff9f8b0..4b9bfe46 100644 --- a/nipyapi/nifi/models/copy_snippet_request_entity.py +++ b/nipyapi/nifi/models/copy_snippet_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counter_dto.py b/nipyapi/nifi/models/counter_dto.py index 220c06b3..357950a0 100644 --- a/nipyapi/nifi/models/counter_dto.py +++ b/nipyapi/nifi/models/counter_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counter_entity.py b/nipyapi/nifi/models/counter_entity.py index 29aca51e..3ec8bf2a 100644 --- a/nipyapi/nifi/models/counter_entity.py +++ b/nipyapi/nifi/models/counter_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counters_dto.py b/nipyapi/nifi/models/counters_dto.py index 31d7d5ad..ab2381b0 100644 --- a/nipyapi/nifi/models/counters_dto.py +++ b/nipyapi/nifi/models/counters_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counters_entity.py b/nipyapi/nifi/models/counters_entity.py index 0058dda8..c765612e 100644 --- a/nipyapi/nifi/models/counters_entity.py +++ b/nipyapi/nifi/models/counters_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/counters_snapshot_dto.py b/nipyapi/nifi/models/counters_snapshot_dto.py index e3c6e77d..b4d5c69d 100644 --- a/nipyapi/nifi/models/counters_snapshot_dto.py +++ b/nipyapi/nifi/models/counters_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/create_active_request_entity.py b/nipyapi/nifi/models/create_active_request_entity.py index 11c632ae..09a51d31 100644 --- a/nipyapi/nifi/models/create_active_request_entity.py +++ b/nipyapi/nifi/models/create_active_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/create_template_request_entity.py b/nipyapi/nifi/models/create_template_request_entity.py index b34e210d..0ec258da 100644 --- a/nipyapi/nifi/models/create_template_request_entity.py +++ b/nipyapi/nifi/models/create_template_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/current_user_entity.py b/nipyapi/nifi/models/current_user_entity.py index fca67c5a..42e4a1c7 100644 --- a/nipyapi/nifi/models/current_user_entity.py +++ b/nipyapi/nifi/models/current_user_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/defined_type.py b/nipyapi/nifi/models/defined_type.py index fb355e83..a99edfe3 100644 --- a/nipyapi/nifi/models/defined_type.py +++ b/nipyapi/nifi/models/defined_type.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/difference_dto.py b/nipyapi/nifi/models/difference_dto.py index 3254d0cc..e5f75c2d 100644 --- a/nipyapi/nifi/models/difference_dto.py +++ b/nipyapi/nifi/models/difference_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/dimensions_dto.py b/nipyapi/nifi/models/dimensions_dto.py index 75dc9dab..bdc02a6d 100644 --- a/nipyapi/nifi/models/dimensions_dto.py +++ b/nipyapi/nifi/models/dimensions_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/documented_type_dto.py b/nipyapi/nifi/models/documented_type_dto.py index 7528f53e..ba8b71bc 100644 --- a/nipyapi/nifi/models/documented_type_dto.py +++ b/nipyapi/nifi/models/documented_type_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/drop_request_dto.py b/nipyapi/nifi/models/drop_request_dto.py index b11ff3ad..8e4e4858 100644 --- a/nipyapi/nifi/models/drop_request_dto.py +++ b/nipyapi/nifi/models/drop_request_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/drop_request_entity.py b/nipyapi/nifi/models/drop_request_entity.py index 81dc517b..0eb140b1 100644 --- a/nipyapi/nifi/models/drop_request_entity.py +++ b/nipyapi/nifi/models/drop_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/dto_factory.py b/nipyapi/nifi/models/dto_factory.py index daa1b935..e3dcb284 100644 --- a/nipyapi/nifi/models/dto_factory.py +++ b/nipyapi/nifi/models/dto_factory.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/dynamic_property.py b/nipyapi/nifi/models/dynamic_property.py index 6c05e71c..589540be 100644 --- a/nipyapi/nifi/models/dynamic_property.py +++ b/nipyapi/nifi/models/dynamic_property.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/dynamic_relationship.py b/nipyapi/nifi/models/dynamic_relationship.py index 3c4a8046..d11795af 100644 --- a/nipyapi/nifi/models/dynamic_relationship.py +++ b/nipyapi/nifi/models/dynamic_relationship.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/entity.py b/nipyapi/nifi/models/entity.py index da77816e..3a347cbd 100644 --- a/nipyapi/nifi/models/entity.py +++ b/nipyapi/nifi/models/entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/explicit_restriction_dto.py b/nipyapi/nifi/models/explicit_restriction_dto.py index 5e596510..f70ef3ba 100644 --- a/nipyapi/nifi/models/explicit_restriction_dto.py +++ b/nipyapi/nifi/models/explicit_restriction_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/external_controller_service_reference.py b/nipyapi/nifi/models/external_controller_service_reference.py index fb3b9fab..e5596722 100644 --- a/nipyapi/nifi/models/external_controller_service_reference.py +++ b/nipyapi/nifi/models/external_controller_service_reference.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_breadcrumb_dto.py b/nipyapi/nifi/models/flow_breadcrumb_dto.py index 7896f318..90601ca2 100644 --- a/nipyapi/nifi/models/flow_breadcrumb_dto.py +++ b/nipyapi/nifi/models/flow_breadcrumb_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_breadcrumb_entity.py b/nipyapi/nifi/models/flow_breadcrumb_entity.py index 8a0592b7..a6a001b6 100644 --- a/nipyapi/nifi/models/flow_breadcrumb_entity.py +++ b/nipyapi/nifi/models/flow_breadcrumb_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_comparison_entity.py b/nipyapi/nifi/models/flow_comparison_entity.py index 06c7e9fa..794388e9 100644 --- a/nipyapi/nifi/models/flow_comparison_entity.py +++ b/nipyapi/nifi/models/flow_comparison_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_configuration_dto.py b/nipyapi/nifi/models/flow_configuration_dto.py index b9a4f220..cb90e3ca 100644 --- a/nipyapi/nifi/models/flow_configuration_dto.py +++ b/nipyapi/nifi/models/flow_configuration_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_configuration_entity.py b/nipyapi/nifi/models/flow_configuration_entity.py index 8232b5f3..92408813 100644 --- a/nipyapi/nifi/models/flow_configuration_entity.py +++ b/nipyapi/nifi/models/flow_configuration_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_dto.py b/nipyapi/nifi/models/flow_dto.py index 804fe623..f55a6b6b 100644 --- a/nipyapi/nifi/models/flow_dto.py +++ b/nipyapi/nifi/models/flow_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_entity.py b/nipyapi/nifi/models/flow_entity.py index 635f5352..7bff395d 100644 --- a/nipyapi/nifi/models/flow_entity.py +++ b/nipyapi/nifi/models/flow_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_file_dto.py b/nipyapi/nifi/models/flow_file_dto.py index 16562995..49a062a5 100644 --- a/nipyapi/nifi/models/flow_file_dto.py +++ b/nipyapi/nifi/models/flow_file_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_file_entity.py b/nipyapi/nifi/models/flow_file_entity.py index 88a74d63..6d7047d4 100644 --- a/nipyapi/nifi/models/flow_file_entity.py +++ b/nipyapi/nifi/models/flow_file_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_file_summary_dto.py b/nipyapi/nifi/models/flow_file_summary_dto.py index 3f3a3400..3f23e8fb 100644 --- a/nipyapi/nifi/models/flow_file_summary_dto.py +++ b/nipyapi/nifi/models/flow_file_summary_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_registry_bucket.py b/nipyapi/nifi/models/flow_registry_bucket.py index 7e2c4c0b..8e5139fd 100644 --- a/nipyapi/nifi/models/flow_registry_bucket.py +++ b/nipyapi/nifi/models/flow_registry_bucket.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_registry_bucket_dto.py b/nipyapi/nifi/models/flow_registry_bucket_dto.py index 482a026d..f32dc720 100644 --- a/nipyapi/nifi/models/flow_registry_bucket_dto.py +++ b/nipyapi/nifi/models/flow_registry_bucket_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_registry_bucket_entity.py b/nipyapi/nifi/models/flow_registry_bucket_entity.py index 9b05a973..98e73b3a 100644 --- a/nipyapi/nifi/models/flow_registry_bucket_entity.py +++ b/nipyapi/nifi/models/flow_registry_bucket_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_registry_buckets_entity.py b/nipyapi/nifi/models/flow_registry_buckets_entity.py index 4994a03f..51b4fc6f 100644 --- a/nipyapi/nifi/models/flow_registry_buckets_entity.py +++ b/nipyapi/nifi/models/flow_registry_buckets_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_registry_client_dto.py b/nipyapi/nifi/models/flow_registry_client_dto.py index 5624d1f1..01340a0d 100644 --- a/nipyapi/nifi/models/flow_registry_client_dto.py +++ b/nipyapi/nifi/models/flow_registry_client_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -46,8 +46,8 @@ class FlowRegistryClientDTO(object): 'validation_errors': 'list[str]', 'validation_status': 'str', 'annotation_data': 'str', - 'extension_missing': 'bool', - 'multiple_versions_available': 'bool' + 'multiple_versions_available': 'bool', + 'extension_missing': 'bool' } attribute_map = { @@ -66,11 +66,11 @@ class FlowRegistryClientDTO(object): 'validation_errors': 'validationErrors', 'validation_status': 'validationStatus', 'annotation_data': 'annotationData', - 'extension_missing': 'extensionMissing', - 'multiple_versions_available': 'multipleVersionsAvailable' + 'multiple_versions_available': 'multipleVersionsAvailable', + 'extension_missing': 'extensionMissing' } - def __init__(self, id=None, name=None, description=None, uri=None, type=None, bundle=None, properties=None, descriptors=None, sensitive_dynamic_property_names=None, supports_sensitive_dynamic_properties=None, restricted=None, deprecated=None, validation_errors=None, validation_status=None, annotation_data=None, extension_missing=None, multiple_versions_available=None): + def __init__(self, id=None, name=None, description=None, uri=None, type=None, bundle=None, properties=None, descriptors=None, sensitive_dynamic_property_names=None, supports_sensitive_dynamic_properties=None, restricted=None, deprecated=None, validation_errors=None, validation_status=None, annotation_data=None, multiple_versions_available=None, extension_missing=None): """ FlowRegistryClientDTO - a model defined in Swagger """ @@ -90,8 +90,8 @@ def __init__(self, id=None, name=None, description=None, uri=None, type=None, bu self._validation_errors = None self._validation_status = None self._annotation_data = None - self._extension_missing = None self._multiple_versions_available = None + self._extension_missing = None if id is not None: self.id = id @@ -123,10 +123,10 @@ def __init__(self, id=None, name=None, description=None, uri=None, type=None, bu self.validation_status = validation_status if annotation_data is not None: self.annotation_data = annotation_data - if extension_missing is not None: - self.extension_missing = extension_missing if multiple_versions_available is not None: self.multiple_versions_available = multiple_versions_available + if extension_missing is not None: + self.extension_missing = extension_missing @property def id(self): @@ -478,50 +478,50 @@ def annotation_data(self, annotation_data): self._annotation_data = annotation_data @property - def extension_missing(self): + def multiple_versions_available(self): """ - Gets the extension_missing of this FlowRegistryClientDTO. - Whether the underlying extension is missing. + Gets the multiple_versions_available of this FlowRegistryClientDTO. + Whether the flow registry client has multiple versions available. - :return: The extension_missing of this FlowRegistryClientDTO. + :return: The multiple_versions_available of this FlowRegistryClientDTO. :rtype: bool """ - return self._extension_missing + return self._multiple_versions_available - @extension_missing.setter - def extension_missing(self, extension_missing): + @multiple_versions_available.setter + def multiple_versions_available(self, multiple_versions_available): """ - Sets the extension_missing of this FlowRegistryClientDTO. - Whether the underlying extension is missing. + Sets the multiple_versions_available of this FlowRegistryClientDTO. + Whether the flow registry client has multiple versions available. - :param extension_missing: The extension_missing of this FlowRegistryClientDTO. + :param multiple_versions_available: The multiple_versions_available of this FlowRegistryClientDTO. :type: bool """ - self._extension_missing = extension_missing + self._multiple_versions_available = multiple_versions_available @property - def multiple_versions_available(self): + def extension_missing(self): """ - Gets the multiple_versions_available of this FlowRegistryClientDTO. - Whether the flow registry client has multiple versions available. + Gets the extension_missing of this FlowRegistryClientDTO. + Whether the underlying extension is missing. - :return: The multiple_versions_available of this FlowRegistryClientDTO. + :return: The extension_missing of this FlowRegistryClientDTO. :rtype: bool """ - return self._multiple_versions_available + return self._extension_missing - @multiple_versions_available.setter - def multiple_versions_available(self, multiple_versions_available): + @extension_missing.setter + def extension_missing(self, extension_missing): """ - Sets the multiple_versions_available of this FlowRegistryClientDTO. - Whether the flow registry client has multiple versions available. + Sets the extension_missing of this FlowRegistryClientDTO. + Whether the underlying extension is missing. - :param multiple_versions_available: The multiple_versions_available of this FlowRegistryClientDTO. + :param extension_missing: The extension_missing of this FlowRegistryClientDTO. :type: bool """ - self._multiple_versions_available = multiple_versions_available + self._extension_missing = extension_missing def to_dict(self): """ diff --git a/nipyapi/nifi/models/flow_registry_client_entity.py b/nipyapi/nifi/models/flow_registry_client_entity.py index c011b9a8..cc54790f 100644 --- a/nipyapi/nifi/models/flow_registry_client_entity.py +++ b/nipyapi/nifi/models/flow_registry_client_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_registry_client_types_entity.py b/nipyapi/nifi/models/flow_registry_client_types_entity.py index 4a0ef88b..72f0010e 100644 --- a/nipyapi/nifi/models/flow_registry_client_types_entity.py +++ b/nipyapi/nifi/models/flow_registry_client_types_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_registry_clients_entity.py b/nipyapi/nifi/models/flow_registry_clients_entity.py index 86238437..74bbcf8e 100644 --- a/nipyapi/nifi/models/flow_registry_clients_entity.py +++ b/nipyapi/nifi/models/flow_registry_clients_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_registry_permissions.py b/nipyapi/nifi/models/flow_registry_permissions.py index a94186ad..7806afed 100644 --- a/nipyapi/nifi/models/flow_registry_permissions.py +++ b/nipyapi/nifi/models/flow_registry_permissions.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/flow_snippet_dto.py b/nipyapi/nifi/models/flow_snippet_dto.py index eb79ec00..2581134c 100644 --- a/nipyapi/nifi/models/flow_snippet_dto.py +++ b/nipyapi/nifi/models/flow_snippet_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/funnel_dto.py b/nipyapi/nifi/models/funnel_dto.py index db01aa55..e8dce9a2 100644 --- a/nipyapi/nifi/models/funnel_dto.py +++ b/nipyapi/nifi/models/funnel_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/funnel_entity.py b/nipyapi/nifi/models/funnel_entity.py index baf619b3..c2c63b95 100644 --- a/nipyapi/nifi/models/funnel_entity.py +++ b/nipyapi/nifi/models/funnel_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/funnels_entity.py b/nipyapi/nifi/models/funnels_entity.py index 7d3aace9..7bd86c7e 100644 --- a/nipyapi/nifi/models/funnels_entity.py +++ b/nipyapi/nifi/models/funnels_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/garbage_collection_diagnostics_dto.py b/nipyapi/nifi/models/garbage_collection_diagnostics_dto.py index babac66a..575dee74 100644 --- a/nipyapi/nifi/models/garbage_collection_diagnostics_dto.py +++ b/nipyapi/nifi/models/garbage_collection_diagnostics_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/garbage_collection_dto.py b/nipyapi/nifi/models/garbage_collection_dto.py index 3ab654aa..ed7e510a 100644 --- a/nipyapi/nifi/models/garbage_collection_dto.py +++ b/nipyapi/nifi/models/garbage_collection_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/gc_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/gc_diagnostics_snapshot_dto.py index 926a70aa..ea330a25 100644 --- a/nipyapi/nifi/models/gc_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/gc_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/history_dto.py b/nipyapi/nifi/models/history_dto.py index 7dde1253..f0d7c778 100644 --- a/nipyapi/nifi/models/history_dto.py +++ b/nipyapi/nifi/models/history_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/history_entity.py b/nipyapi/nifi/models/history_entity.py index 6a614001..27972140 100644 --- a/nipyapi/nifi/models/history_entity.py +++ b/nipyapi/nifi/models/history_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/input_ports_entity.py b/nipyapi/nifi/models/input_ports_entity.py index a9655955..ee94987f 100644 --- a/nipyapi/nifi/models/input_ports_entity.py +++ b/nipyapi/nifi/models/input_ports_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/input_stream.py b/nipyapi/nifi/models/input_stream.py index 098a3c6c..c9e9643b 100644 --- a/nipyapi/nifi/models/input_stream.py +++ b/nipyapi/nifi/models/input_stream.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/instantiate_template_request_entity.py b/nipyapi/nifi/models/instantiate_template_request_entity.py index 9b278656..85819ca1 100644 --- a/nipyapi/nifi/models/instantiate_template_request_entity.py +++ b/nipyapi/nifi/models/instantiate_template_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/jmx_metrics_result_dto.py b/nipyapi/nifi/models/jmx_metrics_result_dto.py index b6524498..8539d267 100644 --- a/nipyapi/nifi/models/jmx_metrics_result_dto.py +++ b/nipyapi/nifi/models/jmx_metrics_result_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/jmx_metrics_results_entity.py b/nipyapi/nifi/models/jmx_metrics_results_entity.py index 8ab79b7d..e27f29f0 100644 --- a/nipyapi/nifi/models/jmx_metrics_results_entity.py +++ b/nipyapi/nifi/models/jmx_metrics_results_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/jvm_controller_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/jvm_controller_diagnostics_snapshot_dto.py index 4c0d7508..7f6a7fec 100644 --- a/nipyapi/nifi/models/jvm_controller_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/jvm_controller_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/jvm_diagnostics_dto.py b/nipyapi/nifi/models/jvm_diagnostics_dto.py index 5c467c18..6b29632e 100644 --- a/nipyapi/nifi/models/jvm_diagnostics_dto.py +++ b/nipyapi/nifi/models/jvm_diagnostics_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/jvm_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/jvm_diagnostics_snapshot_dto.py index cacc5584..870c10d9 100644 --- a/nipyapi/nifi/models/jvm_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/jvm_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/jvm_flow_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/jvm_flow_diagnostics_snapshot_dto.py index b72b9770..8bec89c7 100644 --- a/nipyapi/nifi/models/jvm_flow_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/jvm_flow_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/jvm_system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/jvm_system_diagnostics_snapshot_dto.py index a7280916..6b76a59c 100644 --- a/nipyapi/nifi/models/jvm_system_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/jvm_system_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/label_dto.py b/nipyapi/nifi/models/label_dto.py index 467855a3..65b1289f 100644 --- a/nipyapi/nifi/models/label_dto.py +++ b/nipyapi/nifi/models/label_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/label_entity.py b/nipyapi/nifi/models/label_entity.py index e661cd52..39aabee4 100644 --- a/nipyapi/nifi/models/label_entity.py +++ b/nipyapi/nifi/models/label_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/labels_entity.py b/nipyapi/nifi/models/labels_entity.py index cf0c15ec..29a6266c 100644 --- a/nipyapi/nifi/models/labels_entity.py +++ b/nipyapi/nifi/models/labels_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_dto.py b/nipyapi/nifi/models/lineage_dto.py index 1ff16910..98fab81f 100644 --- a/nipyapi/nifi/models/lineage_dto.py +++ b/nipyapi/nifi/models/lineage_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_entity.py b/nipyapi/nifi/models/lineage_entity.py index d1d324fe..a1276072 100644 --- a/nipyapi/nifi/models/lineage_entity.py +++ b/nipyapi/nifi/models/lineage_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_request_dto.py b/nipyapi/nifi/models/lineage_request_dto.py index e58c010f..bc6467c9 100644 --- a/nipyapi/nifi/models/lineage_request_dto.py +++ b/nipyapi/nifi/models/lineage_request_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/lineage_results_dto.py b/nipyapi/nifi/models/lineage_results_dto.py index 1354c68d..ed8566d2 100644 --- a/nipyapi/nifi/models/lineage_results_dto.py +++ b/nipyapi/nifi/models/lineage_results_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/listing_request_dto.py b/nipyapi/nifi/models/listing_request_dto.py index 5f8e0e7d..26bc0a15 100644 --- a/nipyapi/nifi/models/listing_request_dto.py +++ b/nipyapi/nifi/models/listing_request_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -42,8 +42,8 @@ class ListingRequestDTO(object): 'state': 'str', 'queue_size': 'QueueSizeDTO', 'flow_file_summaries': 'list[FlowFileSummaryDTO]', - 'source_running': 'bool', - 'destination_running': 'bool' + 'destination_running': 'bool', + 'source_running': 'bool' } attribute_map = { @@ -58,11 +58,11 @@ class ListingRequestDTO(object): 'state': 'state', 'queue_size': 'queueSize', 'flow_file_summaries': 'flowFileSummaries', - 'source_running': 'sourceRunning', - 'destination_running': 'destinationRunning' + 'destination_running': 'destinationRunning', + 'source_running': 'sourceRunning' } - def __init__(self, id=None, uri=None, submission_time=None, last_updated=None, percent_completed=None, finished=None, failure_reason=None, max_results=None, state=None, queue_size=None, flow_file_summaries=None, source_running=None, destination_running=None): + def __init__(self, id=None, uri=None, submission_time=None, last_updated=None, percent_completed=None, finished=None, failure_reason=None, max_results=None, state=None, queue_size=None, flow_file_summaries=None, destination_running=None, source_running=None): """ ListingRequestDTO - a model defined in Swagger """ @@ -78,8 +78,8 @@ def __init__(self, id=None, uri=None, submission_time=None, last_updated=None, p self._state = None self._queue_size = None self._flow_file_summaries = None - self._source_running = None self._destination_running = None + self._source_running = None if id is not None: self.id = id @@ -103,10 +103,10 @@ def __init__(self, id=None, uri=None, submission_time=None, last_updated=None, p self.queue_size = queue_size if flow_file_summaries is not None: self.flow_file_summaries = flow_file_summaries - if source_running is not None: - self.source_running = source_running if destination_running is not None: self.destination_running = destination_running + if source_running is not None: + self.source_running = source_running @property def id(self): @@ -362,50 +362,50 @@ def flow_file_summaries(self, flow_file_summaries): self._flow_file_summaries = flow_file_summaries @property - def source_running(self): + def destination_running(self): """ - Gets the source_running of this ListingRequestDTO. - Whether the source of the connection is running + Gets the destination_running of this ListingRequestDTO. + Whether the destination of the connection is running - :return: The source_running of this ListingRequestDTO. + :return: The destination_running of this ListingRequestDTO. :rtype: bool """ - return self._source_running + return self._destination_running - @source_running.setter - def source_running(self, source_running): + @destination_running.setter + def destination_running(self, destination_running): """ - Sets the source_running of this ListingRequestDTO. - Whether the source of the connection is running + Sets the destination_running of this ListingRequestDTO. + Whether the destination of the connection is running - :param source_running: The source_running of this ListingRequestDTO. + :param destination_running: The destination_running of this ListingRequestDTO. :type: bool """ - self._source_running = source_running + self._destination_running = destination_running @property - def destination_running(self): + def source_running(self): """ - Gets the destination_running of this ListingRequestDTO. - Whether the destination of the connection is running + Gets the source_running of this ListingRequestDTO. + Whether the source of the connection is running - :return: The destination_running of this ListingRequestDTO. + :return: The source_running of this ListingRequestDTO. :rtype: bool """ - return self._destination_running + return self._source_running - @destination_running.setter - def destination_running(self, destination_running): + @source_running.setter + def source_running(self, source_running): """ - Sets the destination_running of this ListingRequestDTO. - Whether the destination of the connection is running + Sets the source_running of this ListingRequestDTO. + Whether the source of the connection is running - :param destination_running: The destination_running of this ListingRequestDTO. + :param source_running: The source_running of this ListingRequestDTO. :type: bool """ - self._destination_running = destination_running + self._source_running = source_running def to_dict(self): """ diff --git a/nipyapi/nifi/models/listing_request_entity.py b/nipyapi/nifi/models/listing_request_entity.py index 7832f768..45a0e272 100644 --- a/nipyapi/nifi/models/listing_request_entity.py +++ b/nipyapi/nifi/models/listing_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/local_queue_partition_dto.py b/nipyapi/nifi/models/local_queue_partition_dto.py index f77ab42a..cb7f8bce 100644 --- a/nipyapi/nifi/models/local_queue_partition_dto.py +++ b/nipyapi/nifi/models/local_queue_partition_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py b/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py index f2de64cc..a1cd0e76 100644 --- a/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py +++ b/nipyapi/nifi/models/node_connection_statistics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_connection_status_snapshot_dto.py b/nipyapi/nifi/models/node_connection_status_snapshot_dto.py index 16dbe17d..fbe151b2 100644 --- a/nipyapi/nifi/models/node_connection_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_connection_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_counters_snapshot_dto.py b/nipyapi/nifi/models/node_counters_snapshot_dto.py index 293bdacd..d5f87dc8 100644 --- a/nipyapi/nifi/models/node_counters_snapshot_dto.py +++ b/nipyapi/nifi/models/node_counters_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_dto.py b/nipyapi/nifi/models/node_dto.py index 348e37f7..70c0dc5c 100644 --- a/nipyapi/nifi/models/node_dto.py +++ b/nipyapi/nifi/models/node_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_entity.py b/nipyapi/nifi/models/node_entity.py index 93582967..9a8bd7eb 100644 --- a/nipyapi/nifi/models/node_entity.py +++ b/nipyapi/nifi/models/node_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_event_dto.py b/nipyapi/nifi/models/node_event_dto.py index 2335bde2..39e9a932 100644 --- a/nipyapi/nifi/models/node_event_dto.py +++ b/nipyapi/nifi/models/node_event_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_identifier.py b/nipyapi/nifi/models/node_identifier.py index 5c5646ff..f7a8c893 100644 --- a/nipyapi/nifi/models/node_identifier.py +++ b/nipyapi/nifi/models/node_identifier.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_jvm_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/node_jvm_diagnostics_snapshot_dto.py index 989a78f5..8d5659e5 100644 --- a/nipyapi/nifi/models/node_jvm_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/node_jvm_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_port_status_snapshot_dto.py b/nipyapi/nifi/models/node_port_status_snapshot_dto.py index 0ac0190f..dc842875 100644 --- a/nipyapi/nifi/models/node_port_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_port_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py b/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py index 33576c30..3e2cfb7f 100644 --- a/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_processor_status_snapshot_dto.py b/nipyapi/nifi/models/node_processor_status_snapshot_dto.py index 396badf2..d4067aa4 100644 --- a/nipyapi/nifi/models/node_processor_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_processor_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py b/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py index 9b93a1c7..36a220f1 100644 --- a/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/node_remote_process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_replay_last_event_snapshot_dto.py b/nipyapi/nifi/models/node_replay_last_event_snapshot_dto.py index 1df11ac2..40f564c0 100644 --- a/nipyapi/nifi/models/node_replay_last_event_snapshot_dto.py +++ b/nipyapi/nifi/models/node_replay_last_event_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_response.py b/nipyapi/nifi/models/node_response.py index 7e18c0b0..191dde2a 100644 --- a/nipyapi/nifi/models/node_response.py +++ b/nipyapi/nifi/models/node_response.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -40,9 +40,9 @@ class NodeResponse(object): 'request_id': 'str', 'input_stream': 'InputStream', 'client_response': 'Response', + 'status': 'int', 'is2xx': 'bool', - 'is5xx': 'bool', - 'status': 'int' + 'is5xx': 'bool' } attribute_map = { @@ -55,12 +55,12 @@ class NodeResponse(object): 'request_id': 'requestId', 'input_stream': 'inputStream', 'client_response': 'clientResponse', + 'status': 'status', 'is2xx': 'is2xx', - 'is5xx': 'is5xx', - 'status': 'status' + 'is5xx': 'is5xx' } - def __init__(self, http_method=None, request_uri=None, response=None, node_id=None, throwable=None, updated_entity=None, request_id=None, input_stream=None, client_response=None, is2xx=None, is5xx=None, status=None): + def __init__(self, http_method=None, request_uri=None, response=None, node_id=None, throwable=None, updated_entity=None, request_id=None, input_stream=None, client_response=None, status=None, is2xx=None, is5xx=None): """ NodeResponse - a model defined in Swagger """ @@ -74,9 +74,9 @@ def __init__(self, http_method=None, request_uri=None, response=None, node_id=No self._request_id = None self._input_stream = None self._client_response = None + self._status = None self._is2xx = None self._is5xx = None - self._status = None if http_method is not None: self.http_method = http_method @@ -96,12 +96,12 @@ def __init__(self, http_method=None, request_uri=None, response=None, node_id=No self.input_stream = input_stream if client_response is not None: self.client_response = client_response + if status is not None: + self.status = status if is2xx is not None: self.is2xx = is2xx if is5xx is not None: self.is5xx = is5xx - if status is not None: - self.status = status @property def http_method(self): @@ -292,6 +292,27 @@ def client_response(self, client_response): self._client_response = client_response + @property + def status(self): + """ + Gets the status of this NodeResponse. + + :return: The status of this NodeResponse. + :rtype: int + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this NodeResponse. + + :param status: The status of this NodeResponse. + :type: int + """ + + self._status = status + @property def is2xx(self): """ @@ -334,27 +355,6 @@ def is5xx(self, is5xx): self._is5xx = is5xx - @property - def status(self): - """ - Gets the status of this NodeResponse. - - :return: The status of this NodeResponse. - :rtype: int - """ - return self._status - - @status.setter - def status(self, status): - """ - Sets the status of this NodeResponse. - - :param status: The status of this NodeResponse. - :type: int - """ - - self._status = status - def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/node_search_result_dto.py b/nipyapi/nifi/models/node_search_result_dto.py index 1956f42b..ef79ebc1 100644 --- a/nipyapi/nifi/models/node_search_result_dto.py +++ b/nipyapi/nifi/models/node_search_result_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_status_snapshots_dto.py b/nipyapi/nifi/models/node_status_snapshots_dto.py index 1ca7d8df..99bf83d8 100644 --- a/nipyapi/nifi/models/node_status_snapshots_dto.py +++ b/nipyapi/nifi/models/node_status_snapshots_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py index 01562065..43ad1f40 100644 --- a/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/node_system_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/output_ports_entity.py b/nipyapi/nifi/models/output_ports_entity.py index 10ebe305..b4e63406 100644 --- a/nipyapi/nifi/models/output_ports_entity.py +++ b/nipyapi/nifi/models/output_ports_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_dto.py b/nipyapi/nifi/models/parameter_context_dto.py index bd262ef0..a973f568 100644 --- a/nipyapi/nifi/models/parameter_context_dto.py +++ b/nipyapi/nifi/models/parameter_context_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_entity.py b/nipyapi/nifi/models/parameter_context_entity.py index 9abcee25..94056348 100644 --- a/nipyapi/nifi/models/parameter_context_entity.py +++ b/nipyapi/nifi/models/parameter_context_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_reference_dto.py b/nipyapi/nifi/models/parameter_context_reference_dto.py index 78283f4e..529c98ba 100644 --- a/nipyapi/nifi/models/parameter_context_reference_dto.py +++ b/nipyapi/nifi/models/parameter_context_reference_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_reference_entity.py b/nipyapi/nifi/models/parameter_context_reference_entity.py index c610acdf..915a2f6c 100644 --- a/nipyapi/nifi/models/parameter_context_reference_entity.py +++ b/nipyapi/nifi/models/parameter_context_reference_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_update_entity.py b/nipyapi/nifi/models/parameter_context_update_entity.py index be55b138..a6003511 100644 --- a/nipyapi/nifi/models/parameter_context_update_entity.py +++ b/nipyapi/nifi/models/parameter_context_update_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_update_request_dto.py b/nipyapi/nifi/models/parameter_context_update_request_dto.py index aad798de..355bbd7c 100644 --- a/nipyapi/nifi/models/parameter_context_update_request_dto.py +++ b/nipyapi/nifi/models/parameter_context_update_request_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_update_request_entity.py b/nipyapi/nifi/models/parameter_context_update_request_entity.py index 64566781..02ad23d3 100644 --- a/nipyapi/nifi/models/parameter_context_update_request_entity.py +++ b/nipyapi/nifi/models/parameter_context_update_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_update_step_dto.py b/nipyapi/nifi/models/parameter_context_update_step_dto.py index a1689430..9475cff4 100644 --- a/nipyapi/nifi/models/parameter_context_update_step_dto.py +++ b/nipyapi/nifi/models/parameter_context_update_step_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_validation_request_dto.py b/nipyapi/nifi/models/parameter_context_validation_request_dto.py index 4d6b2d95..08aa77c5 100644 --- a/nipyapi/nifi/models/parameter_context_validation_request_dto.py +++ b/nipyapi/nifi/models/parameter_context_validation_request_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_validation_request_entity.py b/nipyapi/nifi/models/parameter_context_validation_request_entity.py index 190ff9a9..07de609a 100644 --- a/nipyapi/nifi/models/parameter_context_validation_request_entity.py +++ b/nipyapi/nifi/models/parameter_context_validation_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_context_validation_step_dto.py b/nipyapi/nifi/models/parameter_context_validation_step_dto.py index 40b4d190..5137150f 100644 --- a/nipyapi/nifi/models/parameter_context_validation_step_dto.py +++ b/nipyapi/nifi/models/parameter_context_validation_step_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_contexts_entity.py b/nipyapi/nifi/models/parameter_contexts_entity.py index ea76bd7f..1a9d1ed4 100644 --- a/nipyapi/nifi/models/parameter_contexts_entity.py +++ b/nipyapi/nifi/models/parameter_contexts_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_dto.py b/nipyapi/nifi/models/parameter_dto.py index ed2e7ef8..cd50bbe0 100644 --- a/nipyapi/nifi/models/parameter_dto.py +++ b/nipyapi/nifi/models/parameter_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_entity.py b/nipyapi/nifi/models/parameter_entity.py index 5de873d4..720b675a 100644 --- a/nipyapi/nifi/models/parameter_entity.py +++ b/nipyapi/nifi/models/parameter_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_group_configuration_entity.py b/nipyapi/nifi/models/parameter_group_configuration_entity.py index 0bc603b8..35f58757 100644 --- a/nipyapi/nifi/models/parameter_group_configuration_entity.py +++ b/nipyapi/nifi/models/parameter_group_configuration_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_provider_apply_parameters_request_dto.py b/nipyapi/nifi/models/parameter_provider_apply_parameters_request_dto.py index 8286de5c..48074646 100644 --- a/nipyapi/nifi/models/parameter_provider_apply_parameters_request_dto.py +++ b/nipyapi/nifi/models/parameter_provider_apply_parameters_request_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_provider_apply_parameters_request_entity.py b/nipyapi/nifi/models/parameter_provider_apply_parameters_request_entity.py index a5524cdb..de2a3c48 100644 --- a/nipyapi/nifi/models/parameter_provider_apply_parameters_request_entity.py +++ b/nipyapi/nifi/models/parameter_provider_apply_parameters_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_provider_apply_parameters_update_step_dto.py b/nipyapi/nifi/models/parameter_provider_apply_parameters_update_step_dto.py index 5dc8a732..fb61263b 100644 --- a/nipyapi/nifi/models/parameter_provider_apply_parameters_update_step_dto.py +++ b/nipyapi/nifi/models/parameter_provider_apply_parameters_update_step_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_provider_configuration_dto.py b/nipyapi/nifi/models/parameter_provider_configuration_dto.py index a0588649..b4726c38 100644 --- a/nipyapi/nifi/models/parameter_provider_configuration_dto.py +++ b/nipyapi/nifi/models/parameter_provider_configuration_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_provider_configuration_entity.py b/nipyapi/nifi/models/parameter_provider_configuration_entity.py index 22f7ac37..6a1ef6ed 100644 --- a/nipyapi/nifi/models/parameter_provider_configuration_entity.py +++ b/nipyapi/nifi/models/parameter_provider_configuration_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_provider_dto.py b/nipyapi/nifi/models/parameter_provider_dto.py index 2959bd3c..57f52e8e 100644 --- a/nipyapi/nifi/models/parameter_provider_dto.py +++ b/nipyapi/nifi/models/parameter_provider_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_provider_entity.py b/nipyapi/nifi/models/parameter_provider_entity.py index a49264a5..4cafd386 100644 --- a/nipyapi/nifi/models/parameter_provider_entity.py +++ b/nipyapi/nifi/models/parameter_provider_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_provider_parameter_application_entity.py b/nipyapi/nifi/models/parameter_provider_parameter_application_entity.py index 00e09b2c..db3d330d 100644 --- a/nipyapi/nifi/models/parameter_provider_parameter_application_entity.py +++ b/nipyapi/nifi/models/parameter_provider_parameter_application_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_provider_parameter_fetch_entity.py b/nipyapi/nifi/models/parameter_provider_parameter_fetch_entity.py index f2116a1b..83596be3 100644 --- a/nipyapi/nifi/models/parameter_provider_parameter_fetch_entity.py +++ b/nipyapi/nifi/models/parameter_provider_parameter_fetch_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_provider_reference.py b/nipyapi/nifi/models/parameter_provider_reference.py index 3a0fbbe7..002a17a4 100644 --- a/nipyapi/nifi/models/parameter_provider_reference.py +++ b/nipyapi/nifi/models/parameter_provider_reference.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_provider_referencing_component_dto.py b/nipyapi/nifi/models/parameter_provider_referencing_component_dto.py index 56237a59..a6e57982 100644 --- a/nipyapi/nifi/models/parameter_provider_referencing_component_dto.py +++ b/nipyapi/nifi/models/parameter_provider_referencing_component_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_provider_referencing_component_entity.py b/nipyapi/nifi/models/parameter_provider_referencing_component_entity.py index e47bd350..e6fe3440 100644 --- a/nipyapi/nifi/models/parameter_provider_referencing_component_entity.py +++ b/nipyapi/nifi/models/parameter_provider_referencing_component_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_provider_referencing_components_entity.py b/nipyapi/nifi/models/parameter_provider_referencing_components_entity.py index 33110155..6e224b04 100644 --- a/nipyapi/nifi/models/parameter_provider_referencing_components_entity.py +++ b/nipyapi/nifi/models/parameter_provider_referencing_components_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_provider_types_entity.py b/nipyapi/nifi/models/parameter_provider_types_entity.py index 2ec4775b..cb1bf054 100644 --- a/nipyapi/nifi/models/parameter_provider_types_entity.py +++ b/nipyapi/nifi/models/parameter_provider_types_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_providers_entity.py b/nipyapi/nifi/models/parameter_providers_entity.py index de5a5099..bd5d9a2a 100644 --- a/nipyapi/nifi/models/parameter_providers_entity.py +++ b/nipyapi/nifi/models/parameter_providers_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/parameter_status_dto.py b/nipyapi/nifi/models/parameter_status_dto.py index d1394ead..a2e0b1b2 100644 --- a/nipyapi/nifi/models/parameter_status_dto.py +++ b/nipyapi/nifi/models/parameter_status_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/peer_dto.py b/nipyapi/nifi/models/peer_dto.py index 90e8c02f..6d887ffd 100644 --- a/nipyapi/nifi/models/peer_dto.py +++ b/nipyapi/nifi/models/peer_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/peers_entity.py b/nipyapi/nifi/models/peers_entity.py index 022f89ee..a988fb58 100644 --- a/nipyapi/nifi/models/peers_entity.py +++ b/nipyapi/nifi/models/peers_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/permissions_dto.py b/nipyapi/nifi/models/permissions_dto.py index c1354ffd..9ae3088d 100644 --- a/nipyapi/nifi/models/permissions_dto.py +++ b/nipyapi/nifi/models/permissions_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_dto.py b/nipyapi/nifi/models/port_dto.py index 6c173513..87e6dcd5 100644 --- a/nipyapi/nifi/models/port_dto.py +++ b/nipyapi/nifi/models/port_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_entity.py b/nipyapi/nifi/models/port_entity.py index d8a0f914..e117be6d 100644 --- a/nipyapi/nifi/models/port_entity.py +++ b/nipyapi/nifi/models/port_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_run_status_entity.py b/nipyapi/nifi/models/port_run_status_entity.py index 5ed47a98..663f9dd0 100644 --- a/nipyapi/nifi/models/port_run_status_entity.py +++ b/nipyapi/nifi/models/port_run_status_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_dto.py b/nipyapi/nifi/models/port_status_dto.py index af0b4be7..ca780f4b 100644 --- a/nipyapi/nifi/models/port_status_dto.py +++ b/nipyapi/nifi/models/port_status_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_entity.py b/nipyapi/nifi/models/port_status_entity.py index f78ef37c..2f522125 100644 --- a/nipyapi/nifi/models/port_status_entity.py +++ b/nipyapi/nifi/models/port_status_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_snapshot_dto.py b/nipyapi/nifi/models/port_status_snapshot_dto.py index 6441689d..691f6bde 100644 --- a/nipyapi/nifi/models/port_status_snapshot_dto.py +++ b/nipyapi/nifi/models/port_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/port_status_snapshot_entity.py b/nipyapi/nifi/models/port_status_snapshot_entity.py index 52509a73..1e1c238e 100644 --- a/nipyapi/nifi/models/port_status_snapshot_entity.py +++ b/nipyapi/nifi/models/port_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/position.py b/nipyapi/nifi/models/position.py index 4f75d751..cc65b6ca 100644 --- a/nipyapi/nifi/models/position.py +++ b/nipyapi/nifi/models/position.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/position_dto.py b/nipyapi/nifi/models/position_dto.py index 33b8c021..d86a20d3 100644 --- a/nipyapi/nifi/models/position_dto.py +++ b/nipyapi/nifi/models/position_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/previous_value_dto.py b/nipyapi/nifi/models/previous_value_dto.py index d9195776..e886c443 100644 --- a/nipyapi/nifi/models/previous_value_dto.py +++ b/nipyapi/nifi/models/previous_value_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/prioritizer_types_entity.py b/nipyapi/nifi/models/prioritizer_types_entity.py index 1e54a373..7586c32e 100644 --- a/nipyapi/nifi/models/prioritizer_types_entity.py +++ b/nipyapi/nifi/models/prioritizer_types_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_dto.py b/nipyapi/nifi/models/process_group_dto.py index d9a666d9..cfe8d823 100644 --- a/nipyapi/nifi/models/process_group_dto.py +++ b/nipyapi/nifi/models/process_group_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_entity.py b/nipyapi/nifi/models/process_group_entity.py index 1d46f49e..46b418bf 100644 --- a/nipyapi/nifi/models/process_group_entity.py +++ b/nipyapi/nifi/models/process_group_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -58,6 +58,7 @@ class ProcessGroupEntity(object): 'public_input_port_count': 'int', 'public_output_port_count': 'int', 'parameter_context': 'ParameterContextReferenceEntity', + 'process_group_update_strategy': 'str', 'input_port_count': 'int', 'output_port_count': 'int' } @@ -90,11 +91,12 @@ class ProcessGroupEntity(object): 'public_input_port_count': 'publicInputPortCount', 'public_output_port_count': 'publicOutputPortCount', 'parameter_context': 'parameterContext', + 'process_group_update_strategy': 'processGroupUpdateStrategy', 'input_port_count': 'inputPortCount', 'output_port_count': 'outputPortCount' } - def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, status=None, versioned_flow_snapshot=None, running_count=None, stopped_count=None, invalid_count=None, disabled_count=None, active_remote_port_count=None, inactive_remote_port_count=None, versioned_flow_state=None, up_to_date_count=None, locally_modified_count=None, stale_count=None, locally_modified_and_stale_count=None, sync_failure_count=None, local_input_port_count=None, local_output_port_count=None, public_input_port_count=None, public_output_port_count=None, parameter_context=None, input_port_count=None, output_port_count=None): + def __init__(self, revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, status=None, versioned_flow_snapshot=None, running_count=None, stopped_count=None, invalid_count=None, disabled_count=None, active_remote_port_count=None, inactive_remote_port_count=None, versioned_flow_state=None, up_to_date_count=None, locally_modified_count=None, stale_count=None, locally_modified_and_stale_count=None, sync_failure_count=None, local_input_port_count=None, local_output_port_count=None, public_input_port_count=None, public_output_port_count=None, parameter_context=None, process_group_update_strategy=None, input_port_count=None, output_port_count=None): """ ProcessGroupEntity - a model defined in Swagger """ @@ -126,6 +128,7 @@ def __init__(self, revision=None, id=None, uri=None, position=None, permissions= self._public_input_port_count = None self._public_output_port_count = None self._parameter_context = None + self._process_group_update_strategy = None self._input_port_count = None self._output_port_count = None @@ -183,6 +186,8 @@ def __init__(self, revision=None, id=None, uri=None, position=None, permissions= self.public_output_port_count = public_output_port_count if parameter_context is not None: self.parameter_context = parameter_context + if process_group_update_strategy is not None: + self.process_group_update_strategy = process_group_update_strategy if input_port_count is not None: self.input_port_count = input_port_count if output_port_count is not None: @@ -813,6 +818,35 @@ def parameter_context(self, parameter_context): self._parameter_context = parameter_context + @property + def process_group_update_strategy(self): + """ + Gets the process_group_update_strategy of this ProcessGroupEntity. + Determines the process group update strategy + + :return: The process_group_update_strategy of this ProcessGroupEntity. + :rtype: str + """ + return self._process_group_update_strategy + + @process_group_update_strategy.setter + def process_group_update_strategy(self, process_group_update_strategy): + """ + Sets the process_group_update_strategy of this ProcessGroupEntity. + Determines the process group update strategy + + :param process_group_update_strategy: The process_group_update_strategy of this ProcessGroupEntity. + :type: str + """ + allowed_values = ["DIRECT_CHILDREN", "ALL_DESCENDANTS"] + if process_group_update_strategy not in allowed_values: + raise ValueError( + "Invalid value for `process_group_update_strategy` ({0}), must be one of {1}" + .format(process_group_update_strategy, allowed_values) + ) + + self._process_group_update_strategy = process_group_update_strategy + @property def input_port_count(self): """ diff --git a/nipyapi/nifi/models/process_group_flow_dto.py b/nipyapi/nifi/models/process_group_flow_dto.py index a1c9cf38..c36abc4c 100644 --- a/nipyapi/nifi/models/process_group_flow_dto.py +++ b/nipyapi/nifi/models/process_group_flow_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_flow_entity.py b/nipyapi/nifi/models/process_group_flow_entity.py index ebcbf071..43680027 100644 --- a/nipyapi/nifi/models/process_group_flow_entity.py +++ b/nipyapi/nifi/models/process_group_flow_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_import_entity.py b/nipyapi/nifi/models/process_group_import_entity.py index 6c65d46d..dde22d82 100644 --- a/nipyapi/nifi/models/process_group_import_entity.py +++ b/nipyapi/nifi/models/process_group_import_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_name_dto.py b/nipyapi/nifi/models/process_group_name_dto.py index 1025ec0c..93a0ff1e 100644 --- a/nipyapi/nifi/models/process_group_name_dto.py +++ b/nipyapi/nifi/models/process_group_name_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_replace_request_dto.py b/nipyapi/nifi/models/process_group_replace_request_dto.py index d769ebed..5194dafd 100644 --- a/nipyapi/nifi/models/process_group_replace_request_dto.py +++ b/nipyapi/nifi/models/process_group_replace_request_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_replace_request_entity.py b/nipyapi/nifi/models/process_group_replace_request_entity.py index df2a0416..64e0550d 100644 --- a/nipyapi/nifi/models/process_group_replace_request_entity.py +++ b/nipyapi/nifi/models/process_group_replace_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_dto.py b/nipyapi/nifi/models/process_group_status_dto.py index 69cbd9db..1ebd7c3f 100644 --- a/nipyapi/nifi/models/process_group_status_dto.py +++ b/nipyapi/nifi/models/process_group_status_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_entity.py b/nipyapi/nifi/models/process_group_status_entity.py index c0715254..931b5cbd 100644 --- a/nipyapi/nifi/models/process_group_status_entity.py +++ b/nipyapi/nifi/models/process_group_status_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_snapshot_dto.py b/nipyapi/nifi/models/process_group_status_snapshot_dto.py index ab2b4f8e..8502029f 100644 --- a/nipyapi/nifi/models/process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_group_status_snapshot_entity.py b/nipyapi/nifi/models/process_group_status_snapshot_entity.py index 47085d7d..09a30cac 100644 --- a/nipyapi/nifi/models/process_group_status_snapshot_entity.py +++ b/nipyapi/nifi/models/process_group_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/process_groups_entity.py b/nipyapi/nifi/models/process_groups_entity.py index a082f7ab..a9216ba5 100644 --- a/nipyapi/nifi/models/process_groups_entity.py +++ b/nipyapi/nifi/models/process_groups_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_config_dto.py b/nipyapi/nifi/models/processor_config_dto.py index d43fd732..6c16a8ff 100644 --- a/nipyapi/nifi/models/processor_config_dto.py +++ b/nipyapi/nifi/models/processor_config_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_definition.py b/nipyapi/nifi/models/processor_definition.py index 404222fa..12b71ec3 100644 --- a/nipyapi/nifi/models/processor_definition.py +++ b/nipyapi/nifi/models/processor_definition.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_diagnostics_dto.py b/nipyapi/nifi/models/processor_diagnostics_dto.py index 02b9eea9..f1d55b36 100644 --- a/nipyapi/nifi/models/processor_diagnostics_dto.py +++ b/nipyapi/nifi/models/processor_diagnostics_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_diagnostics_entity.py b/nipyapi/nifi/models/processor_diagnostics_entity.py index d1eea7f4..18646321 100644 --- a/nipyapi/nifi/models/processor_diagnostics_entity.py +++ b/nipyapi/nifi/models/processor_diagnostics_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_dto.py b/nipyapi/nifi/models/processor_dto.py index 056a31d8..9bbfbf2b 100644 --- a/nipyapi/nifi/models/processor_dto.py +++ b/nipyapi/nifi/models/processor_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_entity.py b/nipyapi/nifi/models/processor_entity.py index 0adc6df9..7ea0a670 100644 --- a/nipyapi/nifi/models/processor_entity.py +++ b/nipyapi/nifi/models/processor_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_run_status_details_dto.py b/nipyapi/nifi/models/processor_run_status_details_dto.py index 5c48486a..89e8d8c7 100644 --- a/nipyapi/nifi/models/processor_run_status_details_dto.py +++ b/nipyapi/nifi/models/processor_run_status_details_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_run_status_details_entity.py b/nipyapi/nifi/models/processor_run_status_details_entity.py index 4f82d492..4b0861ce 100644 --- a/nipyapi/nifi/models/processor_run_status_details_entity.py +++ b/nipyapi/nifi/models/processor_run_status_details_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_run_status_entity.py b/nipyapi/nifi/models/processor_run_status_entity.py index 893c23ee..16e04274 100644 --- a/nipyapi/nifi/models/processor_run_status_entity.py +++ b/nipyapi/nifi/models/processor_run_status_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_dto.py b/nipyapi/nifi/models/processor_status_dto.py index e9c4c00d..e23ab412 100644 --- a/nipyapi/nifi/models/processor_status_dto.py +++ b/nipyapi/nifi/models/processor_status_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_entity.py b/nipyapi/nifi/models/processor_status_entity.py index 95ce237a..b23aadfd 100644 --- a/nipyapi/nifi/models/processor_status_entity.py +++ b/nipyapi/nifi/models/processor_status_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_snapshot_dto.py b/nipyapi/nifi/models/processor_status_snapshot_dto.py index c4bfe3de..5ddc41bf 100644 --- a/nipyapi/nifi/models/processor_status_snapshot_dto.py +++ b/nipyapi/nifi/models/processor_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_status_snapshot_entity.py b/nipyapi/nifi/models/processor_status_snapshot_entity.py index 646ab5e4..5c9062db 100644 --- a/nipyapi/nifi/models/processor_status_snapshot_entity.py +++ b/nipyapi/nifi/models/processor_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processor_types_entity.py b/nipyapi/nifi/models/processor_types_entity.py index 2856cde9..4ccbb5bc 100644 --- a/nipyapi/nifi/models/processor_types_entity.py +++ b/nipyapi/nifi/models/processor_types_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processors_entity.py b/nipyapi/nifi/models/processors_entity.py index c9959346..42a74499 100644 --- a/nipyapi/nifi/models/processors_entity.py +++ b/nipyapi/nifi/models/processors_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/processors_run_status_details_entity.py b/nipyapi/nifi/models/processors_run_status_details_entity.py index 130e9136..24554707 100644 --- a/nipyapi/nifi/models/processors_run_status_details_entity.py +++ b/nipyapi/nifi/models/processors_run_status_details_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_allowable_value.py b/nipyapi/nifi/models/property_allowable_value.py index d2420fb3..fede5330 100644 --- a/nipyapi/nifi/models/property_allowable_value.py +++ b/nipyapi/nifi/models/property_allowable_value.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_dependency.py b/nipyapi/nifi/models/property_dependency.py index 66b0b9a6..e8ac27f4 100644 --- a/nipyapi/nifi/models/property_dependency.py +++ b/nipyapi/nifi/models/property_dependency.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_dependency_dto.py b/nipyapi/nifi/models/property_dependency_dto.py index 36775fce..23a441c4 100644 --- a/nipyapi/nifi/models/property_dependency_dto.py +++ b/nipyapi/nifi/models/property_dependency_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_descriptor.py b/nipyapi/nifi/models/property_descriptor.py index 28c12097..13bc5ade 100644 --- a/nipyapi/nifi/models/property_descriptor.py +++ b/nipyapi/nifi/models/property_descriptor.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_descriptor_dto.py b/nipyapi/nifi/models/property_descriptor_dto.py index 0519bd00..ccf1fddb 100644 --- a/nipyapi/nifi/models/property_descriptor_dto.py +++ b/nipyapi/nifi/models/property_descriptor_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_descriptor_entity.py b/nipyapi/nifi/models/property_descriptor_entity.py index bf2678ac..8e624284 100644 --- a/nipyapi/nifi/models/property_descriptor_entity.py +++ b/nipyapi/nifi/models/property_descriptor_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_history_dto.py b/nipyapi/nifi/models/property_history_dto.py index c615c6eb..18c38023 100644 --- a/nipyapi/nifi/models/property_history_dto.py +++ b/nipyapi/nifi/models/property_history_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/property_resource_definition.py b/nipyapi/nifi/models/property_resource_definition.py index 107a3753..495b7549 100644 --- a/nipyapi/nifi/models/property_resource_definition.py +++ b/nipyapi/nifi/models/property_resource_definition.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_dto.py b/nipyapi/nifi/models/provenance_dto.py index 3165c536..60c4c49a 100644 --- a/nipyapi/nifi/models/provenance_dto.py +++ b/nipyapi/nifi/models/provenance_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_entity.py b/nipyapi/nifi/models/provenance_entity.py index bd5d142a..a9b08c93 100644 --- a/nipyapi/nifi/models/provenance_entity.py +++ b/nipyapi/nifi/models/provenance_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_event_dto.py b/nipyapi/nifi/models/provenance_event_dto.py index 98e664b6..381c2fca 100644 --- a/nipyapi/nifi/models/provenance_event_dto.py +++ b/nipyapi/nifi/models/provenance_event_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_event_entity.py b/nipyapi/nifi/models/provenance_event_entity.py index 4b6ba1d5..38d62e59 100644 --- a/nipyapi/nifi/models/provenance_event_entity.py +++ b/nipyapi/nifi/models/provenance_event_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_link_dto.py b/nipyapi/nifi/models/provenance_link_dto.py index 38b99f1e..d5924ca7 100644 --- a/nipyapi/nifi/models/provenance_link_dto.py +++ b/nipyapi/nifi/models/provenance_link_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_node_dto.py b/nipyapi/nifi/models/provenance_node_dto.py index 2365bff8..2e225c73 100644 --- a/nipyapi/nifi/models/provenance_node_dto.py +++ b/nipyapi/nifi/models/provenance_node_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_options_dto.py b/nipyapi/nifi/models/provenance_options_dto.py index 20bdb4ce..8026ea3e 100644 --- a/nipyapi/nifi/models/provenance_options_dto.py +++ b/nipyapi/nifi/models/provenance_options_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_options_entity.py b/nipyapi/nifi/models/provenance_options_entity.py index b97aecfd..815056c9 100644 --- a/nipyapi/nifi/models/provenance_options_entity.py +++ b/nipyapi/nifi/models/provenance_options_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_request_dto.py b/nipyapi/nifi/models/provenance_request_dto.py index 6003a147..220a3048 100644 --- a/nipyapi/nifi/models/provenance_request_dto.py +++ b/nipyapi/nifi/models/provenance_request_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_results_dto.py b/nipyapi/nifi/models/provenance_results_dto.py index 15f26df9..8194cbad 100644 --- a/nipyapi/nifi/models/provenance_results_dto.py +++ b/nipyapi/nifi/models/provenance_results_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_search_value_dto.py b/nipyapi/nifi/models/provenance_search_value_dto.py index 22a26f1d..fd2c6ff1 100644 --- a/nipyapi/nifi/models/provenance_search_value_dto.py +++ b/nipyapi/nifi/models/provenance_search_value_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/provenance_searchable_field_dto.py b/nipyapi/nifi/models/provenance_searchable_field_dto.py index 328e4354..11b4f324 100644 --- a/nipyapi/nifi/models/provenance_searchable_field_dto.py +++ b/nipyapi/nifi/models/provenance_searchable_field_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/queue_size_dto.py b/nipyapi/nifi/models/queue_size_dto.py index 1c8b5c38..fd415bc4 100644 --- a/nipyapi/nifi/models/queue_size_dto.py +++ b/nipyapi/nifi/models/queue_size_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registered_flow.py b/nipyapi/nifi/models/registered_flow.py index a316bf6d..381a07c0 100644 --- a/nipyapi/nifi/models/registered_flow.py +++ b/nipyapi/nifi/models/registered_flow.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registered_flow_snapshot.py b/nipyapi/nifi/models/registered_flow_snapshot.py index 6f24d1ae..d1ceb805 100644 --- a/nipyapi/nifi/models/registered_flow_snapshot.py +++ b/nipyapi/nifi/models/registered_flow_snapshot.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registered_flow_snapshot_metadata.py b/nipyapi/nifi/models/registered_flow_snapshot_metadata.py index 904c23bd..9d77aebd 100644 --- a/nipyapi/nifi/models/registered_flow_snapshot_metadata.py +++ b/nipyapi/nifi/models/registered_flow_snapshot_metadata.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/registered_flow_version_info.py b/nipyapi/nifi/models/registered_flow_version_info.py index 74408ebe..26634f41 100644 --- a/nipyapi/nifi/models/registered_flow_version_info.py +++ b/nipyapi/nifi/models/registered_flow_version_info.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/relationship.py b/nipyapi/nifi/models/relationship.py index 99e47af4..057e0c23 100644 --- a/nipyapi/nifi/models/relationship.py +++ b/nipyapi/nifi/models/relationship.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/relationship_dto.py b/nipyapi/nifi/models/relationship_dto.py index 56b6a27d..0933a7f1 100644 --- a/nipyapi/nifi/models/relationship_dto.py +++ b/nipyapi/nifi/models/relationship_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_port_run_status_entity.py b/nipyapi/nifi/models/remote_port_run_status_entity.py index 7512b322..31f16f34 100644 --- a/nipyapi/nifi/models/remote_port_run_status_entity.py +++ b/nipyapi/nifi/models/remote_port_run_status_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_contents_dto.py b/nipyapi/nifi/models/remote_process_group_contents_dto.py index a2c8ae97..1cf3509e 100644 --- a/nipyapi/nifi/models/remote_process_group_contents_dto.py +++ b/nipyapi/nifi/models/remote_process_group_contents_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_dto.py b/nipyapi/nifi/models/remote_process_group_dto.py index aff4f23c..0ff616c2 100644 --- a/nipyapi/nifi/models/remote_process_group_dto.py +++ b/nipyapi/nifi/models/remote_process_group_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_entity.py b/nipyapi/nifi/models/remote_process_group_entity.py index aae42e1e..5542506f 100644 --- a/nipyapi/nifi/models/remote_process_group_entity.py +++ b/nipyapi/nifi/models/remote_process_group_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_port_dto.py b/nipyapi/nifi/models/remote_process_group_port_dto.py index e715ddac..45539382 100644 --- a/nipyapi/nifi/models/remote_process_group_port_dto.py +++ b/nipyapi/nifi/models/remote_process_group_port_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_port_entity.py b/nipyapi/nifi/models/remote_process_group_port_entity.py index 8385593f..e69786e3 100644 --- a/nipyapi/nifi/models/remote_process_group_port_entity.py +++ b/nipyapi/nifi/models/remote_process_group_port_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_dto.py b/nipyapi/nifi/models/remote_process_group_status_dto.py index c0b4d0c8..8ce78592 100644 --- a/nipyapi/nifi/models/remote_process_group_status_dto.py +++ b/nipyapi/nifi/models/remote_process_group_status_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_entity.py b/nipyapi/nifi/models/remote_process_group_status_entity.py index 0faaad11..ba7f636d 100644 --- a/nipyapi/nifi/models/remote_process_group_status_entity.py +++ b/nipyapi/nifi/models/remote_process_group_status_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py b/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py index 20ed0810..899dcac0 100644 --- a/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py +++ b/nipyapi/nifi/models/remote_process_group_status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py b/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py index ae82f828..a0556f77 100644 --- a/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py +++ b/nipyapi/nifi/models/remote_process_group_status_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_process_groups_entity.py b/nipyapi/nifi/models/remote_process_groups_entity.py index fdc5c917..b7d50495 100644 --- a/nipyapi/nifi/models/remote_process_groups_entity.py +++ b/nipyapi/nifi/models/remote_process_groups_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/remote_queue_partition_dto.py b/nipyapi/nifi/models/remote_queue_partition_dto.py index 2955899f..c7d5cb0e 100644 --- a/nipyapi/nifi/models/remote_queue_partition_dto.py +++ b/nipyapi/nifi/models/remote_queue_partition_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/replay_last_event_request_entity.py b/nipyapi/nifi/models/replay_last_event_request_entity.py index 93a04928..69c21e1c 100644 --- a/nipyapi/nifi/models/replay_last_event_request_entity.py +++ b/nipyapi/nifi/models/replay_last_event_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/replay_last_event_response_entity.py b/nipyapi/nifi/models/replay_last_event_response_entity.py index 9e34e873..df464ad8 100644 --- a/nipyapi/nifi/models/replay_last_event_response_entity.py +++ b/nipyapi/nifi/models/replay_last_event_response_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/replay_last_event_snapshot_dto.py b/nipyapi/nifi/models/replay_last_event_snapshot_dto.py index 908dc907..7f4cf0a1 100644 --- a/nipyapi/nifi/models/replay_last_event_snapshot_dto.py +++ b/nipyapi/nifi/models/replay_last_event_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_definition.py b/nipyapi/nifi/models/reporting_task_definition.py index 7ac15b9c..0e46d89d 100644 --- a/nipyapi/nifi/models/reporting_task_definition.py +++ b/nipyapi/nifi/models/reporting_task_definition.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_dto.py b/nipyapi/nifi/models/reporting_task_dto.py index 129f0361..3b0c0974 100644 --- a/nipyapi/nifi/models/reporting_task_dto.py +++ b/nipyapi/nifi/models/reporting_task_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_entity.py b/nipyapi/nifi/models/reporting_task_entity.py index 7147da61..908ae963 100644 --- a/nipyapi/nifi/models/reporting_task_entity.py +++ b/nipyapi/nifi/models/reporting_task_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_run_status_entity.py b/nipyapi/nifi/models/reporting_task_run_status_entity.py index ef606555..576ddc76 100644 --- a/nipyapi/nifi/models/reporting_task_run_status_entity.py +++ b/nipyapi/nifi/models/reporting_task_run_status_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_status_dto.py b/nipyapi/nifi/models/reporting_task_status_dto.py index 31ef1ba3..844720d2 100644 --- a/nipyapi/nifi/models/reporting_task_status_dto.py +++ b/nipyapi/nifi/models/reporting_task_status_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_task_types_entity.py b/nipyapi/nifi/models/reporting_task_types_entity.py index d5b9b263..59936867 100644 --- a/nipyapi/nifi/models/reporting_task_types_entity.py +++ b/nipyapi/nifi/models/reporting_task_types_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/reporting_tasks_entity.py b/nipyapi/nifi/models/reporting_tasks_entity.py index dff86455..927bba51 100644 --- a/nipyapi/nifi/models/reporting_tasks_entity.py +++ b/nipyapi/nifi/models/reporting_tasks_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/repository_usage_dto.py b/nipyapi/nifi/models/repository_usage_dto.py index b45c789d..bdb12259 100644 --- a/nipyapi/nifi/models/repository_usage_dto.py +++ b/nipyapi/nifi/models/repository_usage_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/required_permission_dto.py b/nipyapi/nifi/models/required_permission_dto.py index edc835c6..3e063587 100644 --- a/nipyapi/nifi/models/required_permission_dto.py +++ b/nipyapi/nifi/models/required_permission_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/resource_dto.py b/nipyapi/nifi/models/resource_dto.py index 3f884787..915a786f 100644 --- a/nipyapi/nifi/models/resource_dto.py +++ b/nipyapi/nifi/models/resource_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/resources_entity.py b/nipyapi/nifi/models/resources_entity.py index 085f64bf..5412c474 100644 --- a/nipyapi/nifi/models/resources_entity.py +++ b/nipyapi/nifi/models/resources_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/response.py b/nipyapi/nifi/models/response.py index 8fb46b28..a438c744 100644 --- a/nipyapi/nifi/models/response.py +++ b/nipyapi/nifi/models/response.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -31,54 +31,33 @@ class Response(object): and the value is json key in definition. """ swagger_types = { - 'status': 'int', 'metadata': 'dict(str, list[object])', + 'status': 'int', 'entity': 'object' } attribute_map = { - 'status': 'status', 'metadata': 'metadata', + 'status': 'status', 'entity': 'entity' } - def __init__(self, status=None, metadata=None, entity=None): + def __init__(self, metadata=None, status=None, entity=None): """ Response - a model defined in Swagger """ - self._status = None self._metadata = None + self._status = None self._entity = None - if status is not None: - self.status = status if metadata is not None: self.metadata = metadata + if status is not None: + self.status = status if entity is not None: self.entity = entity - @property - def status(self): - """ - Gets the status of this Response. - - :return: The status of this Response. - :rtype: int - """ - return self._status - - @status.setter - def status(self, status): - """ - Sets the status of this Response. - - :param status: The status of this Response. - :type: int - """ - - self._status = status - @property def metadata(self): """ @@ -100,6 +79,27 @@ def metadata(self, metadata): self._metadata = metadata + @property + def status(self): + """ + Gets the status of this Response. + + :return: The status of this Response. + :rtype: int + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this Response. + + :param status: The status of this Response. + :type: int + """ + + self._status = status + @property def entity(self): """ diff --git a/nipyapi/nifi/models/restriction.py b/nipyapi/nifi/models/restriction.py index ed740b86..ff9c212b 100644 --- a/nipyapi/nifi/models/restriction.py +++ b/nipyapi/nifi/models/restriction.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/revision_dto.py b/nipyapi/nifi/models/revision_dto.py index 9590efd1..b97968ba 100644 --- a/nipyapi/nifi/models/revision_dto.py +++ b/nipyapi/nifi/models/revision_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/run_status_details_request_entity.py b/nipyapi/nifi/models/run_status_details_request_entity.py index 5c9c8883..f1256092 100644 --- a/nipyapi/nifi/models/run_status_details_request_entity.py +++ b/nipyapi/nifi/models/run_status_details_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/runtime_manifest.py b/nipyapi/nifi/models/runtime_manifest.py index e785b55e..574ef484 100644 --- a/nipyapi/nifi/models/runtime_manifest.py +++ b/nipyapi/nifi/models/runtime_manifest.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/runtime_manifest_entity.py b/nipyapi/nifi/models/runtime_manifest_entity.py index 1c8037a4..91d1a3ea 100644 --- a/nipyapi/nifi/models/runtime_manifest_entity.py +++ b/nipyapi/nifi/models/runtime_manifest_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/schedule_components_entity.py b/nipyapi/nifi/models/schedule_components_entity.py index d57f2880..82f9c6bb 100644 --- a/nipyapi/nifi/models/schedule_components_entity.py +++ b/nipyapi/nifi/models/schedule_components_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/scheduling_defaults.py b/nipyapi/nifi/models/scheduling_defaults.py index 23e92662..54a150ec 100644 --- a/nipyapi/nifi/models/scheduling_defaults.py +++ b/nipyapi/nifi/models/scheduling_defaults.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/search_result_group_dto.py b/nipyapi/nifi/models/search_result_group_dto.py index 7f587d2e..8fc0c9fa 100644 --- a/nipyapi/nifi/models/search_result_group_dto.py +++ b/nipyapi/nifi/models/search_result_group_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/search_results_dto.py b/nipyapi/nifi/models/search_results_dto.py index eb664637..7989ab8e 100644 --- a/nipyapi/nifi/models/search_results_dto.py +++ b/nipyapi/nifi/models/search_results_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/search_results_entity.py b/nipyapi/nifi/models/search_results_entity.py index 77755693..1157bf64 100644 --- a/nipyapi/nifi/models/search_results_entity.py +++ b/nipyapi/nifi/models/search_results_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/snippet_dto.py b/nipyapi/nifi/models/snippet_dto.py index 24bfc37d..32166001 100644 --- a/nipyapi/nifi/models/snippet_dto.py +++ b/nipyapi/nifi/models/snippet_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/snippet_entity.py b/nipyapi/nifi/models/snippet_entity.py index cd33f182..8d9120ab 100644 --- a/nipyapi/nifi/models/snippet_entity.py +++ b/nipyapi/nifi/models/snippet_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/stack_trace_element.py b/nipyapi/nifi/models/stack_trace_element.py index 0bb4e6cd..5a7e3a84 100644 --- a/nipyapi/nifi/models/stack_trace_element.py +++ b/nipyapi/nifi/models/stack_trace_element.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -37,8 +37,8 @@ class StackTraceElement(object): 'method_name': 'str', 'file_name': 'str', 'line_number': 'int', - 'class_name': 'str', - 'native_method': 'bool' + 'native_method': 'bool', + 'class_name': 'str' } attribute_map = { @@ -48,11 +48,11 @@ class StackTraceElement(object): 'method_name': 'methodName', 'file_name': 'fileName', 'line_number': 'lineNumber', - 'class_name': 'className', - 'native_method': 'nativeMethod' + 'native_method': 'nativeMethod', + 'class_name': 'className' } - def __init__(self, class_loader_name=None, module_name=None, module_version=None, method_name=None, file_name=None, line_number=None, class_name=None, native_method=None): + def __init__(self, class_loader_name=None, module_name=None, module_version=None, method_name=None, file_name=None, line_number=None, native_method=None, class_name=None): """ StackTraceElement - a model defined in Swagger """ @@ -63,8 +63,8 @@ def __init__(self, class_loader_name=None, module_name=None, module_version=None self._method_name = None self._file_name = None self._line_number = None - self._class_name = None self._native_method = None + self._class_name = None if class_loader_name is not None: self.class_loader_name = class_loader_name @@ -78,10 +78,10 @@ def __init__(self, class_loader_name=None, module_name=None, module_version=None self.file_name = file_name if line_number is not None: self.line_number = line_number - if class_name is not None: - self.class_name = class_name if native_method is not None: self.native_method = native_method + if class_name is not None: + self.class_name = class_name @property def class_loader_name(self): @@ -209,27 +209,6 @@ def line_number(self, line_number): self._line_number = line_number - @property - def class_name(self): - """ - Gets the class_name of this StackTraceElement. - - :return: The class_name of this StackTraceElement. - :rtype: str - """ - return self._class_name - - @class_name.setter - def class_name(self, class_name): - """ - Sets the class_name of this StackTraceElement. - - :param class_name: The class_name of this StackTraceElement. - :type: str - """ - - self._class_name = class_name - @property def native_method(self): """ @@ -251,6 +230,27 @@ def native_method(self, native_method): self._native_method = native_method + @property + def class_name(self): + """ + Gets the class_name of this StackTraceElement. + + :return: The class_name of this StackTraceElement. + :rtype: str + """ + return self._class_name + + @class_name.setter + def class_name(self, class_name): + """ + Sets the class_name of this StackTraceElement. + + :param class_name: The class_name of this StackTraceElement. + :type: str + """ + + self._class_name = class_name + def to_dict(self): """ Returns the model properties as a dict diff --git a/nipyapi/nifi/models/start_version_control_request_entity.py b/nipyapi/nifi/models/start_version_control_request_entity.py index b64aee77..37e09b56 100644 --- a/nipyapi/nifi/models/start_version_control_request_entity.py +++ b/nipyapi/nifi/models/start_version_control_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/state_entry_dto.py b/nipyapi/nifi/models/state_entry_dto.py index 00929e61..3bdf34f4 100644 --- a/nipyapi/nifi/models/state_entry_dto.py +++ b/nipyapi/nifi/models/state_entry_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/state_map_dto.py b/nipyapi/nifi/models/state_map_dto.py index 834dfc0a..1b997a04 100644 --- a/nipyapi/nifi/models/state_map_dto.py +++ b/nipyapi/nifi/models/state_map_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/stateful.py b/nipyapi/nifi/models/stateful.py index 19a77531..30643b04 100644 --- a/nipyapi/nifi/models/stateful.py +++ b/nipyapi/nifi/models/stateful.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_descriptor_dto.py b/nipyapi/nifi/models/status_descriptor_dto.py index b8255e1d..71eb86bf 100644 --- a/nipyapi/nifi/models/status_descriptor_dto.py +++ b/nipyapi/nifi/models/status_descriptor_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_history_dto.py b/nipyapi/nifi/models/status_history_dto.py index 7a08e3f5..810ad9d7 100644 --- a/nipyapi/nifi/models/status_history_dto.py +++ b/nipyapi/nifi/models/status_history_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_history_entity.py b/nipyapi/nifi/models/status_history_entity.py index f9528c67..7bbafcdb 100644 --- a/nipyapi/nifi/models/status_history_entity.py +++ b/nipyapi/nifi/models/status_history_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/status_snapshot_dto.py b/nipyapi/nifi/models/status_snapshot_dto.py index 090e80a7..96e32b9c 100644 --- a/nipyapi/nifi/models/status_snapshot_dto.py +++ b/nipyapi/nifi/models/status_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/storage_usage_dto.py b/nipyapi/nifi/models/storage_usage_dto.py index 9ff3d453..31f36918 100644 --- a/nipyapi/nifi/models/storage_usage_dto.py +++ b/nipyapi/nifi/models/storage_usage_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/streaming_output.py b/nipyapi/nifi/models/streaming_output.py index f3b98799..cd7c1979 100644 --- a/nipyapi/nifi/models/streaming_output.py +++ b/nipyapi/nifi/models/streaming_output.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/submit_replay_request_entity.py b/nipyapi/nifi/models/submit_replay_request_entity.py index 127bd3af..36c75733 100644 --- a/nipyapi/nifi/models/submit_replay_request_entity.py +++ b/nipyapi/nifi/models/submit_replay_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_diagnostics_dto.py b/nipyapi/nifi/models/system_diagnostics_dto.py index 910bf7ee..1b79dcde 100644 --- a/nipyapi/nifi/models/system_diagnostics_dto.py +++ b/nipyapi/nifi/models/system_diagnostics_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_diagnostics_entity.py b/nipyapi/nifi/models/system_diagnostics_entity.py index bb79d1a8..fb6c33d0 100644 --- a/nipyapi/nifi/models/system_diagnostics_entity.py +++ b/nipyapi/nifi/models/system_diagnostics_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py b/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py index 156fecdc..bffb4c43 100644 --- a/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py +++ b/nipyapi/nifi/models/system_diagnostics_snapshot_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/system_resource_consideration.py b/nipyapi/nifi/models/system_resource_consideration.py index 60bcad8d..f5bf190d 100644 --- a/nipyapi/nifi/models/system_resource_consideration.py +++ b/nipyapi/nifi/models/system_resource_consideration.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/template_dto.py b/nipyapi/nifi/models/template_dto.py index 199a9fb6..37d95385 100644 --- a/nipyapi/nifi/models/template_dto.py +++ b/nipyapi/nifi/models/template_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/template_entity.py b/nipyapi/nifi/models/template_entity.py index 5dc3eacd..fc2a102a 100644 --- a/nipyapi/nifi/models/template_entity.py +++ b/nipyapi/nifi/models/template_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/templates_entity.py b/nipyapi/nifi/models/templates_entity.py index 802e16a9..555aba34 100644 --- a/nipyapi/nifi/models/templates_entity.py +++ b/nipyapi/nifi/models/templates_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/tenant_dto.py b/nipyapi/nifi/models/tenant_dto.py index 4c2d6b98..c81eef51 100644 --- a/nipyapi/nifi/models/tenant_dto.py +++ b/nipyapi/nifi/models/tenant_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/tenant_entity.py b/nipyapi/nifi/models/tenant_entity.py index 55123db1..ea2e5ef4 100644 --- a/nipyapi/nifi/models/tenant_entity.py +++ b/nipyapi/nifi/models/tenant_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/tenants_entity.py b/nipyapi/nifi/models/tenants_entity.py index 98eddff8..386b8baf 100644 --- a/nipyapi/nifi/models/tenants_entity.py +++ b/nipyapi/nifi/models/tenants_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/thread_dump_dto.py b/nipyapi/nifi/models/thread_dump_dto.py index ad9b1d29..01c89413 100644 --- a/nipyapi/nifi/models/thread_dump_dto.py +++ b/nipyapi/nifi/models/thread_dump_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/throwable.py b/nipyapi/nifi/models/throwable.py index 26763755..c0097347 100644 --- a/nipyapi/nifi/models/throwable.py +++ b/nipyapi/nifi/models/throwable.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/transaction_result_entity.py b/nipyapi/nifi/models/transaction_result_entity.py index f7fd416b..12d7270c 100644 --- a/nipyapi/nifi/models/transaction_result_entity.py +++ b/nipyapi/nifi/models/transaction_result_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/update_controller_service_reference_request_entity.py b/nipyapi/nifi/models/update_controller_service_reference_request_entity.py index f5588c76..281f053b 100644 --- a/nipyapi/nifi/models/update_controller_service_reference_request_entity.py +++ b/nipyapi/nifi/models/update_controller_service_reference_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_dto.py b/nipyapi/nifi/models/user_dto.py index d7d58444..5fe91cce 100644 --- a/nipyapi/nifi/models/user_dto.py +++ b/nipyapi/nifi/models/user_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_entity.py b/nipyapi/nifi/models/user_entity.py index 04ba9a4c..7576fb4b 100644 --- a/nipyapi/nifi/models/user_entity.py +++ b/nipyapi/nifi/models/user_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_group_dto.py b/nipyapi/nifi/models/user_group_dto.py index 1c13cb21..87dec6ef 100644 --- a/nipyapi/nifi/models/user_group_dto.py +++ b/nipyapi/nifi/models/user_group_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_group_entity.py b/nipyapi/nifi/models/user_group_entity.py index aca6aa97..8b3f62c1 100644 --- a/nipyapi/nifi/models/user_group_entity.py +++ b/nipyapi/nifi/models/user_group_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/user_groups_entity.py b/nipyapi/nifi/models/user_groups_entity.py index 8acb53ac..ef98e550 100644 --- a/nipyapi/nifi/models/user_groups_entity.py +++ b/nipyapi/nifi/models/user_groups_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/users_entity.py b/nipyapi/nifi/models/users_entity.py index 266ea7d3..8c8f49f6 100644 --- a/nipyapi/nifi/models/users_entity.py +++ b/nipyapi/nifi/models/users_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_dto.py b/nipyapi/nifi/models/variable_dto.py index a72bc376..bae1882a 100644 --- a/nipyapi/nifi/models/variable_dto.py +++ b/nipyapi/nifi/models/variable_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_entity.py b/nipyapi/nifi/models/variable_entity.py index 404f5894..3dbac349 100644 --- a/nipyapi/nifi/models/variable_entity.py +++ b/nipyapi/nifi/models/variable_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_dto.py b/nipyapi/nifi/models/variable_registry_dto.py index 3cb1469e..cf1cda3c 100644 --- a/nipyapi/nifi/models/variable_registry_dto.py +++ b/nipyapi/nifi/models/variable_registry_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_entity.py b/nipyapi/nifi/models/variable_registry_entity.py index c11511a7..44659a2a 100644 --- a/nipyapi/nifi/models/variable_registry_entity.py +++ b/nipyapi/nifi/models/variable_registry_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_update_request_dto.py b/nipyapi/nifi/models/variable_registry_update_request_dto.py index 1ab12e5c..9f00e744 100644 --- a/nipyapi/nifi/models/variable_registry_update_request_dto.py +++ b/nipyapi/nifi/models/variable_registry_update_request_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_update_request_entity.py b/nipyapi/nifi/models/variable_registry_update_request_entity.py index 0e51b9b4..15e21fcb 100644 --- a/nipyapi/nifi/models/variable_registry_update_request_entity.py +++ b/nipyapi/nifi/models/variable_registry_update_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/variable_registry_update_step_dto.py b/nipyapi/nifi/models/variable_registry_update_step_dto.py index b814c81a..8ff680f3 100644 --- a/nipyapi/nifi/models/variable_registry_update_step_dto.py +++ b/nipyapi/nifi/models/variable_registry_update_step_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/verify_config_request_dto.py b/nipyapi/nifi/models/verify_config_request_dto.py index 34853e97..0dbab573 100644 --- a/nipyapi/nifi/models/verify_config_request_dto.py +++ b/nipyapi/nifi/models/verify_config_request_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/verify_config_request_entity.py b/nipyapi/nifi/models/verify_config_request_entity.py index beb6eca4..8ec7ac85 100644 --- a/nipyapi/nifi/models/verify_config_request_entity.py +++ b/nipyapi/nifi/models/verify_config_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/verify_config_update_step_dto.py b/nipyapi/nifi/models/verify_config_update_step_dto.py index 61d89ad4..5d989ce4 100644 --- a/nipyapi/nifi/models/verify_config_update_step_dto.py +++ b/nipyapi/nifi/models/verify_config_update_step_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_control_component_mapping_entity.py b/nipyapi/nifi/models/version_control_component_mapping_entity.py index 55363493..fee6fe03 100644 --- a/nipyapi/nifi/models/version_control_component_mapping_entity.py +++ b/nipyapi/nifi/models/version_control_component_mapping_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_control_information_dto.py b/nipyapi/nifi/models/version_control_information_dto.py index fdbc6f48..bdc0250b 100644 --- a/nipyapi/nifi/models/version_control_information_dto.py +++ b/nipyapi/nifi/models/version_control_information_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_control_information_entity.py b/nipyapi/nifi/models/version_control_information_entity.py index c5299fad..35b1696a 100644 --- a/nipyapi/nifi/models/version_control_information_entity.py +++ b/nipyapi/nifi/models/version_control_information_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/version_info_dto.py b/nipyapi/nifi/models/version_info_dto.py index 6e614940..9cfb8111 100644 --- a/nipyapi/nifi/models/version_info_dto.py +++ b/nipyapi/nifi/models/version_info_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_connection.py b/nipyapi/nifi/models/versioned_connection.py index 184ed1e8..550bf6c7 100644 --- a/nipyapi/nifi/models/versioned_connection.py +++ b/nipyapi/nifi/models/versioned_connection.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_controller_service.py b/nipyapi/nifi/models/versioned_controller_service.py index 25aa49e8..820f5bca 100644 --- a/nipyapi/nifi/models/versioned_controller_service.py +++ b/nipyapi/nifi/models/versioned_controller_service.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_coordinates.py b/nipyapi/nifi/models/versioned_flow_coordinates.py index ddb4c48f..e5f75bf9 100644 --- a/nipyapi/nifi/models/versioned_flow_coordinates.py +++ b/nipyapi/nifi/models/versioned_flow_coordinates.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_dto.py b/nipyapi/nifi/models/versioned_flow_dto.py index 0c3c3e7b..695fa5f0 100644 --- a/nipyapi/nifi/models/versioned_flow_dto.py +++ b/nipyapi/nifi/models/versioned_flow_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_entity.py b/nipyapi/nifi/models/versioned_flow_entity.py index 699affbb..30760a0c 100644 --- a/nipyapi/nifi/models/versioned_flow_entity.py +++ b/nipyapi/nifi/models/versioned_flow_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_entity.py index 585db926..fea098dd 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py index 23e1e304..3dd87749 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py index 290de14b..4ab53991 100644 --- a/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py +++ b/nipyapi/nifi/models/versioned_flow_snapshot_metadata_set_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_update_request_dto.py b/nipyapi/nifi/models/versioned_flow_update_request_dto.py index ef4e4d3e..5dd4d8f1 100644 --- a/nipyapi/nifi/models/versioned_flow_update_request_dto.py +++ b/nipyapi/nifi/models/versioned_flow_update_request_dto.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flow_update_request_entity.py b/nipyapi/nifi/models/versioned_flow_update_request_entity.py index b2db47ef..1fb6fa02 100644 --- a/nipyapi/nifi/models/versioned_flow_update_request_entity.py +++ b/nipyapi/nifi/models/versioned_flow_update_request_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_flows_entity.py b/nipyapi/nifi/models/versioned_flows_entity.py index ca16f0a0..46722f05 100644 --- a/nipyapi/nifi/models/versioned_flows_entity.py +++ b/nipyapi/nifi/models/versioned_flows_entity.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_funnel.py b/nipyapi/nifi/models/versioned_funnel.py index 00071fc8..e1275485 100644 --- a/nipyapi/nifi/models/versioned_funnel.py +++ b/nipyapi/nifi/models/versioned_funnel.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_label.py b/nipyapi/nifi/models/versioned_label.py index ce4919f2..46d4bcad 100644 --- a/nipyapi/nifi/models/versioned_label.py +++ b/nipyapi/nifi/models/versioned_label.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_parameter.py b/nipyapi/nifi/models/versioned_parameter.py index 602efea6..716399c0 100644 --- a/nipyapi/nifi/models/versioned_parameter.py +++ b/nipyapi/nifi/models/versioned_parameter.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_parameter_context.py b/nipyapi/nifi/models/versioned_parameter_context.py index 121a8577..b0268cc9 100644 --- a/nipyapi/nifi/models/versioned_parameter_context.py +++ b/nipyapi/nifi/models/versioned_parameter_context.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_port.py b/nipyapi/nifi/models/versioned_port.py index 7f37c66f..3d2adfb4 100644 --- a/nipyapi/nifi/models/versioned_port.py +++ b/nipyapi/nifi/models/versioned_port.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_process_group.py b/nipyapi/nifi/models/versioned_process_group.py index 0ca4988b..07301b50 100644 --- a/nipyapi/nifi/models/versioned_process_group.py +++ b/nipyapi/nifi/models/versioned_process_group.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -53,8 +53,8 @@ class VersionedProcessGroup(object): 'default_back_pressure_data_size_threshold': 'str', 'log_file_suffix': 'str', 'component_type': 'str', - 'flow_file_concurrency': 'str', 'flow_file_outbound_policy': 'str', + 'flow_file_concurrency': 'str', 'group_identifier': 'str' } @@ -81,12 +81,12 @@ class VersionedProcessGroup(object): 'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', 'log_file_suffix': 'logFileSuffix', 'component_type': 'componentType', - 'flow_file_concurrency': 'flowFileConcurrency', 'flow_file_outbound_policy': 'flowFileOutboundPolicy', + 'flow_file_concurrency': 'flowFileConcurrency', 'group_identifier': 'groupIdentifier' } - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None, controller_services=None, versioned_flow_coordinates=None, variables=None, parameter_context_name=None, default_flow_file_expiration=None, default_back_pressure_object_threshold=None, default_back_pressure_data_size_threshold=None, log_file_suffix=None, component_type=None, flow_file_concurrency=None, flow_file_outbound_policy=None, group_identifier=None): + def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None, controller_services=None, versioned_flow_coordinates=None, variables=None, parameter_context_name=None, default_flow_file_expiration=None, default_back_pressure_object_threshold=None, default_back_pressure_data_size_threshold=None, log_file_suffix=None, component_type=None, flow_file_outbound_policy=None, flow_file_concurrency=None, group_identifier=None): """ VersionedProcessGroup - a model defined in Swagger """ @@ -113,8 +113,8 @@ def __init__(self, identifier=None, instance_identifier=None, name=None, comment self._default_back_pressure_data_size_threshold = None self._log_file_suffix = None self._component_type = None - self._flow_file_concurrency = None self._flow_file_outbound_policy = None + self._flow_file_concurrency = None self._group_identifier = None if identifier is not None: @@ -161,10 +161,10 @@ def __init__(self, identifier=None, instance_identifier=None, name=None, comment self.log_file_suffix = log_file_suffix if component_type is not None: self.component_type = component_type - if flow_file_concurrency is not None: - self.flow_file_concurrency = flow_file_concurrency if flow_file_outbound_policy is not None: self.flow_file_outbound_policy = flow_file_outbound_policy + if flow_file_concurrency is not None: + self.flow_file_concurrency = flow_file_concurrency if group_identifier is not None: self.group_identifier = group_identifier @@ -679,50 +679,50 @@ def component_type(self, component_type): self._component_type = component_type @property - def flow_file_concurrency(self): + def flow_file_outbound_policy(self): """ - Gets the flow_file_concurrency of this VersionedProcessGroup. - The configured FlowFile Concurrency for the Process Group + Gets the flow_file_outbound_policy of this VersionedProcessGroup. + The FlowFile Outbound Policy for the Process Group - :return: The flow_file_concurrency of this VersionedProcessGroup. + :return: The flow_file_outbound_policy of this VersionedProcessGroup. :rtype: str """ - return self._flow_file_concurrency + return self._flow_file_outbound_policy - @flow_file_concurrency.setter - def flow_file_concurrency(self, flow_file_concurrency): + @flow_file_outbound_policy.setter + def flow_file_outbound_policy(self, flow_file_outbound_policy): """ - Sets the flow_file_concurrency of this VersionedProcessGroup. - The configured FlowFile Concurrency for the Process Group + Sets the flow_file_outbound_policy of this VersionedProcessGroup. + The FlowFile Outbound Policy for the Process Group - :param flow_file_concurrency: The flow_file_concurrency of this VersionedProcessGroup. + :param flow_file_outbound_policy: The flow_file_outbound_policy of this VersionedProcessGroup. :type: str """ - self._flow_file_concurrency = flow_file_concurrency + self._flow_file_outbound_policy = flow_file_outbound_policy @property - def flow_file_outbound_policy(self): + def flow_file_concurrency(self): """ - Gets the flow_file_outbound_policy of this VersionedProcessGroup. - The FlowFile Outbound Policy for the Process Group + Gets the flow_file_concurrency of this VersionedProcessGroup. + The configured FlowFile Concurrency for the Process Group - :return: The flow_file_outbound_policy of this VersionedProcessGroup. + :return: The flow_file_concurrency of this VersionedProcessGroup. :rtype: str """ - return self._flow_file_outbound_policy + return self._flow_file_concurrency - @flow_file_outbound_policy.setter - def flow_file_outbound_policy(self, flow_file_outbound_policy): + @flow_file_concurrency.setter + def flow_file_concurrency(self, flow_file_concurrency): """ - Sets the flow_file_outbound_policy of this VersionedProcessGroup. - The FlowFile Outbound Policy for the Process Group + Sets the flow_file_concurrency of this VersionedProcessGroup. + The configured FlowFile Concurrency for the Process Group - :param flow_file_outbound_policy: The flow_file_outbound_policy of this VersionedProcessGroup. + :param flow_file_concurrency: The flow_file_concurrency of this VersionedProcessGroup. :type: str """ - self._flow_file_outbound_policy = flow_file_outbound_policy + self._flow_file_concurrency = flow_file_concurrency @property def group_identifier(self): diff --git a/nipyapi/nifi/models/versioned_processor.py b/nipyapi/nifi/models/versioned_processor.py index eda344d5..c53ccd00 100644 --- a/nipyapi/nifi/models/versioned_processor.py +++ b/nipyapi/nifi/models/versioned_processor.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_property_descriptor.py b/nipyapi/nifi/models/versioned_property_descriptor.py index 8a465807..971711cd 100644 --- a/nipyapi/nifi/models/versioned_property_descriptor.py +++ b/nipyapi/nifi/models/versioned_property_descriptor.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_remote_group_port.py b/nipyapi/nifi/models/versioned_remote_group_port.py index 9a178e33..d1368d11 100644 --- a/nipyapi/nifi/models/versioned_remote_group_port.py +++ b/nipyapi/nifi/models/versioned_remote_group_port.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_remote_process_group.py b/nipyapi/nifi/models/versioned_remote_process_group.py index 4cf74861..f67aaf59 100644 --- a/nipyapi/nifi/models/versioned_remote_process_group.py +++ b/nipyapi/nifi/models/versioned_remote_process_group.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/models/versioned_reporting_task.py b/nipyapi/nifi/models/versioned_reporting_task.py new file mode 100644 index 00000000..2a46d3a8 --- /dev/null +++ b/nipyapi/nifi/models/versioned_reporting_task.py @@ -0,0 +1,527 @@ +# coding: utf-8 + +""" + NiFi Rest API + + The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.27.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class VersionedReportingTask(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'identifier': 'str', + 'instance_identifier': 'str', + 'name': 'str', + 'comments': 'str', + 'position': 'Position', + 'type': 'str', + 'bundle': 'Bundle', + 'properties': 'dict(str, str)', + 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', + 'annotation_data': 'str', + 'scheduled_state': 'str', + 'scheduling_period': 'str', + 'scheduling_strategy': 'str', + 'component_type': 'str', + 'group_identifier': 'str' + } + + attribute_map = { + 'identifier': 'identifier', + 'instance_identifier': 'instanceIdentifier', + 'name': 'name', + 'comments': 'comments', + 'position': 'position', + 'type': 'type', + 'bundle': 'bundle', + 'properties': 'properties', + 'property_descriptors': 'propertyDescriptors', + 'annotation_data': 'annotationData', + 'scheduled_state': 'scheduledState', + 'scheduling_period': 'schedulingPeriod', + 'scheduling_strategy': 'schedulingStrategy', + 'component_type': 'componentType', + 'group_identifier': 'groupIdentifier' + } + + def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, bundle=None, properties=None, property_descriptors=None, annotation_data=None, scheduled_state=None, scheduling_period=None, scheduling_strategy=None, component_type=None, group_identifier=None): + """ + VersionedReportingTask - a model defined in Swagger + """ + + self._identifier = None + self._instance_identifier = None + self._name = None + self._comments = None + self._position = None + self._type = None + self._bundle = None + self._properties = None + self._property_descriptors = None + self._annotation_data = None + self._scheduled_state = None + self._scheduling_period = None + self._scheduling_strategy = None + self._component_type = None + self._group_identifier = None + + if identifier is not None: + self.identifier = identifier + if instance_identifier is not None: + self.instance_identifier = instance_identifier + if name is not None: + self.name = name + if comments is not None: + self.comments = comments + if position is not None: + self.position = position + if type is not None: + self.type = type + if bundle is not None: + self.bundle = bundle + if properties is not None: + self.properties = properties + if property_descriptors is not None: + self.property_descriptors = property_descriptors + if annotation_data is not None: + self.annotation_data = annotation_data + if scheduled_state is not None: + self.scheduled_state = scheduled_state + if scheduling_period is not None: + self.scheduling_period = scheduling_period + if scheduling_strategy is not None: + self.scheduling_strategy = scheduling_strategy + if component_type is not None: + self.component_type = component_type + if group_identifier is not None: + self.group_identifier = group_identifier + + @property + def identifier(self): + """ + Gets the identifier of this VersionedReportingTask. + The component's unique identifier + + :return: The identifier of this VersionedReportingTask. + :rtype: str + """ + return self._identifier + + @identifier.setter + def identifier(self, identifier): + """ + Sets the identifier of this VersionedReportingTask. + The component's unique identifier + + :param identifier: The identifier of this VersionedReportingTask. + :type: str + """ + + self._identifier = identifier + + @property + def instance_identifier(self): + """ + Gets the instance_identifier of this VersionedReportingTask. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + + :return: The instance_identifier of this VersionedReportingTask. + :rtype: str + """ + return self._instance_identifier + + @instance_identifier.setter + def instance_identifier(self, instance_identifier): + """ + Sets the instance_identifier of this VersionedReportingTask. + The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component + + :param instance_identifier: The instance_identifier of this VersionedReportingTask. + :type: str + """ + + self._instance_identifier = instance_identifier + + @property + def name(self): + """ + Gets the name of this VersionedReportingTask. + The component's name + + :return: The name of this VersionedReportingTask. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this VersionedReportingTask. + The component's name + + :param name: The name of this VersionedReportingTask. + :type: str + """ + + self._name = name + + @property + def comments(self): + """ + Gets the comments of this VersionedReportingTask. + The user-supplied comments for the component + + :return: The comments of this VersionedReportingTask. + :rtype: str + """ + return self._comments + + @comments.setter + def comments(self, comments): + """ + Sets the comments of this VersionedReportingTask. + The user-supplied comments for the component + + :param comments: The comments of this VersionedReportingTask. + :type: str + """ + + self._comments = comments + + @property + def position(self): + """ + Gets the position of this VersionedReportingTask. + The component's position on the graph + + :return: The position of this VersionedReportingTask. + :rtype: Position + """ + return self._position + + @position.setter + def position(self, position): + """ + Sets the position of this VersionedReportingTask. + The component's position on the graph + + :param position: The position of this VersionedReportingTask. + :type: Position + """ + + self._position = position + + @property + def type(self): + """ + Gets the type of this VersionedReportingTask. + The type of the extension component + + :return: The type of this VersionedReportingTask. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this VersionedReportingTask. + The type of the extension component + + :param type: The type of this VersionedReportingTask. + :type: str + """ + + self._type = type + + @property + def bundle(self): + """ + Gets the bundle of this VersionedReportingTask. + Information about the bundle from which the component came + + :return: The bundle of this VersionedReportingTask. + :rtype: Bundle + """ + return self._bundle + + @bundle.setter + def bundle(self, bundle): + """ + Sets the bundle of this VersionedReportingTask. + Information about the bundle from which the component came + + :param bundle: The bundle of this VersionedReportingTask. + :type: Bundle + """ + + self._bundle = bundle + + @property + def properties(self): + """ + Gets the properties of this VersionedReportingTask. + The properties for the component. Properties whose value is not set will only contain the property name. + + :return: The properties of this VersionedReportingTask. + :rtype: dict(str, str) + """ + return self._properties + + @properties.setter + def properties(self, properties): + """ + Sets the properties of this VersionedReportingTask. + The properties for the component. Properties whose value is not set will only contain the property name. + + :param properties: The properties of this VersionedReportingTask. + :type: dict(str, str) + """ + + self._properties = properties + + @property + def property_descriptors(self): + """ + Gets the property_descriptors of this VersionedReportingTask. + The property descriptors for the component. + + :return: The property_descriptors of this VersionedReportingTask. + :rtype: dict(str, VersionedPropertyDescriptor) + """ + return self._property_descriptors + + @property_descriptors.setter + def property_descriptors(self, property_descriptors): + """ + Sets the property_descriptors of this VersionedReportingTask. + The property descriptors for the component. + + :param property_descriptors: The property_descriptors of this VersionedReportingTask. + :type: dict(str, VersionedPropertyDescriptor) + """ + + self._property_descriptors = property_descriptors + + @property + def annotation_data(self): + """ + Gets the annotation_data of this VersionedReportingTask. + The annotation for the reporting task. This is how the custom UI relays configuration to the reporting task. + + :return: The annotation_data of this VersionedReportingTask. + :rtype: str + """ + return self._annotation_data + + @annotation_data.setter + def annotation_data(self, annotation_data): + """ + Sets the annotation_data of this VersionedReportingTask. + The annotation for the reporting task. This is how the custom UI relays configuration to the reporting task. + + :param annotation_data: The annotation_data of this VersionedReportingTask. + :type: str + """ + + self._annotation_data = annotation_data + + @property + def scheduled_state(self): + """ + Gets the scheduled_state of this VersionedReportingTask. + Indicates the scheduled state for the Reporting Task + + :return: The scheduled_state of this VersionedReportingTask. + :rtype: str + """ + return self._scheduled_state + + @scheduled_state.setter + def scheduled_state(self, scheduled_state): + """ + Sets the scheduled_state of this VersionedReportingTask. + Indicates the scheduled state for the Reporting Task + + :param scheduled_state: The scheduled_state of this VersionedReportingTask. + :type: str + """ + allowed_values = ["ENABLED", "DISABLED", "RUNNING"] + if scheduled_state not in allowed_values: + raise ValueError( + "Invalid value for `scheduled_state` ({0}), must be one of {1}" + .format(scheduled_state, allowed_values) + ) + + self._scheduled_state = scheduled_state + + @property + def scheduling_period(self): + """ + Gets the scheduling_period of this VersionedReportingTask. + The frequency with which to schedule the reporting task. The format of the value will depend on the value of schedulingStrategy. + + :return: The scheduling_period of this VersionedReportingTask. + :rtype: str + """ + return self._scheduling_period + + @scheduling_period.setter + def scheduling_period(self, scheduling_period): + """ + Sets the scheduling_period of this VersionedReportingTask. + The frequency with which to schedule the reporting task. The format of the value will depend on the value of schedulingStrategy. + + :param scheduling_period: The scheduling_period of this VersionedReportingTask. + :type: str + """ + + self._scheduling_period = scheduling_period + + @property + def scheduling_strategy(self): + """ + Gets the scheduling_strategy of this VersionedReportingTask. + Indicates scheduling strategy that should dictate how the reporting task is triggered. + + :return: The scheduling_strategy of this VersionedReportingTask. + :rtype: str + """ + return self._scheduling_strategy + + @scheduling_strategy.setter + def scheduling_strategy(self, scheduling_strategy): + """ + Sets the scheduling_strategy of this VersionedReportingTask. + Indicates scheduling strategy that should dictate how the reporting task is triggered. + + :param scheduling_strategy: The scheduling_strategy of this VersionedReportingTask. + :type: str + """ + + self._scheduling_strategy = scheduling_strategy + + @property + def component_type(self): + """ + Gets the component_type of this VersionedReportingTask. + + :return: The component_type of this VersionedReportingTask. + :rtype: str + """ + return self._component_type + + @component_type.setter + def component_type(self, component_type): + """ + Sets the component_type of this VersionedReportingTask. + + :param component_type: The component_type of this VersionedReportingTask. + :type: str + """ + allowed_values = ["CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT"] + if component_type not in allowed_values: + raise ValueError( + "Invalid value for `component_type` ({0}), must be one of {1}" + .format(component_type, allowed_values) + ) + + self._component_type = component_type + + @property + def group_identifier(self): + """ + Gets the group_identifier of this VersionedReportingTask. + The ID of the Process Group that this component belongs to + + :return: The group_identifier of this VersionedReportingTask. + :rtype: str + """ + return self._group_identifier + + @group_identifier.setter + def group_identifier(self, group_identifier): + """ + Sets the group_identifier of this VersionedReportingTask. + The ID of the Process Group that this component belongs to + + :param group_identifier: The group_identifier of this VersionedReportingTask. + :type: str + """ + + self._group_identifier = group_identifier + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, VersionedReportingTask): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/versioned_reporting_task_snapshot.py b/nipyapi/nifi/models/versioned_reporting_task_snapshot.py new file mode 100644 index 00000000..416f8ee5 --- /dev/null +++ b/nipyapi/nifi/models/versioned_reporting_task_snapshot.py @@ -0,0 +1,153 @@ +# coding: utf-8 + +""" + NiFi Rest API + + The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. + + OpenAPI spec version: 1.27.0 + Contact: dev@nifi.apache.org + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from pprint import pformat +from six import iteritems +import re + + +class VersionedReportingTaskSnapshot(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'reporting_tasks': 'list[VersionedReportingTask]', + 'controller_services': 'list[VersionedControllerService]' + } + + attribute_map = { + 'reporting_tasks': 'reportingTasks', + 'controller_services': 'controllerServices' + } + + def __init__(self, reporting_tasks=None, controller_services=None): + """ + VersionedReportingTaskSnapshot - a model defined in Swagger + """ + + self._reporting_tasks = None + self._controller_services = None + + if reporting_tasks is not None: + self.reporting_tasks = reporting_tasks + if controller_services is not None: + self.controller_services = controller_services + + @property + def reporting_tasks(self): + """ + Gets the reporting_tasks of this VersionedReportingTaskSnapshot. + The reporting tasks + + :return: The reporting_tasks of this VersionedReportingTaskSnapshot. + :rtype: list[VersionedReportingTask] + """ + return self._reporting_tasks + + @reporting_tasks.setter + def reporting_tasks(self, reporting_tasks): + """ + Sets the reporting_tasks of this VersionedReportingTaskSnapshot. + The reporting tasks + + :param reporting_tasks: The reporting_tasks of this VersionedReportingTaskSnapshot. + :type: list[VersionedReportingTask] + """ + + self._reporting_tasks = reporting_tasks + + @property + def controller_services(self): + """ + Gets the controller_services of this VersionedReportingTaskSnapshot. + The controller services + + :return: The controller_services of this VersionedReportingTaskSnapshot. + :rtype: list[VersionedControllerService] + """ + return self._controller_services + + @controller_services.setter + def controller_services(self, controller_services): + """ + Sets the controller_services of this VersionedReportingTaskSnapshot. + The controller services + + :param controller_services: The controller_services of this VersionedReportingTaskSnapshot. + :type: list[VersionedControllerService] + """ + + self._controller_services = controller_services + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, VersionedReportingTaskSnapshot): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/nipyapi/nifi/models/versioned_resource_definition.py b/nipyapi/nifi/models/versioned_resource_definition.py index f5c0abed..757bd504 100644 --- a/nipyapi/nifi/models/versioned_resource_definition.py +++ b/nipyapi/nifi/models/versioned_resource_definition.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/nifi/rest.py b/nipyapi/nifi/rest.py index c5b11c92..0a0c6eee 100644 --- a/nipyapi/nifi/rest.py +++ b/nipyapi/nifi/rest.py @@ -5,7 +5,7 @@ The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service. - OpenAPI spec version: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/__init__.py b/nipyapi/registry/__init__.py index 63127815..5185c1af 100644 --- a/nipyapi/registry/__init__.py +++ b/nipyapi/registry/__init__.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/api_client.py b/nipyapi/registry/api_client.py index 1db2fc71..587fc8cd 100644 --- a/nipyapi/registry/api_client.py +++ b/nipyapi/registry/api_client.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -235,6 +235,10 @@ def deserialize(self, response, response_type): if response_type == "file": return self.__deserialize_file(response) + # handle plain text response + if response_type == "str": + return response.data + # fetch data from response object try: data = json.loads(response.data) diff --git a/nipyapi/registry/apis/about_api.py b/nipyapi/registry/apis/about_api.py index fe6812f9..9f0b56c2 100644 --- a/nipyapi/registry/apis/about_api.py +++ b/nipyapi/registry/apis/about_api.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/access_api.py b/nipyapi/registry/apis/access_api.py index 513551f5..092a4450 100644 --- a/nipyapi/registry/apis/access_api.py +++ b/nipyapi/registry/apis/access_api.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/bucket_bundles_api.py b/nipyapi/registry/apis/bucket_bundles_api.py index 0624b870..492ffcce 100644 --- a/nipyapi/registry/apis/bucket_bundles_api.py +++ b/nipyapi/registry/apis/bucket_bundles_api.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -40,7 +40,7 @@ def __init__(self, api_client=None): config.api_client = ApiClient() self.api_client = config.api_client - def create_extension_bundle_version(self, bucket_id, bundle_type, **kwargs): + def create_extension_bundle_version(self, bucket_id, bundle_type, file, **kwargs): """ Create extension bundle version Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. @@ -50,24 +50,26 @@ def create_extension_bundle_version(self, bucket_id, bundle_type, **kwargs): >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.create_extension_bundle_version(bucket_id, bundle_type, callback=callback_function) + >>> thread = api.create_extension_bundle_version(bucket_id, bundle_type, file, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str bucket_id: The bucket identifier (required) :param str bundle_type: The type of the bundle (required) + :param file file: The binary content of the bundle file being uploaded. (required) + :param str sha256: Optional sha256 of the provided bundle :return: BundleVersion If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('callback'): - return self.create_extension_bundle_version_with_http_info(bucket_id, bundle_type, **kwargs) + return self.create_extension_bundle_version_with_http_info(bucket_id, bundle_type, file, **kwargs) else: - (data) = self.create_extension_bundle_version_with_http_info(bucket_id, bundle_type, **kwargs) + (data) = self.create_extension_bundle_version_with_http_info(bucket_id, bundle_type, file, **kwargs) return data - def create_extension_bundle_version_with_http_info(self, bucket_id, bundle_type, **kwargs): + def create_extension_bundle_version_with_http_info(self, bucket_id, bundle_type, file, **kwargs): """ Create extension bundle version Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve. @@ -77,18 +79,20 @@ def create_extension_bundle_version_with_http_info(self, bucket_id, bundle_type, >>> def callback_function(response): >>> pprint(response) >>> - >>> thread = api.create_extension_bundle_version_with_http_info(bucket_id, bundle_type, callback=callback_function) + >>> thread = api.create_extension_bundle_version_with_http_info(bucket_id, bundle_type, file, callback=callback_function) :param callback function: The callback function for asynchronous request. (optional) :param str bucket_id: The bucket identifier (required) :param str bundle_type: The type of the bundle (required) + :param file file: The binary content of the bundle file being uploaded. (required) + :param str sha256: Optional sha256 of the provided bundle :return: BundleVersion If the method is called asynchronously, returns the request thread. """ - all_params = ['bucket_id', 'bundle_type'] + all_params = ['bucket_id', 'bundle_type', 'file', 'sha256'] all_params.append('callback') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -109,6 +113,9 @@ def create_extension_bundle_version_with_http_info(self, bucket_id, bundle_type, # verify the required parameter 'bundle_type' is set if ('bundle_type' not in params) or (params['bundle_type'] is None): raise ValueError("Missing the required parameter `bundle_type` when calling `create_extension_bundle_version`") + # verify the required parameter 'file' is set + if ('file' not in params) or (params['file'] is None): + raise ValueError("Missing the required parameter `file` when calling `create_extension_bundle_version`") collection_formats = {} @@ -125,6 +132,10 @@ def create_extension_bundle_version_with_http_info(self, bucket_id, bundle_type, form_params = [] local_var_files = {} + if 'file' in params: + local_var_files['file'] = params['file'] + if 'sha256' in params: + form_params.append(('sha256', params['sha256'])) body_params = None # HTTP header `Accept` diff --git a/nipyapi/registry/apis/bucket_flows_api.py b/nipyapi/registry/apis/bucket_flows_api.py index 4b192a82..22bcc3b3 100644 --- a/nipyapi/registry/apis/bucket_flows_api.py +++ b/nipyapi/registry/apis/bucket_flows_api.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/buckets_api.py b/nipyapi/registry/apis/buckets_api.py index f7f8c54d..14686fd9 100644 --- a/nipyapi/registry/apis/buckets_api.py +++ b/nipyapi/registry/apis/buckets_api.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/bundles_api.py b/nipyapi/registry/apis/bundles_api.py index 730e34bf..17e3a798 100644 --- a/nipyapi/registry/apis/bundles_api.py +++ b/nipyapi/registry/apis/bundles_api.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/config_api.py b/nipyapi/registry/apis/config_api.py index 828577d7..fdbf21b4 100644 --- a/nipyapi/registry/apis/config_api.py +++ b/nipyapi/registry/apis/config_api.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/extension_repository_api.py b/nipyapi/registry/apis/extension_repository_api.py index 093b4b7a..52e102a9 100644 --- a/nipyapi/registry/apis/extension_repository_api.py +++ b/nipyapi/registry/apis/extension_repository_api.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/extensions_api.py b/nipyapi/registry/apis/extensions_api.py index 0b0cffdb..51155572 100644 --- a/nipyapi/registry/apis/extensions_api.py +++ b/nipyapi/registry/apis/extensions_api.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/flows_api.py b/nipyapi/registry/apis/flows_api.py index 1d118479..b0976f79 100644 --- a/nipyapi/registry/apis/flows_api.py +++ b/nipyapi/registry/apis/flows_api.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/items_api.py b/nipyapi/registry/apis/items_api.py index b24a2dc8..480d805a 100644 --- a/nipyapi/registry/apis/items_api.py +++ b/nipyapi/registry/apis/items_api.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/policies_api.py b/nipyapi/registry/apis/policies_api.py index e0b2d7e0..6674b0c7 100644 --- a/nipyapi/registry/apis/policies_api.py +++ b/nipyapi/registry/apis/policies_api.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/apis/tenants_api.py b/nipyapi/registry/apis/tenants_api.py index f91b9f59..f2389777 100644 --- a/nipyapi/registry/apis/tenants_api.py +++ b/nipyapi/registry/apis/tenants_api.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/configuration.py b/nipyapi/registry/configuration.py index e4edcd84..ad18aa39 100644 --- a/nipyapi/registry/configuration.py +++ b/nipyapi/registry/configuration.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -64,7 +64,7 @@ def __init__(self): # Logging Settings self.logger = {} - self.logger["package_logger"] = logging.getLogger("swagger_client") + self.logger["package_logger"] = logging.getLogger("registry") self.logger["urllib3_logger"] = logging.getLogger("urllib3") # Log format self.logger_format = '%(asctime)s %(levelname)s %(message)s' @@ -252,6 +252,6 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 1.23.2\n"\ + "Version of the API: 1.27.0\n"\ "SDK Package Version: 1.0.0".\ format(env=sys.platform, pyversion=sys.version) diff --git a/nipyapi/registry/models/__init__.py b/nipyapi/registry/models/__init__.py index 9509fd3a..b8724a82 100644 --- a/nipyapi/registry/models/__init__.py +++ b/nipyapi/registry/models/__init__.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/access_policy.py b/nipyapi/registry/models/access_policy.py index c4bd8fa4..614c4945 100644 --- a/nipyapi/registry/models/access_policy.py +++ b/nipyapi/registry/models/access_policy.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/access_policy_summary.py b/nipyapi/registry/models/access_policy_summary.py index 0a147804..7dbabaa0 100644 --- a/nipyapi/registry/models/access_policy_summary.py +++ b/nipyapi/registry/models/access_policy_summary.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/allowable_value.py b/nipyapi/registry/models/allowable_value.py index 4e99b65c..24e378a6 100644 --- a/nipyapi/registry/models/allowable_value.py +++ b/nipyapi/registry/models/allowable_value.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/attribute.py b/nipyapi/registry/models/attribute.py index 68e524be..6ef2753f 100644 --- a/nipyapi/registry/models/attribute.py +++ b/nipyapi/registry/models/attribute.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/batch_size.py b/nipyapi/registry/models/batch_size.py index d0b9a2f7..14896700 100644 --- a/nipyapi/registry/models/batch_size.py +++ b/nipyapi/registry/models/batch_size.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/bucket.py b/nipyapi/registry/models/bucket.py index 14e9e88f..bbe13ea4 100644 --- a/nipyapi/registry/models/bucket.py +++ b/nipyapi/registry/models/bucket.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/bucket_item.py b/nipyapi/registry/models/bucket_item.py index 3f5c9869..f7cee0af 100644 --- a/nipyapi/registry/models/bucket_item.py +++ b/nipyapi/registry/models/bucket_item.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/build_info.py b/nipyapi/registry/models/build_info.py index 8e6130d0..7f8a67d3 100644 --- a/nipyapi/registry/models/build_info.py +++ b/nipyapi/registry/models/build_info.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/bundle.py b/nipyapi/registry/models/bundle.py index 353e55e5..ca0fb684 100644 --- a/nipyapi/registry/models/bundle.py +++ b/nipyapi/registry/models/bundle.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/bundle_info.py b/nipyapi/registry/models/bundle_info.py index f948f1df..bfa6962c 100644 --- a/nipyapi/registry/models/bundle_info.py +++ b/nipyapi/registry/models/bundle_info.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/bundle_version.py b/nipyapi/registry/models/bundle_version.py index fa5271ce..56b4f1e9 100644 --- a/nipyapi/registry/models/bundle_version.py +++ b/nipyapi/registry/models/bundle_version.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/bundle_version_dependency.py b/nipyapi/registry/models/bundle_version_dependency.py index 92fed900..c49b8c36 100644 --- a/nipyapi/registry/models/bundle_version_dependency.py +++ b/nipyapi/registry/models/bundle_version_dependency.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/bundle_version_metadata.py b/nipyapi/registry/models/bundle_version_metadata.py index ab7ed7a6..f6e268ad 100644 --- a/nipyapi/registry/models/bundle_version_metadata.py +++ b/nipyapi/registry/models/bundle_version_metadata.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/component_difference.py b/nipyapi/registry/models/component_difference.py index 106db2cb..109f10bb 100644 --- a/nipyapi/registry/models/component_difference.py +++ b/nipyapi/registry/models/component_difference.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/component_difference_group.py b/nipyapi/registry/models/component_difference_group.py index 2d9e6354..8c6849b1 100644 --- a/nipyapi/registry/models/component_difference_group.py +++ b/nipyapi/registry/models/component_difference_group.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/connectable_component.py b/nipyapi/registry/models/connectable_component.py index b6a47dab..69dafc89 100644 --- a/nipyapi/registry/models/connectable_component.py +++ b/nipyapi/registry/models/connectable_component.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/controller_service_api.py b/nipyapi/registry/models/controller_service_api.py index b0e1acc8..36e3cc77 100644 --- a/nipyapi/registry/models/controller_service_api.py +++ b/nipyapi/registry/models/controller_service_api.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/controller_service_definition.py b/nipyapi/registry/models/controller_service_definition.py index 88f5b376..8b38f179 100644 --- a/nipyapi/registry/models/controller_service_definition.py +++ b/nipyapi/registry/models/controller_service_definition.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/current_user.py b/nipyapi/registry/models/current_user.py index 349d6c4f..a6c2464b 100644 --- a/nipyapi/registry/models/current_user.py +++ b/nipyapi/registry/models/current_user.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/default_schedule.py b/nipyapi/registry/models/default_schedule.py index 2c003318..5ccba887 100644 --- a/nipyapi/registry/models/default_schedule.py +++ b/nipyapi/registry/models/default_schedule.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/default_settings.py b/nipyapi/registry/models/default_settings.py index c1119c17..800e28ce 100644 --- a/nipyapi/registry/models/default_settings.py +++ b/nipyapi/registry/models/default_settings.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/dependency.py b/nipyapi/registry/models/dependency.py index 24a98744..bafe7746 100644 --- a/nipyapi/registry/models/dependency.py +++ b/nipyapi/registry/models/dependency.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/dependent_values.py b/nipyapi/registry/models/dependent_values.py index 4891ce6c..2508994a 100644 --- a/nipyapi/registry/models/dependent_values.py +++ b/nipyapi/registry/models/dependent_values.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/deprecation_notice.py b/nipyapi/registry/models/deprecation_notice.py index b433399c..52395739 100644 --- a/nipyapi/registry/models/deprecation_notice.py +++ b/nipyapi/registry/models/deprecation_notice.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/dynamic_property.py b/nipyapi/registry/models/dynamic_property.py index 8db02d75..a0e9bbad 100644 --- a/nipyapi/registry/models/dynamic_property.py +++ b/nipyapi/registry/models/dynamic_property.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/dynamic_relationship.py b/nipyapi/registry/models/dynamic_relationship.py index 403b9051..ea72c41f 100644 --- a/nipyapi/registry/models/dynamic_relationship.py +++ b/nipyapi/registry/models/dynamic_relationship.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension.py b/nipyapi/registry/models/extension.py index 313a976a..48c9e79a 100644 --- a/nipyapi/registry/models/extension.py +++ b/nipyapi/registry/models/extension.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_bundle.py b/nipyapi/registry/models/extension_bundle.py index 2bcef14a..097c911a 100644 --- a/nipyapi/registry/models/extension_bundle.py +++ b/nipyapi/registry/models/extension_bundle.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_filter_params.py b/nipyapi/registry/models/extension_filter_params.py index 7d1ed2a7..fc2e5948 100644 --- a/nipyapi/registry/models/extension_filter_params.py +++ b/nipyapi/registry/models/extension_filter_params.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_metadata.py b/nipyapi/registry/models/extension_metadata.py index 1cce4acd..75095408 100644 --- a/nipyapi/registry/models/extension_metadata.py +++ b/nipyapi/registry/models/extension_metadata.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_metadata_container.py b/nipyapi/registry/models/extension_metadata_container.py index bdcf2250..8f6eb64f 100644 --- a/nipyapi/registry/models/extension_metadata_container.py +++ b/nipyapi/registry/models/extension_metadata_container.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_repo_artifact.py b/nipyapi/registry/models/extension_repo_artifact.py index f01e956a..f5bf63f1 100644 --- a/nipyapi/registry/models/extension_repo_artifact.py +++ b/nipyapi/registry/models/extension_repo_artifact.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_repo_bucket.py b/nipyapi/registry/models/extension_repo_bucket.py index d5768ddb..9d4b0eeb 100644 --- a/nipyapi/registry/models/extension_repo_bucket.py +++ b/nipyapi/registry/models/extension_repo_bucket.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_repo_group.py b/nipyapi/registry/models/extension_repo_group.py index 2f45a819..3e31b68c 100644 --- a/nipyapi/registry/models/extension_repo_group.py +++ b/nipyapi/registry/models/extension_repo_group.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_repo_version.py b/nipyapi/registry/models/extension_repo_version.py index 501d12a8..0b504a0f 100644 --- a/nipyapi/registry/models/extension_repo_version.py +++ b/nipyapi/registry/models/extension_repo_version.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/extension_repo_version_summary.py b/nipyapi/registry/models/extension_repo_version_summary.py index 8d6e1d36..538ef781 100644 --- a/nipyapi/registry/models/extension_repo_version_summary.py +++ b/nipyapi/registry/models/extension_repo_version_summary.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/external_controller_service_reference.py b/nipyapi/registry/models/external_controller_service_reference.py index 094c515f..7f6f2545 100644 --- a/nipyapi/registry/models/external_controller_service_reference.py +++ b/nipyapi/registry/models/external_controller_service_reference.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/fields.py b/nipyapi/registry/models/fields.py index 9b65c851..a1ca3691 100644 --- a/nipyapi/registry/models/fields.py +++ b/nipyapi/registry/models/fields.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/jaxb_link.py b/nipyapi/registry/models/jaxb_link.py index 01216a3f..379ac5ba 100644 --- a/nipyapi/registry/models/jaxb_link.py +++ b/nipyapi/registry/models/jaxb_link.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/model_property.py b/nipyapi/registry/models/model_property.py index 97d35788..8666d1d6 100644 --- a/nipyapi/registry/models/model_property.py +++ b/nipyapi/registry/models/model_property.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/parameter_provider_reference.py b/nipyapi/registry/models/parameter_provider_reference.py index 6ba849e1..1f1f45c8 100644 --- a/nipyapi/registry/models/parameter_provider_reference.py +++ b/nipyapi/registry/models/parameter_provider_reference.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/permissions.py b/nipyapi/registry/models/permissions.py index b5e9a254..f6e8070c 100644 --- a/nipyapi/registry/models/permissions.py +++ b/nipyapi/registry/models/permissions.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/position.py b/nipyapi/registry/models/position.py index fa7ab98d..9bff693e 100644 --- a/nipyapi/registry/models/position.py +++ b/nipyapi/registry/models/position.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/provided_service_api.py b/nipyapi/registry/models/provided_service_api.py index f48ef3c9..b2ca2cd5 100644 --- a/nipyapi/registry/models/provided_service_api.py +++ b/nipyapi/registry/models/provided_service_api.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/registry_about.py b/nipyapi/registry/models/registry_about.py index d8f1124d..2fd072ed 100644 --- a/nipyapi/registry/models/registry_about.py +++ b/nipyapi/registry/models/registry_about.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/registry_configuration.py b/nipyapi/registry/models/registry_configuration.py index 9319bb06..2881ac49 100644 --- a/nipyapi/registry/models/registry_configuration.py +++ b/nipyapi/registry/models/registry_configuration.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/relationship.py b/nipyapi/registry/models/relationship.py index d6869b3a..0a47c33c 100644 --- a/nipyapi/registry/models/relationship.py +++ b/nipyapi/registry/models/relationship.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/resource.py b/nipyapi/registry/models/resource.py index 353d85dc..86ff2b3e 100644 --- a/nipyapi/registry/models/resource.py +++ b/nipyapi/registry/models/resource.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/resource_definition.py b/nipyapi/registry/models/resource_definition.py index 8489cbbc..5fec19ea 100644 --- a/nipyapi/registry/models/resource_definition.py +++ b/nipyapi/registry/models/resource_definition.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/resource_permissions.py b/nipyapi/registry/models/resource_permissions.py index 520b1de4..72ffaa33 100644 --- a/nipyapi/registry/models/resource_permissions.py +++ b/nipyapi/registry/models/resource_permissions.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/restricted.py b/nipyapi/registry/models/restricted.py index 22a43b89..436c9f7f 100644 --- a/nipyapi/registry/models/restricted.py +++ b/nipyapi/registry/models/restricted.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/restriction.py b/nipyapi/registry/models/restriction.py index 18978557..61014c43 100644 --- a/nipyapi/registry/models/restriction.py +++ b/nipyapi/registry/models/restriction.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/revision_info.py b/nipyapi/registry/models/revision_info.py index f0116173..99c58d1f 100644 --- a/nipyapi/registry/models/revision_info.py +++ b/nipyapi/registry/models/revision_info.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/stateful.py b/nipyapi/registry/models/stateful.py index 08778b6b..4d39ce77 100644 --- a/nipyapi/registry/models/stateful.py +++ b/nipyapi/registry/models/stateful.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/system_resource_consideration.py b/nipyapi/registry/models/system_resource_consideration.py index 073567bf..74766699 100644 --- a/nipyapi/registry/models/system_resource_consideration.py +++ b/nipyapi/registry/models/system_resource_consideration.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/tag_count.py b/nipyapi/registry/models/tag_count.py index 0444bf20..d961b431 100644 --- a/nipyapi/registry/models/tag_count.py +++ b/nipyapi/registry/models/tag_count.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/tenant.py b/nipyapi/registry/models/tenant.py index 5d6879f1..8a84c98f 100644 --- a/nipyapi/registry/models/tenant.py +++ b/nipyapi/registry/models/tenant.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/user.py b/nipyapi/registry/models/user.py index b0d0a2b4..1a716891 100644 --- a/nipyapi/registry/models/user.py +++ b/nipyapi/registry/models/user.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/user_group.py b/nipyapi/registry/models/user_group.py index aa61fc32..d2dc112e 100644 --- a/nipyapi/registry/models/user_group.py +++ b/nipyapi/registry/models/user_group.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_connection.py b/nipyapi/registry/models/versioned_connection.py index d63c7a25..4b309ed4 100644 --- a/nipyapi/registry/models/versioned_connection.py +++ b/nipyapi/registry/models/versioned_connection.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_controller_service.py b/nipyapi/registry/models/versioned_controller_service.py index f95bb618..78984a7a 100644 --- a/nipyapi/registry/models/versioned_controller_service.py +++ b/nipyapi/registry/models/versioned_controller_service.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_flow.py b/nipyapi/registry/models/versioned_flow.py index 2628c5b4..1fc92d48 100644 --- a/nipyapi/registry/models/versioned_flow.py +++ b/nipyapi/registry/models/versioned_flow.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_flow_coordinates.py b/nipyapi/registry/models/versioned_flow_coordinates.py index 4d4a0a12..fde25560 100644 --- a/nipyapi/registry/models/versioned_flow_coordinates.py +++ b/nipyapi/registry/models/versioned_flow_coordinates.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_flow_difference.py b/nipyapi/registry/models/versioned_flow_difference.py index 0ffb5f61..fdb28cae 100644 --- a/nipyapi/registry/models/versioned_flow_difference.py +++ b/nipyapi/registry/models/versioned_flow_difference.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_flow_snapshot.py b/nipyapi/registry/models/versioned_flow_snapshot.py index b0dd3bad..be252038 100644 --- a/nipyapi/registry/models/versioned_flow_snapshot.py +++ b/nipyapi/registry/models/versioned_flow_snapshot.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_flow_snapshot_metadata.py b/nipyapi/registry/models/versioned_flow_snapshot_metadata.py index b816976b..def3134d 100644 --- a/nipyapi/registry/models/versioned_flow_snapshot_metadata.py +++ b/nipyapi/registry/models/versioned_flow_snapshot_metadata.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_funnel.py b/nipyapi/registry/models/versioned_funnel.py index f617eaaa..9beb8765 100644 --- a/nipyapi/registry/models/versioned_funnel.py +++ b/nipyapi/registry/models/versioned_funnel.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_label.py b/nipyapi/registry/models/versioned_label.py index 9b26ce37..8307b2be 100644 --- a/nipyapi/registry/models/versioned_label.py +++ b/nipyapi/registry/models/versioned_label.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_parameter.py b/nipyapi/registry/models/versioned_parameter.py index 7ee4748a..8b6bc933 100644 --- a/nipyapi/registry/models/versioned_parameter.py +++ b/nipyapi/registry/models/versioned_parameter.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_parameter_context.py b/nipyapi/registry/models/versioned_parameter_context.py index 6c861063..f0338660 100644 --- a/nipyapi/registry/models/versioned_parameter_context.py +++ b/nipyapi/registry/models/versioned_parameter_context.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_port.py b/nipyapi/registry/models/versioned_port.py index 9229ba72..89b08d97 100644 --- a/nipyapi/registry/models/versioned_port.py +++ b/nipyapi/registry/models/versioned_port.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_process_group.py b/nipyapi/registry/models/versioned_process_group.py index acb3b1db..122e0cf4 100644 --- a/nipyapi/registry/models/versioned_process_group.py +++ b/nipyapi/registry/models/versioned_process_group.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -53,8 +53,8 @@ class VersionedProcessGroup(object): 'default_back_pressure_data_size_threshold': 'str', 'log_file_suffix': 'str', 'component_type': 'str', - 'flow_file_concurrency': 'str', 'flow_file_outbound_policy': 'str', + 'flow_file_concurrency': 'str', 'group_identifier': 'str' } @@ -81,12 +81,12 @@ class VersionedProcessGroup(object): 'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', 'log_file_suffix': 'logFileSuffix', 'component_type': 'componentType', - 'flow_file_concurrency': 'flowFileConcurrency', 'flow_file_outbound_policy': 'flowFileOutboundPolicy', + 'flow_file_concurrency': 'flowFileConcurrency', 'group_identifier': 'groupIdentifier' } - def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None, controller_services=None, versioned_flow_coordinates=None, variables=None, parameter_context_name=None, default_flow_file_expiration=None, default_back_pressure_object_threshold=None, default_back_pressure_data_size_threshold=None, log_file_suffix=None, component_type=None, flow_file_concurrency=None, flow_file_outbound_policy=None, group_identifier=None): + def __init__(self, identifier=None, instance_identifier=None, name=None, comments=None, position=None, process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None, controller_services=None, versioned_flow_coordinates=None, variables=None, parameter_context_name=None, default_flow_file_expiration=None, default_back_pressure_object_threshold=None, default_back_pressure_data_size_threshold=None, log_file_suffix=None, component_type=None, flow_file_outbound_policy=None, flow_file_concurrency=None, group_identifier=None): """ VersionedProcessGroup - a model defined in Swagger """ @@ -113,8 +113,8 @@ def __init__(self, identifier=None, instance_identifier=None, name=None, comment self._default_back_pressure_data_size_threshold = None self._log_file_suffix = None self._component_type = None - self._flow_file_concurrency = None self._flow_file_outbound_policy = None + self._flow_file_concurrency = None self._group_identifier = None if identifier is not None: @@ -161,10 +161,10 @@ def __init__(self, identifier=None, instance_identifier=None, name=None, comment self.log_file_suffix = log_file_suffix if component_type is not None: self.component_type = component_type - if flow_file_concurrency is not None: - self.flow_file_concurrency = flow_file_concurrency if flow_file_outbound_policy is not None: self.flow_file_outbound_policy = flow_file_outbound_policy + if flow_file_concurrency is not None: + self.flow_file_concurrency = flow_file_concurrency if group_identifier is not None: self.group_identifier = group_identifier @@ -679,50 +679,50 @@ def component_type(self, component_type): self._component_type = component_type @property - def flow_file_concurrency(self): + def flow_file_outbound_policy(self): """ - Gets the flow_file_concurrency of this VersionedProcessGroup. - The configured FlowFile Concurrency for the Process Group + Gets the flow_file_outbound_policy of this VersionedProcessGroup. + The FlowFile Outbound Policy for the Process Group - :return: The flow_file_concurrency of this VersionedProcessGroup. + :return: The flow_file_outbound_policy of this VersionedProcessGroup. :rtype: str """ - return self._flow_file_concurrency + return self._flow_file_outbound_policy - @flow_file_concurrency.setter - def flow_file_concurrency(self, flow_file_concurrency): + @flow_file_outbound_policy.setter + def flow_file_outbound_policy(self, flow_file_outbound_policy): """ - Sets the flow_file_concurrency of this VersionedProcessGroup. - The configured FlowFile Concurrency for the Process Group + Sets the flow_file_outbound_policy of this VersionedProcessGroup. + The FlowFile Outbound Policy for the Process Group - :param flow_file_concurrency: The flow_file_concurrency of this VersionedProcessGroup. + :param flow_file_outbound_policy: The flow_file_outbound_policy of this VersionedProcessGroup. :type: str """ - self._flow_file_concurrency = flow_file_concurrency + self._flow_file_outbound_policy = flow_file_outbound_policy @property - def flow_file_outbound_policy(self): + def flow_file_concurrency(self): """ - Gets the flow_file_outbound_policy of this VersionedProcessGroup. - The FlowFile Outbound Policy for the Process Group + Gets the flow_file_concurrency of this VersionedProcessGroup. + The configured FlowFile Concurrency for the Process Group - :return: The flow_file_outbound_policy of this VersionedProcessGroup. + :return: The flow_file_concurrency of this VersionedProcessGroup. :rtype: str """ - return self._flow_file_outbound_policy + return self._flow_file_concurrency - @flow_file_outbound_policy.setter - def flow_file_outbound_policy(self, flow_file_outbound_policy): + @flow_file_concurrency.setter + def flow_file_concurrency(self, flow_file_concurrency): """ - Sets the flow_file_outbound_policy of this VersionedProcessGroup. - The FlowFile Outbound Policy for the Process Group + Sets the flow_file_concurrency of this VersionedProcessGroup. + The configured FlowFile Concurrency for the Process Group - :param flow_file_outbound_policy: The flow_file_outbound_policy of this VersionedProcessGroup. + :param flow_file_concurrency: The flow_file_concurrency of this VersionedProcessGroup. :type: str """ - self._flow_file_outbound_policy = flow_file_outbound_policy + self._flow_file_concurrency = flow_file_concurrency @property def group_identifier(self): diff --git a/nipyapi/registry/models/versioned_processor.py b/nipyapi/registry/models/versioned_processor.py index b0ca8d8d..50fa7244 100644 --- a/nipyapi/registry/models/versioned_processor.py +++ b/nipyapi/registry/models/versioned_processor.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_property_descriptor.py b/nipyapi/registry/models/versioned_property_descriptor.py index 83f804d3..c1484b37 100644 --- a/nipyapi/registry/models/versioned_property_descriptor.py +++ b/nipyapi/registry/models/versioned_property_descriptor.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_remote_group_port.py b/nipyapi/registry/models/versioned_remote_group_port.py index 39e09f51..4bf4eca0 100644 --- a/nipyapi/registry/models/versioned_remote_group_port.py +++ b/nipyapi/registry/models/versioned_remote_group_port.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_remote_process_group.py b/nipyapi/registry/models/versioned_remote_process_group.py index a8c067b8..e2838d9d 100644 --- a/nipyapi/registry/models/versioned_remote_process_group.py +++ b/nipyapi/registry/models/versioned_remote_process_group.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/models/versioned_resource_definition.py b/nipyapi/registry/models/versioned_resource_definition.py index 2cedcb56..0df2792c 100644 --- a/nipyapi/registry/models/versioned_resource_definition.py +++ b/nipyapi/registry/models/versioned_resource_definition.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/registry/rest.py b/nipyapi/registry/rest.py index 9a43f7b5..72237b2f 100644 --- a/nipyapi/registry/rest.py +++ b/nipyapi/registry/rest.py @@ -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: 1.23.2 + OpenAPI spec version: 1.27.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/nipyapi/security.py b/nipyapi/security.py index f10598a9..60c7b692 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -721,7 +721,7 @@ def create_access_policy(resource, action, r_id=None, service="nifi"): ) -# pylint: disable=R0913 +# pylint: disable=R0913,R0917 def set_service_ssl_context( service="nifi", ca_file=None, diff --git a/nipyapi/utils.py b/nipyapi/utils.py index 330ceabd..fcf145e5 100644 --- a/nipyapi/utils.py +++ b/nipyapi/utils.py @@ -18,8 +18,6 @@ from packaging import version import six from ruamel.yaml import YAML -import docker -from docker.errors import ImageNotFound import requests from requests.models import Response from future.utils import raise_from as _raise @@ -36,6 +34,13 @@ log = logging.getLogger(__name__) +try: + import docker + from docker.errors import ImageNotFound + DOCKER_AVAILABLE = True +except ImportError: + DOCKER_AVAILABLE = False + def dump(obj, mode='json'): """ @@ -345,13 +350,19 @@ def set_endpoint(endpoint_url, ssl=False, login=False, return True -# pylint: disable=R0913,R0902 -class DockerContainer: +# pylint: disable=R0913,R0902,R0917 +class DockerContainer(): """ Helper class for Docker container automation without using Ansible """ def __init__(self, name=None, image_name=None, image_tag=None, ports=None, env=None, volumes=None, test_url=None, endpoint=None): + if not DOCKER_AVAILABLE: + raise ImportError( + "The 'docker' package is required for this class. " + "Please install nipyapi with the 'demo' extra: " + "pip install nipyapi[demo]" + ) self.name = name self.image_name = image_name self.image_tag = image_tag @@ -396,6 +407,13 @@ def start_docker_containers(docker_containers, network_name='demo'): Returns: Nothing """ + if not DOCKER_AVAILABLE: + raise ImportError( + "The 'docker' package is required for this function. " + "Please install nipyapi with the 'demo' extra: " + "pip install nipyapi[demo]" + ) + log.info("Creating Docker client using Environment Variables") d_client = docker.from_env() diff --git a/nipyapi/versioning.py b/nipyapi/versioning.py index 6bd985ee..2b40721e 100644 --- a/nipyapi/versioning.py +++ b/nipyapi/versioning.py @@ -217,7 +217,7 @@ def get_flow_in_bucket(bucket_id, identifier, identifier_type='name', obj, identifier, identifier_type, greedy=greedy) -# pylint: disable=R0913 +# pylint: disable=R0913,R0917 def save_flow_ver(process_group, registry_client, bucket, flow_name=None, flow_id=None, comment='', desc='', refresh=True, force=False): @@ -696,6 +696,7 @@ def import_flow_version(bucket_id, encoded_flow=None, file_path=None, ) +# pylint: disable=R0913,R0917 def deploy_flow_version(parent_id, location, bucket_id, flow_id, reg_client_id, version=None): """ diff --git a/requirements.txt b/requirements.txt index b8af65ba..5ef01d5b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -22,7 +22,7 @@ pysocks>=1.7.1 ruamel.yaml<0.18 # Demo deployment automation -docker>=2.5.1 +docker>=2.5.1; extra == "demo" # xml to json parsing xmltodict>=0.12.0 diff --git a/requirements_dev.txt b/requirements_dev.txt index f58328fc..44d0f5e6 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -26,6 +26,5 @@ sphinx_rtd_theme>=0.2.5b1 # Code Deps cryptography>=2.1.2 -py>=1.11.0 randomize>=0.13 certifi>=2017.7.27.1 diff --git a/resources/client_gen/api_defs/nifi-1.27.0.json b/resources/client_gen/api_defs/nifi-1.27.0.json new file mode 100644 index 00000000..cdf5a50b --- /dev/null +++ b/resources/client_gen/api_defs/nifi-1.27.0.json @@ -0,0 +1,26499 @@ +{ + "swagger" : "2.0", + "info" : { + "description" : "The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and\n stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,\n definitions of the expected input and output, potential response codes, and the authorizations required\n to invoke each service.", + "version" : "1.27.0", + "title" : "NiFi Rest API", + "contact" : { + "url" : "https://nifi.apache.org", + "email" : "dev@nifi.apache.org" + }, + "license" : { + "name" : "Apache 2.0", + "url" : "http://www.apache.org/licenses/LICENSE-2.0.html" + } + }, + "basePath" : "/nifi-api", + "tags" : [ { + "name" : "access", + "description" : "Endpoints for obtaining an access token or checking access status." + }, { + "name" : "connections", + "description" : "Endpoint for managing a Connection." + }, { + "name" : "controller", + "description" : "Provides realtime command and control of this NiFi instance" + }, { + "name" : "controller-services", + "description" : "Endpoint for managing a Controller Service." + }, { + "name" : "counters", + "description" : "Endpoint for managing counters." + }, { + "name" : "data-transfer", + "description" : "Supports data transfers with this NiFi using HTTP based site to site" + }, { + "name" : "flow", + "description" : "Endpoint for accessing the flow structure and component status." + }, { + "name" : "flowfile-queues", + "description" : "Endpoint for managing a FlowFile Queue." + }, { + "name" : "funnel", + "description" : "Endpoint for managing a Funnel." + }, { + "name" : "input-ports", + "description" : "Endpoint for managing an Input Port." + }, { + "name" : "labels", + "description" : "Endpoint for managing a Label." + }, { + "name" : "output-ports", + "description" : "Endpoint for managing an Output Port." + }, { + "name" : "parameter-contexts", + "description" : "Endpoint for managing version control for a flow" + }, { + "name" : "parameter-providers", + "description" : "Endpoint for managing a Parameter Provider." + }, { + "name" : "policies", + "description" : "Endpoint for managing access policies." + }, { + "name" : "process-groups", + "description" : "Endpoint for managing a Process Group." + }, { + "name" : "processors", + "description" : "Endpoint for managing a Processor." + }, { + "name" : "provenance", + "description" : "Endpoint for accessing data flow provenance." + }, { + "name" : "provenance-events", + "description" : "Endpoint for accessing data flow provenance." + }, { + "name" : "remote-process-groups", + "description" : "Endpoint for managing a Remote Process Group." + }, { + "name" : "reporting-tasks", + "description" : "Endpoint for managing a Reporting Task." + }, { + "name" : "resources", + "description" : "Provides the resources in this NiFi that can have access/authorization policies." + }, { + "name" : "site-to-site", + "description" : "Provide access to site to site with this NiFi" + }, { + "name" : "snippets", + "description" : "Endpoint for accessing dataflow snippets." + }, { + "name" : "system-diagnostics", + "description" : "Endpoint for accessing system diagnostics." + }, { + "name" : "templates", + "description" : "Endpoint for managing a Template." + }, { + "name" : "tenants", + "description" : "Endpoint for managing users and user groups." + }, { + "name" : "versions", + "description" : "Endpoint for managing version control for a flow" + } ], + "schemes" : [ "http", "https" ], + "paths" : { + "/access" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Gets the status the client's access", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getAccessStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Unable to determine access status because the client could not be authenticated." + }, + "403" : { + "description" : "Unable to determine access status because the client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to determine access status because NiFi is not in the appropriate state." + }, + "500" : { + "description" : "Unable to determine access status because an unexpected error occurred." + } + } + } + }, + "/access/config" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Retrieves the access configuration for this NiFi", + "description" : "", + "operationId" : "getLoginConfig", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessConfigurationEntity" + } + } + } + } + }, + "/access/kerberos" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation", + "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '. It is also stored in the browser as a cookie.", + "operationId" : "createAccessTokenFromTicket", + "consumes" : [ "text/plain" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO." + }, + "409" : { + "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login." + }, + "500" : { + "description" : "Unable to create access token because an unexpected error occurred." + } + } + } + }, + "/access/knox/callback" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Redirect/callback URI for processing the result of the Apache Knox login sequence.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "knoxCallback", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/knox/logout" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Performs a logout in the Apache Knox.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "knoxLogout", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/knox/request" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Initiates a request to authenticate through Apache Knox.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "knoxRequest", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/logout" : { + "delete" : { + "tags" : [ "access" ], + "summary" : "Performs a logout for other providers that have been issued a JWT.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "logOut", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "200" : { + "description" : "User was logged out successfully." + }, + "401" : { + "description" : "Authentication token provided was empty or not in the correct JWT format." + }, + "500" : { + "description" : "Client failed to log out." + } + } + } + }, + "/access/logout/complete" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "logOutComplete", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "200" : { + "description" : "User was logged out successfully." + }, + "401" : { + "description" : "Authentication token provided was empty or not in the correct JWT format." + }, + "500" : { + "description" : "Client failed to log out." + } + } + } + }, + "/access/token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Creates a token for accessing the REST API via username/password", + "description" : "The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. It is stored in the browser as a cookie, but also returned inthe response body to be stored/used by third party client scripts.", + "operationId" : "createAccessToken", + "consumes" : [ "application/x-www-form-urlencoded" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "username", + "in" : "formData", + "required" : false, + "type" : "string" + }, { + "name" : "password", + "in" : "formData", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login." + }, + "500" : { + "description" : "Unable to create access token because an unexpected error occurred." + } + } + } + }, + "/access/token/expiration" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Get expiration for current Access Token", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getAccessTokenExpiration", + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "Access Token Expiration found", + "schema" : { + "$ref" : "#/definitions/AccessTokenExpirationEntity" + } + }, + "401" : { + "description" : "Access Token not authorized" + }, + "409" : { + "description" : "Access Token not resolved" + } + } + } + }, + "/connections/{id}" : { + "get" : { + "tags" : [ "connections" ], + "summary" : "Gets a connection", + "description" : "", + "operationId" : "getConnection", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source - /{component-type}/{uuid}" : [ ] + }, { + "Read Destination - /{component-type}/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "connections" ], + "summary" : "Updates a connection", + "description" : "", + "operationId" : "updateConnection", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The connection configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + }, { + "Write New Destination - /{component-type}/{uuid} - if updating Destination" : [ ] + }, { + "Write Process Group - /process-groups/{uuid} - if updating Destination" : [ ] + } ] + }, + "delete" : { + "tags" : [ "connections" ], + "summary" : "Deletes a connection", + "description" : "", + "operationId" : "deleteConnection", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets a controller service", + "description" : "If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI.", + "operationId" : "getControllerService", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "name" : "uiOnly", + "in" : "query", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller-services" ], + "summary" : "Updates a controller service", + "description" : "", + "operationId" : "updateControllerService", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller-services" ], + "summary" : "Deletes a controller service", + "description" : "", + "operationId" : "removeControllerService", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + }, { + "Write - Parent Process Group if scoped by Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write - Controller if scoped by Controller - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/config/analysis" : { + "post" : { + "tags" : [ "controller-services" ], + "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", + "description" : "", + "operationId" : "analyzeConfiguration", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The configuration analysis request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ConfigurationAnalysisEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConfigurationAnalysisEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/config/verification-requests" : { + "post" : { + "tags" : [ "controller-services" ], + "summary" : "Performs verification of the Controller Service's configuration", + "description" : "This will initiate the process of verifying a given Controller Service configuration. This may be a long-running task. As a result, this endpoint will immediately return a ControllerServiceConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /controller-services/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /controller-services/{serviceId}/verification-requests/{requestId}.", + "operationId" : "submitConfigVerificationRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration verification request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/config/verification-requests/{requestId}" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Returns the Verification Request with the given ID", + "description" : "Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", + "operationId" : "getVerificationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Controller Service", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Verification Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller-services" ], + "summary" : "Deletes the Verification Request with the given ID", + "description" : "Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.", + "operationId" : "deleteVerificationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Controller Service", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Verification Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/controller-services/{id}/descriptors" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets a controller service property descriptor", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name to return the descriptor for.", + "required" : true, + "type" : "string" + }, { + "name" : "sensitive", + "in" : "query", + "description" : "Property Descriptor requested sensitive status", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/references" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets a controller service", + "description" : "", + "operationId" : "getControllerServiceReferences", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller-services/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller-services" ], + "summary" : "Updates a controller services references", + "description" : "", + "operationId" : "updateControllerServiceReferences", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service request update request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UpdateControllerServiceReferenceRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /{component-type}/{uuid} or /operate/{component-type}/{uuid} - For each referencing component specified" : [ ] + } ] + } + }, + "/controller-services/{id}/run-status" : { + "put" : { + "tags" : [ "controller-services" ], + "summary" : "Updates run status of a controller service", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid} or /operation/controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/state" : { + "get" : { + "tags" : [ "controller-services" ], + "summary" : "Gets the state for a controller service", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller-services/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "controller-services" ], + "summary" : "Clears the state for a controller service", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The controller service id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/controller/bulletin" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new bulletin", + "description" : "", + "operationId" : "createBulletin", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/BulletinEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/cluster" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets the contents of the cluster", + "description" : "Returns the contents of the cluster including all nodes and their status.", + "operationId" : "getCluster", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ClusterEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + } + }, + "/controller/cluster/nodes/{id}" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets a node in the cluster", + "description" : "", + "operationId" : "getNode", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The node id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller" ], + "summary" : "Updates a node in the cluster", + "description" : "", + "operationId" : "updateNode", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The node id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The node configuration. The only configuration that will be honored at this endpoint is the status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller" ], + "summary" : "Removes a node from the cluster", + "description" : "", + "operationId" : "deleteNode", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The node id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/NodeEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/config" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Retrieves the configuration for this NiFi Controller", + "description" : "", + "operationId" : "getControllerConfig", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerConfigurationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller" ], + "summary" : "Retrieves the configuration for this NiFi", + "description" : "", + "operationId" : "updateControllerConfig", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The controller configuration.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerConfigurationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerConfigurationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/controller-services" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new controller service", + "description" : "", + "operationId" : "createControllerService", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Controller Service is restricted - /restricted-components" : [ ] + } ] + } + }, + "/controller/history" : { + "delete" : { + "tags" : [ "controller" ], + "summary" : "Purges history", + "description" : "", + "operationId" : "deleteHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "endDate", + "in" : "query", + "description" : "Purge actions before this date/time.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/HistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/parameter-providers" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new parameter provider", + "description" : "", + "operationId" : "createParameterProvider", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The parameter provider configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterProviderEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterProviderEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Parameter Provider is restricted - /restricted-components" : [ ] + } ] + } + }, + "/controller/registry-clients" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets the listing of available flow registry clients", + "description" : "", + "operationId" : "getFlowRegistryClients", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowRegistryClientsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + }, + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new flow registry client", + "description" : "", + "operationId" : "createFlowRegistryClient", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The flow registry client configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/FlowRegistryClientEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowRegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/registry-clients/{id}" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets a flow registry client", + "description" : "", + "operationId" : "getFlowRegistryClient", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The flow registry client id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowRegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + }, + "put" : { + "tags" : [ "controller" ], + "summary" : "Updates a flow registry client", + "description" : "", + "operationId" : "updateFlowRegistryClient", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The flow registry client id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The flow registry client configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/FlowRegistryClientEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowRegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + }, + "delete" : { + "tags" : [ "controller" ], + "summary" : "Deletes a flow registry client", + "description" : "", + "operationId" : "deleteFlowRegistryClient", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The flow registry client id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowRegistryClientEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + } ] + } + }, + "/controller/registry-clients/{id}/descriptors" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets a flow registry client property descriptor", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The flow registry client id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name.", + "required" : true, + "type" : "string" + }, { + "name" : "sensitive", + "in" : "query", + "description" : "Property Descriptor requested sensitive status", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller/registry-clients/{uuid}" : [ ] + } ] + } + }, + "/controller/registry-types" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Retrieves the types of flow that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getRegistryClientTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowRegistryClientTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/controller/reporting-tasks" : { + "post" : { + "tags" : [ "controller" ], + "summary" : "Creates a new reporting task", + "description" : "", + "operationId" : "createReportingTask", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Reporting Task is restricted - /restricted-components" : [ ] + } ] + } + }, + "/controller/status/history" : { + "get" : { + "tags" : [ "controller" ], + "summary" : "Gets status history for the node", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getNodeStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /controller" : [ ] + } ] + } + }, + "/counters" : { + "get" : { + "tags" : [ "counters" ], + "summary" : "Gets the current counters for this NiFi", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getCounters", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CountersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /counters" : [ ] + } ] + } + }, + "/counters/{id}" : { + "put" : { + "tags" : [ "counters" ], + "summary" : "Updates the specified counter. This will reset the counter value to 0", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateCounter", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The id of the counter.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CounterEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /counters" : [ ] + } ] + } + }, + "/data-transfer/input-ports/{portId}/transactions/{transactionId}" : { + "put" : { + "tags" : [ "data-transfer" ], + "summary" : "Extend transaction TTL", + "description" : "", + "operationId" : "extendInputPortTransactionTTL", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "data-transfer" ], + "summary" : "Commit or cancel the specified transaction", + "description" : "", + "operationId" : "commitInputPortTransaction", + "consumes" : [ "application/octet-stream" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "responseCode", + "in" : "query", + "description" : "The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", + "required" : true, + "type" : "integer", + "format" : "int32" + }, { + "name" : "portId", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "description" : "The transaction id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files" : { + "post" : { + "tags" : [ "data-transfer" ], + "summary" : "Transfer flow files to the input port", + "description" : "", + "operationId" : "receiveFlowFiles", + "consumes" : [ "application/octet-stream" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/input-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/output-ports/{portId}/transactions/{transactionId}" : { + "put" : { + "tags" : [ "data-transfer" ], + "summary" : "Extend transaction TTL", + "description" : "", + "operationId" : "extendOutputPortTransactionTTL", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/output-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "data-transfer" ], + "summary" : "Commit or cancel the specified transaction", + "description" : "", + "operationId" : "commitOutputPortTransaction", + "consumes" : [ "application/octet-stream" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "responseCode", + "in" : "query", + "description" : "The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).", + "required" : true, + "type" : "integer", + "format" : "int32" + }, { + "name" : "checksum", + "in" : "query", + "description" : "A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.", + "required" : true, + "type" : "string" + }, { + "name" : "portId", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "description" : "The transaction id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/output-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files" : { + "get" : { + "tags" : [ "data-transfer" ], + "summary" : "Transfer flow files from the output port", + "description" : "", + "operationId" : "transferFlowFiles", + "consumes" : [ "*/*" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "portId", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + }, { + "name" : "transactionId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "There is no flow file to return.", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/output-ports/{uuid}" : [ ] + } ] + } + }, + "/data-transfer/{portType}/{portId}/transactions" : { + "post" : { + "tags" : [ "data-transfer" ], + "summary" : "Create a transaction to the specified output port or input port", + "description" : "", + "operationId" : "createPortTransaction", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "portType", + "in" : "path", + "description" : "The port type.", + "required" : true, + "type" : "string", + "enum" : [ "input-ports", "output-ports" ] + }, { + "name" : "portId", + "in" : "path", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TransactionResultEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + }, + "503" : { + "description" : "NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful" + } + }, + "security" : [ { + "Write - /data-transfer/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flow/about" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves details about this NiFi to put in the About dialog", + "description" : "", + "operationId" : "getAboutInfo", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AboutEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/banners" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the banners for this NiFi", + "description" : "", + "operationId" : "getBanners", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BannerEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/bulletin-board" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets current bulletins", + "description" : "", + "operationId" : "getBulletinBoard", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "after", + "in" : "query", + "description" : "Includes bulletins with an id after this value.", + "required" : false, + "type" : "string" + }, { + "name" : "sourceName", + "in" : "query", + "description" : "Includes bulletins originating from this sources whose name match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "message", + "in" : "query", + "description" : "Includes bulletins whose message that match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "sourceId", + "in" : "query", + "description" : "Includes bulletins originating from this sources whose id match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "groupId", + "in" : "query", + "description" : "Includes bulletins originating from this sources whose group id match this regular expression.", + "required" : false, + "type" : "string" + }, { + "name" : "limit", + "in" : "query", + "description" : "The number of bulletins to limit the response to.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BulletinBoardEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read - /{component-type}/{uuid} - For component specific bulletins" : [ ] + } ] + } + }, + "/flow/client-id" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Generates a client id.", + "description" : "", + "operationId" : "generateClientId", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/cluster/search-results" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Searches the cluster for a node with the specified address", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "searchCluster", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "q", + "in" : "query", + "description" : "Node address to search for.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ClusterSearchResultsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/cluster/summary" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "The cluster summary for this NiFi", + "description" : "", + "operationId" : "getClusterSummary", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ClusteSummaryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/config" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the configuration for this NiFi flow", + "description" : "", + "operationId" : "getFlowConfig", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowConfigurationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/connections/{id}/statistics" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets statistics for a connection", + "description" : "", + "operationId" : "getConnectionStatistics", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the statistics.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionStatisticsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/connections/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for a connection", + "description" : "", + "operationId" : "getConnectionStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/connections/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the status history for a connection", + "description" : "", + "operationId" : "getConnectionStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/controller-service-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of controller services that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getControllerServiceTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "serviceType", + "in" : "query", + "description" : "If specified, will only return controller services that are compatible with this type of service.", + "required" : false, + "type" : "string" + }, { + "name" : "serviceBundleGroup", + "in" : "query", + "description" : "If serviceType specified, is the bundle group of the serviceType.", + "required" : false, + "type" : "string" + }, { + "name" : "serviceBundleArtifact", + "in" : "query", + "description" : "If serviceType specified, is the bundle artifact of the serviceType.", + "required" : false, + "type" : "string" + }, { + "name" : "serviceBundleVersion", + "in" : "query", + "description" : "If serviceType specified, is the bundle version of the serviceType.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "typeFilter", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/controller/bulletins" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves Controller level bulletins", + "description" : "", + "operationId" : "getBulletins", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerBulletinsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read - /controller - For controller bulletins" : [ ] + }, { + "Read - /controller-services/{uuid} - For controller service bulletins" : [ ] + }, { + "Read - /reporting-tasks/{uuid} - For reporting task bulletins" : [ ] + } ] + } + }, + "/flow/controller/controller-services" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets controller services for reporting tasks", + "description" : "If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI.", + "operationId" : "getControllerServicesFromController", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "uiOnly", + "in" : "query", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "includeReferencingComponents", + "in" : "query", + "description" : "Whether or not to include services' referencing components in the response", + "required" : false, + "type" : "boolean", + "default" : true + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServicesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/current-user" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the user identity of the user making the request", + "description" : "", + "operationId" : "getCurrentUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CurrentUserEntity" + } + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets configuration history", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "queryHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "offset", + "in" : "query", + "description" : "The offset into the result set.", + "required" : true, + "type" : "string" + }, { + "name" : "count", + "in" : "query", + "description" : "The number of actions to return.", + "required" : true, + "type" : "string" + }, { + "name" : "sortColumn", + "in" : "query", + "description" : "The field to sort on.", + "required" : false, + "type" : "string" + }, { + "name" : "sortOrder", + "in" : "query", + "description" : "The direction to sort.", + "required" : false, + "type" : "string" + }, { + "name" : "startDate", + "in" : "query", + "description" : "Include actions after this date.", + "required" : false, + "type" : "string" + }, { + "name" : "endDate", + "in" : "query", + "description" : "Include actions before this date.", + "required" : false, + "type" : "string" + }, { + "name" : "userIdentity", + "in" : "query", + "description" : "Include actions performed by this user.", + "required" : false, + "type" : "string" + }, { + "name" : "sourceId", + "in" : "query", + "description" : "Include actions on this component.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/HistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/history/components/{componentId}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets configuration history for a component", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getComponentHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "componentId", + "in" : "path", + "description" : "The component id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Read underlying component - /{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flow/history/{id}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets an action", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getAction", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The action id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ActionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/input-ports/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for an input port", + "description" : "", + "operationId" : "getInputPortStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/metrics/{producer}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all metrics for the flow from a particular node", + "description" : "", + "operationId" : "getFlowMetrics", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "producer", + "in" : "path", + "description" : "The producer for flow file metrics. Each producer may have its own output format.", + "required" : true, + "type" : "string", + "enum" : [ "prometheus" ] + }, { + "name" : "includedRegistries", + "in" : "query", + "description" : "Set of included metrics registries", + "required" : false, + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "NIFI", "JVM", "BULLETIN", "CONNECTION" ] + }, + "collectionFormat" : "multi" + }, { + "name" : "sampleName", + "in" : "query", + "description" : "Regular Expression Pattern to be applied against the sample name field", + "required" : false, + "type" : "string" + }, { + "name" : "sampleLabelValue", + "in" : "query", + "description" : "Regular Expression Pattern to be applied against the sample label value field", + "required" : false, + "type" : "string" + }, { + "name" : "rootFieldName", + "in" : "query", + "description" : "Name of the first field of JSON object. Applicable for JSON producer only.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/output-ports/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for an output port", + "description" : "", + "operationId" : "getOutputPortStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/parameter-contexts" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all Parameter Contexts", + "description" : "", + "operationId" : "getParameterContexts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id} for each Parameter Context" : [ ] + } ] + } + }, + "/flow/parameter-provider-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of parameter providers that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getParameterProviderTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "type", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterProviderTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/parameter-providers" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all parameter providers", + "description" : "", + "operationId" : "getParameterProviders", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterProvidersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/prioritizers" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of prioritizers that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getPrioritizers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PrioritizerTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/process-groups/{id}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets a process group", + "description" : "If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI.", + "operationId" : "getFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "uiOnly", + "in" : "query", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupFlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + }, + "put" : { + "tags" : [ "flow" ], + "summary" : "Schedule or unschedule components in the specified Process Group.", + "description" : "", + "operationId" : "scheduleComponents", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ScheduleComponentsEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ScheduleComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled" : [ ] + } ] + } + }, + "/flow/process-groups/{id}/controller-services" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all controller services", + "description" : "If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI.", + "operationId" : "getControllerServicesFromGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeAncestorGroups", + "in" : "query", + "description" : "Whether or not to include parent/ancestor process groups", + "required" : false, + "type" : "boolean", + "default" : true + }, { + "name" : "includeDescendantGroups", + "in" : "query", + "description" : "Whether or not to include descendant process groups", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "includeReferencingComponents", + "in" : "query", + "description" : "Whether or not to include services' referencing components in the response", + "required" : false, + "type" : "boolean", + "default" : true + }, { + "name" : "uiOnly", + "in" : "query", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServicesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + }, + "put" : { + "tags" : [ "flow" ], + "summary" : "Enable or disable Controller Services in the specified Process Group.", + "description" : "", + "operationId" : "activateControllerServices", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ActivateControllerServicesEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ActivateControllerServicesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + }, { + "Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled" : [ ] + } ] + } + }, + "/flow/process-groups/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the status for a process group", + "description" : "The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.", + "operationId" : "getProcessGroupStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "recursive", + "in" : "query", + "description" : "Whether all descendant groups and the status of their content will be included. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/process-groups/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status history for a remote process group", + "description" : "", + "operationId" : "getProcessGroupStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/processor-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of processors that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getProcessorTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "type", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/processors/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for a processor", + "description" : "", + "operationId" : "getProcessorStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/processors/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status history for a processor", + "description" : "", + "operationId" : "getProcessorStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the listing of available flow registry clients", + "description" : "", + "operationId" : "getRegistryClients", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowRegistryClientsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{id}/buckets" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the buckets from the specified registry for the current user", + "description" : "", + "operationId" : "getBuckets", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The registry id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowRegistryBucketsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{registry-id}/buckets/{bucket-id}/flows" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the flows from the specified registry and bucket for the current user", + "description" : "", + "operationId" : "getFlows", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "registry-id", + "in" : "path", + "description" : "The registry client id.", + "required" : true, + "type" : "string" + }, { + "name" : "bucket-id", + "in" : "path", + "description" : "The bucket id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/details" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the details of a flow from the specified registry and bucket for the specified flow for the current user", + "description" : "", + "operationId" : "getDetails", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "registry-id", + "in" : "path", + "description" : "The registry client id.", + "required" : true, + "type" : "string" + }, { + "name" : "bucket-id", + "in" : "path", + "description" : "The bucket id.", + "required" : true, + "type" : "string" + }, { + "name" : "flow-id", + "in" : "path", + "description" : "The flow id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the flow versions from the specified registry and bucket for the specified flow for the current user", + "description" : "", + "operationId" : "getVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "registry-id", + "in" : "path", + "description" : "The registry client id.", + "required" : true, + "type" : "string" + }, { + "name" : "bucket-id", + "in" : "path", + "description" : "The bucket id.", + "required" : true, + "type" : "string" + }, { + "name" : "flow-id", + "in" : "path", + "description" : "The flow id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadataSetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/{version-a}/diff/{version-b}" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the differences between two versions of the same versioned flow, the basis of the comparison will be the first version", + "description" : "", + "operationId" : "getVersionDifferences", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "registry-id", + "in" : "path", + "description" : "The registry client id.", + "required" : true, + "type" : "string" + }, { + "name" : "bucket-id", + "in" : "path", + "description" : "The bucket id.", + "required" : true, + "type" : "string" + }, { + "name" : "flow-id", + "in" : "path", + "description" : "The flow id.", + "required" : true, + "type" : "string" + }, { + "name" : "version-a", + "in" : "path", + "description" : "The base version.", + "required" : true, + "type" : "integer", + "format" : "int32" + }, { + "name" : "version-b", + "in" : "path", + "description" : "The compared version.", + "required" : true, + "type" : "integer", + "format" : "int32" + }, { + "name" : "offset", + "in" : "query", + "description" : "Must be a non-negative number. Specifies the starting point of the listing. 0 means start from the beginning.", + "required" : false, + "type" : "integer", + "default" : 0, + "format" : "int32" + }, { + "name" : "limit", + "in" : "query", + "description" : "Limits the number of differences listed. This might lead to partial result. 0 means no limitation is applied.", + "required" : false, + "type" : "integer", + "default" : 1000, + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowComparisonEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/remote-process-groups/{id}/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets status for a remote process group", + "description" : "", + "operationId" : "getRemoteProcessGroupStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/remote-process-groups/{id}/status/history" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the status history", + "description" : "", + "operationId" : "getRemoteProcessGroupStatusHistory", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatusHistoryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/reporting-task-types" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the types of reporting tasks that this NiFi supports", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getReportingTaskTypes", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleGroupFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle group.", + "required" : false, + "type" : "string" + }, { + "name" : "bundleArtifactFilter", + "in" : "query", + "description" : "If specified, will only return types that are a member of this bundle artifact.", + "required" : false, + "type" : "string" + }, { + "name" : "type", + "in" : "query", + "description" : "If specified, will only return types whose fully qualified classname matches.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskTypesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/reporting-tasks" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all reporting tasks", + "description" : "", + "operationId" : "getReportingTasks", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTasksEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/reporting-tasks/download" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Download a snapshot of the given reporting tasks and any controller services they use", + "description" : "", + "operationId" : "downloadReportingTaskSnapshot", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "reportingTaskId", + "in" : "query", + "description" : "Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/reporting-tasks/snapshot" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Get a snapshot of the given reporting tasks and any controller services they use", + "description" : "", + "operationId" : "getReportingTaskSnapshot", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "reportingTaskId", + "in" : "query", + "description" : "Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedReportingTaskSnapshot" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/runtime-manifest" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Retrieves the runtime manifest for this NiFi instance.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getRuntimeManifest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RuntimeManifestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/search-results" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Performs a search against this NiFi using the specified search term", + "description" : "Only search results from authorized components will be returned.", + "operationId" : "searchFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "q", + "in" : "query", + "required" : false, + "type" : "string" + }, { + "name" : "a", + "in" : "query", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SearchResultsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/status" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets the current status of this NiFi", + "description" : "", + "operationId" : "getControllerStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerStatusEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flow/templates" : { + "get" : { + "tags" : [ "flow" ], + "summary" : "Gets all templates", + "description" : "", + "operationId" : "getTemplates", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplatesEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /flow" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/drop-requests" : { + "post" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Creates a request to drop the contents of the queue in this connection.", + "description" : "", + "operationId" : "createDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "202" : { + "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/drop-requests/{drop-request-id}" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets the current status of a drop request for the specified connection.", + "description" : "", + "operationId" : "getDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "drop-request-id", + "in" : "path", + "description" : "The drop request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Cancels and/or removes a request to drop the contents of this connection.", + "description" : "", + "operationId" : "removeDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "drop-request-id", + "in" : "path", + "description" : "The drop request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets a FlowFile from a Connection.", + "description" : "", + "operationId" : "getFlowFile", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "flowfile-uuid", + "in" : "path", + "description" : "The flowfile uuid.", + "required" : true, + "type" : "string" + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowFileEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets the content for a FlowFile in a Connection.", + "description" : "", + "operationId" : "downloadFlowFileContent", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "flowfile-uuid", + "in" : "path", + "description" : "The flowfile uuid.", + "required" : true, + "type" : "string" + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/listing-requests" : { + "post" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Lists the contents of the queue in this connection.", + "description" : "", + "operationId" : "createFlowFileListing", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ListingRequestEntity" + } + }, + "202" : { + "description" : "The request has been accepted. A HTTP response header will contain the URI where the response can be polled." + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/flowfile-queues/{id}/listing-requests/{listing-request-id}" : { + "get" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Gets the current status of a listing request for the specified connection.", + "description" : "", + "operationId" : "getListingRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "listing-request-id", + "in" : "path", + "description" : "The listing request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ListingRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "flowfile-queues" ], + "summary" : "Cancels and/or removes a request to list the contents of this connection.", + "description" : "", + "operationId" : "deleteListingRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The connection id.", + "required" : true, + "type" : "string" + }, { + "name" : "listing-request-id", + "in" : "path", + "description" : "The listing request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ListingRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Source Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/funnels/{id}" : { + "get" : { + "tags" : [ "funnel" ], + "summary" : "Gets a funnel", + "description" : "", + "operationId" : "getFunnel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The funnel id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /funnels/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "funnel" ], + "summary" : "Updates a funnel", + "description" : "", + "operationId" : "updateFunnel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The funnel id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The funnel configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /funnels/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "funnel" ], + "summary" : "Deletes a funnel", + "description" : "", + "operationId" : "removeFunnel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The funnel id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /funnels/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/input-ports/{id}" : { + "get" : { + "tags" : [ "input-ports" ], + "summary" : "Gets an input port", + "description" : "", + "operationId" : "getInputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /input-ports/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "input-ports" ], + "summary" : "Updates an input port", + "description" : "", + "operationId" : "updateInputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The input port configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /input-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "input-ports" ], + "summary" : "Deletes an input port", + "description" : "", + "operationId" : "removeInputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The input port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /input-ports/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/input-ports/{id}/run-status" : { + "put" : { + "tags" : [ "input-ports" ], + "summary" : "Updates run status of an input-port", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The port run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /input-ports/{uuid} or /operation/input-ports/{uuid}" : [ ] + } ] + } + }, + "/labels/{id}" : { + "get" : { + "tags" : [ "labels" ], + "summary" : "Gets a label", + "description" : "", + "operationId" : "getLabel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The label id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /labels/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "labels" ], + "summary" : "Updates a label", + "description" : "", + "operationId" : "updateLabel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The label id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The label configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /labels/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "labels" ], + "summary" : "Deletes a label", + "description" : "", + "operationId" : "removeLabel", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The label id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /labels/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/output-ports/{id}" : { + "get" : { + "tags" : [ "output-ports" ], + "summary" : "Gets an output port", + "description" : "", + "operationId" : "getOutputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /output-ports/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "output-ports" ], + "summary" : "Updates an output port", + "description" : "", + "operationId" : "updateOutputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The output port configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /output-ports/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "output-ports" ], + "summary" : "Deletes an output port", + "description" : "", + "operationId" : "removeOutputPort", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The output port id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /output-ports/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/output-ports/{id}/run-status" : { + "put" : { + "tags" : [ "output-ports" ], + "summary" : "Updates run status of an output-port", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The port run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /output-ports/{uuid} or /operation/output-ports/{uuid}" : [ ] + } ] + } + }, + "/parameter-contexts" : { + "post" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Create a Parameter Context", + "description" : "", + "operationId" : "createParameterContext", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The Parameter Context.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /parameter-contexts" : [ ] + }, { + "Read - for every inherited parameter context" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/update-requests" : { + "post" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Initiate the Update Request of a Parameter Context", + "description" : "This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this action may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-requests/{requestId}.", + "operationId" : "submitParameterContextUpdate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated version of the parameter context.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{parameterContextId}" : [ ] + }, { + "Write - /parameter-contexts/{parameterContextId}" : [ ] + }, { + "Read - for every component that is affected by the update" : [ ] + }, { + "Write - for every component that is affected by the update" : [ ] + }, { + "Read - for every currently inherited parameter context" : [ ] + }, { + "Read - for any new inherited parameter context" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/update-requests/{requestId}" : { + "get" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Returns the Update Request with the given ID", + "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", + "operationId" : "getParameterContextUpdate", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Deletes the Update Request with the given ID", + "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps.", + "operationId" : "deleteUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the ParameterContext", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/validation-requests" : { + "post" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated", + "description" : "This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}.", + "operationId" : "submitValidationRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The validation request", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{parameterContextId}" : [ ] + } ] + } + }, + "/parameter-contexts/{contextId}/validation-requests/{id}" : { + "get" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Returns the Validation Request with the given ID", + "description" : "Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", + "operationId" : "getValidationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Validation Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Deletes the Validation Request with the given ID", + "description" : "Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps.", + "operationId" : "deleteValidationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "contextId", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextValidationRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/parameter-contexts/{id}" : { + "get" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Returns the Parameter Context with the given ID", + "description" : "Returns the Parameter Context with the given ID.", + "operationId" : "getParameterContext", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Parameter Context", + "required" : true, + "type" : "string" + }, { + "name" : "includeInheritedParameters", + "in" : "query", + "description" : "Whether or not to include inherited parameters from other parameter contexts, and therefore also overridden values. If true, the result will be the 'effective' parameter context.", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id}" : [ ] + } ] + }, + "put" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Modifies a Parameter Context", + "description" : "This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.", + "operationId" : "updateParameterContext", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated Parameter Context", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{id}" : [ ] + }, { + "Write - /parameter-contexts/{id}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-contexts" ], + "summary" : "Deletes the Parameter Context with the given ID", + "description" : "Deletes the Parameter Context with the given ID.", + "operationId" : "deleteParameterContext", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The Parameter Context ID.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-contexts/{uuid}" : [ ] + }, { + "Write - /parameter-contexts/{uuid}" : [ ] + }, { + "Read - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] + }, { + "Write - /process-groups/{uuid}, for any Process Group that is currently bound to the Parameter Context" : [ ] + } ] + } + }, + "/parameter-providers/{id}" : { + "get" : { + "tags" : [ "parameter-providers" ], + "summary" : "Gets a parameter provider", + "description" : "", + "operationId" : "getParameterProvider", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The parameter provider id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterProviderEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-providers/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "parameter-providers" ], + "summary" : "Updates a parameter provider", + "description" : "", + "operationId" : "updateParameterProvider", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The parameter provider id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The parameter provider configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterProviderEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterProviderEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /parameter-providers/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-providers" ], + "summary" : "Deletes a parameter provider", + "description" : "", + "operationId" : "removeParameterProvider", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The parameter provider id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterProviderEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /parameter-providers/{uuid}" : [ ] + }, { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/parameter-providers/{id}/config/analysis" : { + "post" : { + "tags" : [ "parameter-providers" ], + "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", + "description" : "", + "operationId" : "analyzeConfiguration", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The parameter provider id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The configuration analysis request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ConfigurationAnalysisEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConfigurationAnalysisEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-providers/{uuid}" : [ ] + } ] + } + }, + "/parameter-providers/{id}/config/verification-requests" : { + "post" : { + "tags" : [ "parameter-providers" ], + "summary" : "Performs verification of the Parameter Provider's configuration", + "description" : "This will initiate the process of verifying a given Parameter Provider configuration. This may be a long-running task. As a result, this endpoint will immediately return a ParameterProviderConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-providers/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-providers/{providerId}/verification-requests/{requestId}.", + "operationId" : "submitConfigVerificationRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The parameter provider id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The parameter provider configuration verification request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-providers/{uuid}" : [ ] + } ] + } + }, + "/parameter-providers/{id}/config/verification-requests/{requestId}" : { + "get" : { + "tags" : [ "parameter-providers" ], + "summary" : "Returns the Verification Request with the given ID", + "description" : "Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", + "operationId" : "getVerificationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Parameter Provider", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Verification Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-providers" ], + "summary" : "Deletes the Verification Request with the given ID", + "description" : "Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.", + "operationId" : "deleteVerificationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Parameter Provider", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Verification Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/parameter-providers/{id}/descriptors" : { + "get" : { + "tags" : [ "parameter-providers" ], + "summary" : "Gets a parameter provider property descriptor", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The parameter provider id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-providers/{uuid}" : [ ] + } ] + } + }, + "/parameter-providers/{id}/parameters/fetch-requests" : { + "post" : { + "tags" : [ "parameter-providers" ], + "summary" : "Fetches and temporarily caches the parameters for a provider", + "description" : "", + "operationId" : "fetchParameters", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The parameter provider id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The parameter fetch request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterProviderParameterFetchEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterProviderEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /parameter-providers/{uuid} or or /operation/parameter-providers/{uuid}" : [ ] + } ] + } + }, + "/parameter-providers/{id}/references" : { + "get" : { + "tags" : [ "parameter-providers" ], + "summary" : "Gets all references to a parameter provider", + "description" : "", + "operationId" : "getParameterProviderReferences", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The parameter provider id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterProviderReferencingComponentsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-providers/{uuid}" : [ ] + } ] + } + }, + "/parameter-providers/{id}/state" : { + "get" : { + "tags" : [ "parameter-providers" ], + "summary" : "Gets the state for a parameter provider", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The parameter provider id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /parameter-providers/{uuid}" : [ ] + } ] + } + }, + "/parameter-providers/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "parameter-providers" ], + "summary" : "Clears the state for a parameter provider", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The parameter provider id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /parameter-providers/{uuid}" : [ ] + } ] + } + }, + "/parameter-providers/{providerId}/apply-parameters-requests" : { + "post" : { + "tags" : [ "parameter-providers" ], + "summary" : "Initiate a request to apply the fetched parameters of a Parameter Provider", + "description" : "This will initiate the process of applying fetched parameters to all referencing Parameter Contexts. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this action may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterProviderApplyParametersRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-providers/apply-parameters-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-providers/apply-parameters-requests/{requestId}.", + "operationId" : "submitApplyParameters", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "providerId", + "in" : "path", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The apply parameters request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ParameterProviderParameterApplicationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterProviderApplyParametersRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /parameter-providers/{parameterProviderId}" : [ ] + }, { + "Write - /parameter-providers/{parameterProviderId}" : [ ] + }, { + "Read - for every component that is affected by the update" : [ ] + }, { + "Write - for every component that is affected by the update" : [ ] + } ] + } + }, + "/parameter-providers/{providerId}/apply-parameters-requests/{requestId}" : { + "get" : { + "tags" : [ "parameter-providers" ], + "summary" : "Returns the Apply Parameters Request with the given ID", + "description" : "Returns the Apply Parameters Request with the given ID. Once an Apply Parameters Request has been created by performing a POST to /nifi-api/parameter-providers, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the state, such as percent complete, the current state of the request, and any failures. ", + "operationId" : "getParameterProviderApplyParametersRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "providerId", + "in" : "path", + "description" : "The ID of the Parameter Provider", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Apply Parameters Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterProviderApplyParametersRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "parameter-providers" ], + "summary" : "Deletes the Apply Parameters Request with the given ID", + "description" : "Deletes the Apply Parameters Request with the given ID. After a request is created via a POST to /nifi-api/parameter-providers/apply-parameters-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Apply process has completed. If the request is deleted before the request completes, then the Apply Parameters Request will finish the step that it is currently performing and then will cancel any subsequent steps.", + "operationId" : "deleteApplyParametersRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "providerId", + "in" : "path", + "description" : "The ID of the Parameter Provider", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Apply Parameters Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ParameterProviderApplyParametersRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/policies" : { + "post" : { + "tags" : [ "policies" ], + "summary" : "Creates an access policy", + "description" : "", + "operationId" : "createAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + } ] + } + }, + "/policies/{action}/{resource}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Gets an access policy for the specified action and resource", + "description" : "Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.", + "operationId" : "getAccessPolicyForResource", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "action", + "in" : "path", + "description" : "The request action.", + "required" : true, + "type" : "string", + "enum" : [ "read", "write" ] + }, { + "name" : "resource", + "in" : "path", + "description" : "The resource of the policy.", + "required" : true, + "type" : "string", + "pattern" : ".+" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /policies/{resource}" : [ ] + } ] + } + }, + "/policies/{id}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Gets an access policy", + "description" : "", + "operationId" : "getAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /policies/{resource}" : [ ] + } ] + }, + "put" : { + "tags" : [ "policies" ], + "summary" : "Updates a access policy", + "description" : "", + "operationId" : "updateAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "policies" ], + "summary" : "Deletes an access policy", + "description" : "", + "operationId" : "removeAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /policies/{resource}" : [ ] + }, { + "Write - Policy of the parent resource - /policies/{resource}" : [ ] + } ] + } + }, + "/process-groups/replace-requests/{id}" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Returns the Replace Request with the given ID", + "description" : "Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getReplaceProcessGroupRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Replace Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "process-groups" ], + "summary" : "Deletes the Replace Request with the given ID", + "description" : "Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "deleteReplaceProcessGroupRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/process-groups/{groupId}/variable-registry/update-requests/{updateId}" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group's variable registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVariableRegistryUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "groupId", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "updateId", + "in" : "path", + "description" : "The ID of the Variable Registry Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "process-groups" ], + "summary" : "Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "deleteVariableRegistryUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "groupId", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "updateId", + "in" : "path", + "description" : "The ID of the Variable Registry Update Request", + "required" : true, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group", + "description" : "", + "operationId" : "getProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "process-groups" ], + "summary" : "Updates a process group", + "description" : "", + "operationId" : "updateProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The process group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "process-groups" ], + "summary" : "Deletes a process group", + "description" : "", + "operationId" : "removeProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + } ] + } + }, + "/process-groups/{id}/connections" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all connections", + "description" : "", + "operationId" : "getConnections", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a connection", + "description" : "", + "operationId" : "createConnection", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The connection configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Write Source - /{component-type}/{uuid}" : [ ] + }, { + "Write Destination - /{component-type}/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/controller-services" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a new controller service", + "description" : "", + "operationId" : "createControllerService", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Controller Service is restricted - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/download" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group for download", + "description" : "", + "operationId" : "exportProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeReferencedServices", + "in" : "query", + "description" : "If referenced services from outside the target group should be included", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/empty-all-connections-requests" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a request to drop all flowfiles of all connection queues in this process group.", + "description" : "", + "operationId" : "createEmptyAllConnectionsRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "202" : { + "description" : "The request has been accepted. An HTTP response header will contain the URI where the status can be polled." + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] + }, { + "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] + } ] + } + }, + "/process-groups/{id}/empty-all-connections-requests/{drop-request-id}" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets the current status of a drop all flowfiles request.", + "description" : "", + "operationId" : "getDropAllFlowfilesRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "drop-request-id", + "in" : "path", + "description" : "The drop request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] + }, { + "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] + } ] + }, + "delete" : { + "tags" : [ "process-groups" ], + "summary" : "Cancels and/or removes a request to drop all flowfiles.", + "description" : "", + "operationId" : "removeDropRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "drop-request-id", + "in" : "path", + "description" : "The drop request id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/DropRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid} - For this and all encapsulated process groups" : [ ] + }, { + "Write Source Data - /data/{component-type}/{uuid} - For all encapsulated connections" : [ ] + } ] + } + }, + "/process-groups/{id}/flow-contents" : { + "put" : { + "tags" : [ "process-groups" ], + "summary" : "Replace Process Group contents with the given ID with the specified Process Group contents", + "description" : "This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "replaceProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The process group replace request entity.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessGroupImportEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupImportEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/funnels" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all funnels", + "description" : "", + "operationId" : "getFunnels", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a funnel", + "description" : "", + "operationId" : "createFunnel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The funnel configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FunnelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/input-ports" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all input ports", + "description" : "", + "operationId" : "getInputPorts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/InputPortsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates an input port", + "description" : "", + "operationId" : "createInputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The input port configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/labels" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all labels", + "description" : "", + "operationId" : "getLabels", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a label", + "description" : "", + "operationId" : "createLabel", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The label configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/local-modifications" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry", + "description" : "", + "operationId" : "getLocalModifications", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowComparisonEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + } ] + } + }, + "/process-groups/{id}/output-ports" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all output ports", + "description" : "", + "operationId" : "getOutputPorts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/OutputPortsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates an output port", + "description" : "", + "operationId" : "createOutputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The output port configuration.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/process-groups" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all process groups", + "description" : "", + "operationId" : "getProcessGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a process group", + "description" : "", + "operationId" : "createProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The process group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, { + "name" : "parameterContextHandlingStrategy", + "in" : "query", + "description" : "Handling Strategy controls whether to keep or replace Parameter Contexts", + "required" : false, + "type" : "string", + "default" : "KEEP_EXISTING", + "enum" : [ "KEEP_EXISTING", "REPLACE" ] + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/process-groups/import" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Imports a specified process group", + "description" : "", + "operationId" : "importProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/process-groups/upload" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Uploads a versioned flow definition and creates a process group", + "description" : "", + "operationId" : "uploadProcessGroup", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "groupName", + "in" : "formData", + "description" : "The process group name.", + "required" : true, + "type" : "string" + }, { + "name" : "positionX", + "in" : "formData", + "description" : "The process group X position.", + "required" : true, + "type" : "number" + }, { + "name" : "positionY", + "in" : "formData", + "description" : "The process group Y position.", + "required" : true, + "type" : "number" + }, { + "name" : "clientId", + "in" : "formData", + "description" : "The client id.", + "required" : true, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "formData", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "file", + "in" : "formData", + "description" : "The binary content of the versioned flow definition file being uploaded.", + "required" : true, + "type" : "file" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/processors" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all processors", + "description" : "", + "operationId" : "getProcessors", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeDescendantGroups", + "in" : "query", + "description" : "Whether or not to include processors from descendant process groups", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a new processor", + "description" : "", + "operationId" : "createProcessor", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + }, { + "Write - if the Processor is restricted - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/remote-process-groups" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets all remote process groups", + "description" : "", + "operationId" : "getRemoteProcessGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a new process group", + "description" : "", + "operationId" : "createRemoteProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/replace-requests" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Initiate the Replace Request of a Process Group with the given ID", + "description" : "This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "initiateReplaceProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The process group replace request entity", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessGroupImportEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessGroupReplaceRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ] + } + }, + "/process-groups/{id}/snippet-instance" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Copies a snippet and discards it.", + "description" : "", + "operationId" : "copySnippet", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The copy snippet request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CopySnippetRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] + }, { + "Write - if the snippet contains any restricted Processors - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/template-instance" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Instantiates a template", + "description" : "", + "operationId" : "instantiateTemplate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The instantiate template request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/InstantiateTemplateRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/FlowEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /templates/{uuid}" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + } ] + } + }, + "/process-groups/{id}/templates" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Creates a template and discards the specified snippet.", + "description" : "", + "operationId" : "createTemplate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The create template request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateTemplateRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For each component in the snippet and their descendant components" : [ ] + } ] + } + }, + "/process-groups/{id}/templates/import" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Imports a template", + "description" : "", + "operationId" : "importTemplate", + "consumes" : [ "application/xml" ], + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/templates/upload" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Uploads a template", + "description" : "", + "operationId" : "uploadTemplate", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "formData", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "template", + "in" : "formData", + "description" : "The binary content of the template file being uploaded.", + "required" : true, + "type" : "file" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/variable-registry" : { + "get" : { + "tags" : [ "process-groups" ], + "summary" : "Gets a process group's variable registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVariableRegistry", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "includeAncestorGroups", + "in" : "query", + "description" : "Whether or not to include ancestor groups", + "required" : false, + "type" : "boolean", + "default" : true + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "process-groups" ], + "summary" : "Updates the contents of a Process Group's variable Registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateVariableRegistry", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The variable registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/process-groups/{id}/variable-registry/update-requests" : { + "post" : { + "tags" : [ "process-groups" ], + "summary" : "Submits a request to update a process group's variable registry", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "submitUpdateVariableRegistryRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The variable registry configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VariableRegistryEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VariableRegistryUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/processors/run-status-details/queries" : { + "post" : { + "tags" : [ "processors" ], + "summary" : "Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs", + "description" : "", + "operationId" : "getProcessorRunStatusDetails", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The request for the processors that should be included in the results", + "required" : false, + "schema" : { + "$ref" : "#/definitions/RunStatusDetailsRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorsRunStatusDetailsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid} for each processor whose run status information is requested" : [ ] + } ] + } + }, + "/processors/{id}" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets a processor", + "description" : "", + "operationId" : "getProcessor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "processors" ], + "summary" : "Updates a processor", + "description" : "", + "operationId" : "updateProcessor", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "processors" ], + "summary" : "Deletes a processor", + "description" : "", + "operationId" : "deleteProcessor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/config/analysis" : { + "post" : { + "tags" : [ "processors" ], + "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", + "description" : "", + "operationId" : "analyzeConfiguration", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor configuration analysis request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ConfigurationAnalysisEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConfigurationAnalysisEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/config/verification-requests" : { + "post" : { + "tags" : [ "processors" ], + "summary" : "Performs verification of the Processor's configuration", + "description" : "This will initiate the process of verifying a given Processor configuration. This may be a long-running task. As a result, this endpoint will immediately return a ProcessorConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /processors/{processorId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /processors/{processorId}/verification-requests/{requestId}.", + "operationId" : "submitProcessorVerificationRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor configuration verification request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/config/verification-requests/{requestId}" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Returns the Verification Request with the given ID", + "description" : "Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", + "operationId" : "getVerificationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Processor", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Verification Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "processors" ], + "summary" : "Deletes the Verification Request with the given ID", + "description" : "Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.", + "operationId" : "deleteVerificationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Processor", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Verification Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/processors/{id}/descriptors" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets the descriptor for a processor property", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name.", + "required" : true, + "type" : "string" + }, { + "name" : "sensitive", + "in" : "query", + "description" : "Property Descriptor requested sensitive status", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/diagnostics" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets diagnostics information about a processor", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getProcessorDiagnostics", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/run-status" : { + "put" : { + "tags" : [ "processors" ], + "summary" : "Updates run status of a processor", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The processor run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProcessorRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/state" : { + "get" : { + "tags" : [ "processors" ], + "summary" : "Gets the state for a processor", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "processors" ], + "summary" : "Clears the state for a processor", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid}" : [ ] + } ] + } + }, + "/processors/{id}/threads" : { + "delete" : { + "tags" : [ "processors" ], + "summary" : "Terminates a processor, essentially \"deleting\" its threads and any active tasks", + "description" : "", + "operationId" : "terminateProcessor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /processors/{uuid} or /operation/processors/{uuid}" : [ ] + } ] + } + }, + "/provenance" : { + "post" : { + "tags" : [ "provenance" ], + "summary" : "Submits a provenance query", + "description" : "Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.", + "operationId" : "submitProvenanceRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The provenance query details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/latest/replays" : { + "post" : { + "tags" : [ "provenance-events" ], + "summary" : "Replays content from a provenance event", + "description" : "", + "operationId" : "submitReplayLatestEvent", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The replay request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReplayLastEventRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReplayLastEventResponseEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + }, { + "Write Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/replays" : { + "post" : { + "tags" : [ "provenance-events" ], + "summary" : "Replays content from a provenance event", + "description" : "", + "operationId" : "submitReplay", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The replay request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/SubmitReplayRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEventEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + }, { + "Write Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/{id}" : { + "get" : { + "tags" : [ "provenance-events" ], + "summary" : "Gets a provenance event", + "description" : "", + "operationId" : "getProvenanceEvent", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this event exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The provenance event id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEventEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/{id}/content/input" : { + "get" : { + "tags" : [ "provenance-events" ], + "summary" : "Gets the input content for a provenance event", + "description" : "", + "operationId" : "getInputContent", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The provenance event id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance-events/{id}/content/output" : { + "get" : { + "tags" : [ "provenance-events" ], + "summary" : "Gets the output content for a provenance event", + "description" : "", + "operationId" : "getOutputContent", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where the content exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The provenance event id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StreamingOutput" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read Component Provenance Data - /provenance-data/{component-type}/{uuid}" : [ ] + }, { + "Read Component Data - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance/lineage" : { + "post" : { + "tags" : [ "provenance" ], + "summary" : "Submits a lineage query", + "description" : "Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.", + "operationId" : "submitLineageRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The lineage query details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + } + }, + "/provenance/lineage/{id}" : { + "get" : { + "tags" : [ "provenance" ], + "summary" : "Gets a lineage query", + "description" : "", + "operationId" : "getLineage", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the lineage query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "provenance" ], + "summary" : "Deletes a lineage query", + "description" : "", + "operationId" : "deleteLineage", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the lineage query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/LineageEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ] + } + }, + "/provenance/search-options" : { + "get" : { + "tags" : [ "provenance" ], + "summary" : "Gets the searchable attributes for provenance events", + "description" : "", + "operationId" : "getSearchOptions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceOptionsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ] + } + }, + "/provenance/{id}" : { + "get" : { + "tags" : [ "provenance" ], + "summary" : "Gets a provenance query", + "description" : "", + "operationId" : "getProvenance", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "summarize", + "in" : "query", + "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "incrementalResults", + "in" : "query", + "description" : "Whether or not to summarize provenance events returned. This property is false by default.", + "required" : false, + "type" : "boolean", + "default" : true + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the provenance query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + }, { + "Read - /data/{component-type}/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "provenance" ], + "summary" : "Deletes a provenance query", + "description" : "", + "operationId" : "deleteProvenance", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where this query exists if clustered.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The id of the provenance query.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ProvenanceEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /provenance" : [ ] + } ] + } + }, + "/remote-process-groups/process-group/{id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of all remote process groups in a process group (recursively)", + "description" : "", + "operationId" : "updateRemoteProcessGroupRunStatuses", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process groups run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}" : { + "get" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Gets a remote process group", + "description" : "", + "operationId" : "getRemoteProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /remote-process-groups/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates a remote process group", + "description" : "", + "operationId" : "updateRemoteProcessGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Deletes a remote process group", + "description" : "", + "operationId" : "removeRemoteProcessGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/input-ports/{port-id}" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupInputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/input-ports/{port-id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupInputPortRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/output-ports/{port-id}" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupOutputPort", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/output-ports/{port-id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of a remote port", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateRemoteProcessGroupOutputPortRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "name" : "port-id", + "in" : "path", + "description" : "The remote process group port id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group port.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupPortEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/run-status" : { + "put" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Updates run status of a remote process group", + "description" : "", + "operationId" : "updateRemoteProcessGroupRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The remote process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The remote process group run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/RemotePortRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid} or /operation/remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/remote-process-groups/{id}/state" : { + "get" : { + "tags" : [ "remote-process-groups" ], + "summary" : "Gets the state for a RemoteProcessGroup", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The processor id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /remote-process-groups/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Gets a reporting task", + "description" : "", + "operationId" : "getReportingTask", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /reporting-tasks/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Updates a reporting task", + "description" : "", + "operationId" : "updateReportingTask", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + }, { + "Read - any referenced Controller Services if this request changes the reference - /controller-services/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Deletes a reporting task", + "description" : "", + "operationId" : "removeReportingTask", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + }, { + "Write - /controller" : [ ] + }, { + "Read - any referenced Controller Services - /controller-services/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/config/analysis" : { + "post" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Performs analysis of the component's configuration, providing information about which attributes are referenced.", + "description" : "", + "operationId" : "analyzeConfiguration", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The configuration analysis request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ConfigurationAnalysisEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ConfigurationAnalysisEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/config/verification-requests" : { + "post" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Performs verification of the Reporting Task's configuration", + "description" : "This will initiate the process of verifying a given Reporting Task configuration. This may be a long-running task. As a result, this endpoint will immediately return a ReportingTaskConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /reporting-tasks/{taskId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /reporting-tasks/{serviceId}/verification-requests/{requestId}.", + "operationId" : "submitConfigVerificationRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The reporting task configuration verification request.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/config/verification-requests/{requestId}" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Returns the Verification Request with the given ID", + "description" : "Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. ", + "operationId" : "getVerificationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Reporting Task", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Verification Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Deletes the Verification Request with the given ID", + "description" : "Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.", + "operationId" : "deleteVerificationRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Reporting Task", + "required" : true, + "type" : "string" + }, { + "name" : "requestId", + "in" : "path", + "description" : "The ID of the Verification Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VerifyConfigRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/descriptors" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Gets a reporting task property descriptor", + "description" : "", + "operationId" : "getPropertyDescriptor", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "name" : "propertyName", + "in" : "query", + "description" : "The property name.", + "required" : true, + "type" : "string" + }, { + "name" : "sensitive", + "in" : "query", + "description" : "Property Descriptor requested sensitive status", + "required" : false, + "type" : "boolean", + "default" : false + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PropertyDescriptorEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/run-status" : { + "put" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Updates run status of a reporting task", + "description" : "", + "operationId" : "updateRunStatus", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The reporting task run status.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/ReportingTaskRunStatusEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid} or or /operation/reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/state" : { + "get" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Gets the state for a reporting task", + "description" : "", + "operationId" : "getState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/reporting-tasks/{id}/state/clear-requests" : { + "post" : { + "tags" : [ "reporting-tasks" ], + "summary" : "Clears the state for a reporting task", + "description" : "", + "operationId" : "clearState", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The reporting task id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ComponentStateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /reporting-tasks/{uuid}" : [ ] + } ] + } + }, + "/resources" : { + "get" : { + "tags" : [ "resources" ], + "summary" : "Gets the available resources that support access/authorization policies", + "description" : "", + "operationId" : "getResources", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ResourcesEntity" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Read - /resources" : [ ] + } ] + } + }, + "/site-to-site" : { + "get" : { + "tags" : [ "site-to-site" ], + "summary" : "Returns the details about this NiFi necessary to communicate via site to site", + "description" : "", + "operationId" : "getSiteToSiteDetails", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ControllerEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /site-to-site" : [ ] + } ] + } + }, + "/site-to-site/peers" : { + "get" : { + "tags" : [ "site-to-site" ], + "summary" : "Returns the available Peers and its status of this NiFi", + "description" : "", + "operationId" : "getPeers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json", "application/xml" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/PeersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /site-to-site" : [ ] + } ] + } + }, + "/snippets" : { + "post" : { + "tags" : [ "snippets" ], + "summary" : "Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.", + "description" : "", + "operationId" : "createSnippet", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The snippet configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read or Write - /{component-type}/{uuid} - For every component (all Read or all Write) in the Snippet and their descendant components" : [ ] + } ] + } + }, + "/snippets/{id}" : { + "put" : { + "tags" : [ "snippets" ], + "summary" : "Move's the components in this Snippet into a new Process Group and discards the snippet", + "description" : "", + "operationId" : "updateSnippet", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The snippet id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The snippet configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write Process Group - /process-groups/{uuid}" : [ ] + }, { + "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] + } ] + }, + "delete" : { + "tags" : [ "snippets" ], + "summary" : "Deletes the components in a snippet and discards the snippet", + "description" : "", + "operationId" : "deleteSnippet", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The snippet id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SnippetEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /{component-type}/{uuid} - For each component in the Snippet and their descendant components" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/system-diagnostics" : { + "get" : { + "tags" : [ "system-diagnostics" ], + "summary" : "Gets the diagnostics for the system NiFi is running on", + "description" : "", + "operationId" : "getSystemDiagnostics", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "nodewise", + "in" : "query", + "description" : "Whether or not to include the breakdown per node. Optional, defaults to false", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "clusterNodeId", + "in" : "query", + "description" : "The id of the node where to get the status.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/SystemDiagnosticsEntity" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Read - /system" : [ ] + } ] + } + }, + "/system-diagnostics/jmx-metrics" : { + "get" : { + "tags" : [ "system-diagnostics" ], + "summary" : "Retrieve available JMX metrics", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getJmxMetrics", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "beanNameFilter", + "in" : "query", + "description" : "Regular Expression Pattern to be applied against the ObjectName", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/JmxMetricsResultsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /system" : [ ] + } ] + } + }, + "/templates/{id}" : { + "delete" : { + "tags" : [ "templates" ], + "summary" : "Deletes a template", + "description" : "", + "operationId" : "removeTemplate", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The template id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /templates/{uuid}" : [ ] + }, { + "Write - Parent Process Group - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/templates/{id}/download" : { + "get" : { + "tags" : [ "templates" ], + "summary" : "Exports a template", + "description" : "", + "operationId" : "exportTemplate", + "consumes" : [ "*/*" ], + "produces" : [ "application/xml" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The template id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /templates/{uuid}" : [ ] + } ] + } + }, + "/tenants/search-results" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Searches for a tenant with the specified identity", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "searchTenants", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "q", + "in" : "query", + "description" : "Identity to search for.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/TenantsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + } + }, + "/tenants/user-groups" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets all user groups", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUserGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupsEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Creates a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "createUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/tenants/user-groups/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Updates a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Deletes a user group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "removeUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroupEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/tenants/users" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets all users", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUsers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UsersEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Creates a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "createUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/tenants/users/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Gets a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /tenants" : [ ] + } ] + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Updates a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Deletes a user", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "removeUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The revision is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /tenants" : [ ] + } ] + } + }, + "/versions/active-requests" : { + "post" : { + "tags" : [ "versions" ], + "summary" : "Create a version control request", + "description" : "Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "createVersionControlRequest", + "consumes" : [ "application/json" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The versioned flow details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/CreateActiveRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/versions/active-requests/{id}" : { + "put" : { + "tags" : [ "versions" ], + "summary" : "Updates the request with the given ID", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateVersionControlRequest", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The request ID.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The version control component mapping.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionControlComponentMappingEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can update it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Deletes the version control request with the given ID", + "description" : "Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "deleteVersionControlRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The request ID.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/versions/process-groups/{id}" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Gets the Version Control information for a process group", + "description" : "Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getVersionInformation", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + }, + "post" : { + "tags" : [ "versions" ], + "summary" : "Save the Process Group with the given ID", + "description" : "Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "saveToFlowRegistry", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The versioned flow details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/StartVersionControlRequestEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Read - any referenced Controller Services by any encapsulated components - /controller-services/{uuid}" : [ ] + } ] + }, + "put" : { + "tags" : [ "versions" ], + "summary" : "Update the version of a Process Group with the given ID", + "description" : "For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "updateFlowVersion", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Stops version controlling the Process Group with the given ID", + "description" : "Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "stopVersionControl", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the flow.", + "required" : false, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/versions/process-groups/{id}/download" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Gets the latest version of a Process Group for download", + "description" : "", + "operationId" : "exportFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + } ] + } + }, + "/versions/revert-requests/process-groups/{id}" : { + "post" : { + "tags" : [ "versions" ], + "summary" : "Initiate the Revert Request of a Process Group with the given ID", + "description" : "For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "initiateRevertFlowVersion", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The Version Control Information to revert to.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ] + } + }, + "/versions/revert-requests/{id}" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Returns the Revert Request with the given ID", + "description" : "Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getRevertRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Revert Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Deletes the Revert Request with the given ID", + "description" : "Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "deleteRevertRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Revert Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + }, + "/versions/update-requests/process-groups/{id}" : { + "post" : { + "tags" : [ "versions" ], + "summary" : "Initiate the Update Request of a Process Group with the given ID", + "description" : "For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "initiateVersionControlUpdate", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The process group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The controller service configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionControlInformationEntity" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Read - /process-groups/{uuid}" : [ ] + }, { + "Write - /process-groups/{uuid}" : [ ] + }, { + "Read - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - /{component-type}/{uuid} - For all encapsulated components" : [ ] + }, { + "Write - if the template contains any restricted components - /restricted-components" : [ ] + }, { + "Read - /parameter-contexts/{uuid} - For any Parameter Context that is referenced by a Property that is changed, added, or removed" : [ ] + } ] + } + }, + "/versions/update-requests/{id}" : { + "get" : { + "tags" : [ "versions" ], + "summary" : "Returns the Update Request with the given ID", + "description" : "Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "getUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can get it" : [ ] + } ] + }, + "delete" : { + "tags" : [ "versions" ], + "summary" : "Deletes the Update Request with the given ID", + "description" : "Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.", + "operationId" : "deleteUpdateRequest", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "disconnectedNodeAcknowledged", + "in" : "query", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", + "required" : false, + "type" : "boolean", + "default" : false + }, { + "name" : "id", + "in" : "path", + "description" : "The ID of the Update Request", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowUpdateRequestEntity" + } + }, + "400" : { + "description" : "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful." + } + }, + "security" : [ { + "Only the user that submitted the request can remove it" : [ ] + } ] + } + } + }, + "definitions" : { + "AboutDTO" : { + "type" : "object", + "properties" : { + "title" : { + "type" : "string", + "description" : "The title to be used on the page and in the about dialog." + }, + "version" : { + "type" : "string", + "description" : "The version of this NiFi." + }, + "uri" : { + "type" : "string", + "description" : "The URI for the NiFi." + }, + "contentViewerUrl" : { + "type" : "string", + "description" : "The URL for the content viewer if configured." + }, + "timezone" : { + "type" : "string", + "description" : "The timezone of the NiFi instance.", + "readOnly" : true + }, + "buildTag" : { + "type" : "string", + "description" : "Build tag" + }, + "buildRevision" : { + "type" : "string", + "description" : "Build revision or commit hash" + }, + "buildBranch" : { + "type" : "string", + "description" : "Build branch" + }, + "buildTimestamp" : { + "type" : "string", + "description" : "Build timestamp" + } + } + }, + "AboutEntity" : { + "type" : "object", + "properties" : { + "about" : { + "$ref" : "#/definitions/AboutDTO" + } + }, + "xml" : { + "name" : "aboutEntity" + } + }, + "AccessConfigurationDTO" : { + "type" : "object", + "properties" : { + "supportsLogin" : { + "type" : "boolean", + "description" : "Indicates whether or not this NiFi supports user login.", + "readOnly" : true + } + } + }, + "AccessConfigurationEntity" : { + "type" : "object", + "properties" : { + "config" : { + "$ref" : "#/definitions/AccessConfigurationDTO" + } + }, + "xml" : { + "name" : "accessConfigurationEntity" + } + }, + "AccessPolicyDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write" ] + }, + "componentReference" : { + "description" : "Component this policy references if applicable.", + "$ref" : "#/definitions/ComponentReferenceEntity" + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this policy is configurable." + }, + "users" : { + "type" : "array", + "description" : "The set of user IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "userGroups" : { + "type" : "array", + "description" : "The set of user group IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + } + } + }, + "AccessPolicyEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "generated" : { + "type" : "string", + "description" : "When this content was generated." + }, + "component" : { + "$ref" : "#/definitions/AccessPolicyDTO" + } + }, + "xml" : { + "name" : "accessPolicyEntity" + } + }, + "AccessPolicySummaryDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write" ] + }, + "componentReference" : { + "description" : "Component this policy references if applicable.", + "$ref" : "#/definitions/ComponentReferenceEntity" + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this policy is configurable." + } + } + }, + "AccessPolicySummaryEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/AccessPolicySummaryDTO" + } + }, + "xml" : { + "name" : "accessPolicySummaryEntity" + } + }, + "AccessStatusDTO" : { + "type" : "object", + "properties" : { + "identity" : { + "type" : "string", + "description" : "The user identity.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "The user access status.", + "readOnly" : true + }, + "message" : { + "type" : "string", + "description" : "Additional details about the user access status.", + "readOnly" : true + } + }, + "xml" : { + "name" : "accessStatus" + } + }, + "AccessStatusEntity" : { + "type" : "object", + "properties" : { + "accessStatus" : { + "$ref" : "#/definitions/AccessStatusDTO" + } + }, + "xml" : { + "name" : "accessStatusEntity" + } + }, + "AccessTokenExpirationDTO" : { + "type" : "object", + "properties" : { + "expiration" : { + "type" : "string", + "description" : "Token Expiration", + "readOnly" : true + } + }, + "xml" : { + "name" : "accessTokenExpiration" + } + }, + "AccessTokenExpirationEntity" : { + "type" : "object", + "properties" : { + "accessTokenExpiration" : { + "$ref" : "#/definitions/AccessTokenExpirationDTO" + } + }, + "xml" : { + "name" : "accessTokenExpirationEntity" + } + }, + "ActionDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int32", + "description" : "The action id." + }, + "userIdentity" : { + "type" : "string", + "description" : "The identity of the user that performed the action." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the action." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source component." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component." + }, + "sourceType" : { + "type" : "string", + "description" : "The type of the source component." + }, + "componentDetails" : { + "description" : "The details of the source component.", + "$ref" : "#/definitions/ComponentDetailsDTO" + }, + "operation" : { + "type" : "string", + "description" : "The operation that was performed." + }, + "actionDetails" : { + "description" : "The details of the action.", + "$ref" : "#/definitions/ActionDetailsDTO" + } + } + }, + "ActionDetailsDTO" : { + "type" : "object" + }, + "ActionEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int32" + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the action." + }, + "sourceId" : { + "type" : "string" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "action" : { + "$ref" : "#/definitions/ActionDTO" + } + }, + "xml" : { + "name" : "actionEntity" + } + }, + "ActivateControllerServicesEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the ProcessGroup" + }, + "state" : { + "type" : "string", + "description" : "The desired state of the descendant components", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "components" : { + "type" : "object", + "description" : "Optional services to schedule. If not specified, all authorized descendant controller services will be used.", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "activateControllerServicesEntity" + } + }, + "AffectedComponentDTO" : { + "type" : "object", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this component is in" + }, + "id" : { + "type" : "string", + "description" : "The UUID of this component" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of this component", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + }, + "name" : { + "type" : "string", + "description" : "The name of this component." + }, + "state" : { + "type" : "string", + "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string" + } + } + } + }, + "AffectedComponentEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/AffectedComponentDTO" + }, + "processGroup" : { + "description" : "The Process Group that the component belongs to", + "$ref" : "#/definitions/ProcessGroupNameDTO" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of component referenced", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + } + }, + "xml" : { + "name" : "affectedComponentEntity" + } + }, + "AllowableValueDTO" : { + "type" : "object", + "properties" : { + "displayName" : { + "type" : "string", + "description" : "A human readable value that is allowed for the property descriptor." + }, + "value" : { + "type" : "string", + "description" : "A value that is allowed for the property descriptor." + }, + "description" : { + "type" : "string", + "description" : "A description for this allowable value." + } + } + }, + "AllowableValueEntity" : { + "type" : "object", + "properties" : { + "allowableValue" : { + "$ref" : "#/definitions/AllowableValueDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "Attribute" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the attribute" + }, + "description" : { + "type" : "string", + "description" : "The description of the attribute" + } + } + }, + "AttributeDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The attribute name." + }, + "value" : { + "type" : "string", + "description" : "The attribute value." + }, + "previousValue" : { + "type" : "string", + "description" : "The value of the attribute before the event took place." + } + } + }, + "BannerDTO" : { + "type" : "object", + "properties" : { + "headerText" : { + "type" : "string", + "description" : "The header text." + }, + "footerText" : { + "type" : "string", + "description" : "The footer text." + } + } + }, + "BannerEntity" : { + "type" : "object", + "properties" : { + "banners" : { + "$ref" : "#/definitions/BannerDTO" + } + }, + "xml" : { + "name" : "bannersEntity" + } + }, + "BatchSettingsDTO" : { + "type" : "object", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of flow files to include in a transaction." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + } + } + }, + "BatchSize" : { + "type" : "object", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of flow files to include in a transaction." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + } + } + }, + "BuildInfo" : { + "type" : "object", + "properties" : { + "version" : { + "type" : "string", + "description" : "The version number of the built component." + }, + "revision" : { + "type" : "string", + "description" : "The SCM revision id of the source code used for this build." + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp (milliseconds since Epoch) of the build." + }, + "targetArch" : { + "type" : "string", + "description" : "The target architecture of the built component." + }, + "compiler" : { + "type" : "string", + "description" : "The compiler used for the build" + }, + "compilerFlags" : { + "type" : "string", + "description" : "The compiler flags used for the build." + } + } + }, + "BulletinBoardDTO" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "The bulletins in the bulletin board, that matches the supplied request.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "generated" : { + "type" : "string", + "description" : "The timestamp when this report was generated." + } + } + }, + "BulletinBoardEntity" : { + "type" : "object", + "properties" : { + "bulletinBoard" : { + "$ref" : "#/definitions/BulletinBoardDTO" + } + }, + "xml" : { + "name" : "bulletinBoardEntity" + } + }, + "BulletinDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64", + "description" : "The id of the bulletin." + }, + "nodeAddress" : { + "type" : "string", + "description" : "If clustered, the address of the node from which the bulletin originated." + }, + "category" : { + "type" : "string", + "description" : "The category of this bulletin." + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the source component." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source component." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component." + }, + "level" : { + "type" : "string", + "description" : "The level of the bulletin." + }, + "message" : { + "type" : "string", + "description" : "The bulletin message." + }, + "timestamp" : { + "type" : "string", + "description" : "When this bulletin was generated." + } + } + }, + "BulletinEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64" + }, + "groupId" : { + "type" : "string" + }, + "sourceId" : { + "type" : "string" + }, + "timestamp" : { + "type" : "string", + "description" : "When this bulletin was generated." + }, + "nodeAddress" : { + "type" : "string" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "bulletin" : { + "$ref" : "#/definitions/BulletinDTO" + } + }, + "xml" : { + "name" : "bulletinEntity" + } + }, + "Bundle" : { + "type" : "object", + "properties" : { + "group" : { + "type" : "string", + "description" : "The group of the bundle" + }, + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle" + } + } + }, + "BundleDTO" : { + "type" : "object", + "properties" : { + "group" : { + "type" : "string", + "description" : "The group of the bundle." + }, + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle." + } + } + }, + "ClassLoaderDiagnosticsDTO" : { + "type" : "object", + "properties" : { + "bundle" : { + "description" : "Information about the Bundle that the ClassLoader belongs to, if any", + "$ref" : "#/definitions/BundleDTO" + }, + "parentClassLoader" : { + "description" : "A ClassLoaderDiagnosticsDTO that provides information about the parent ClassLoader", + "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" + } + } + }, + "ClusteSummaryEntity" : { + "type" : "object", + "properties" : { + "clusterSummary" : { + "$ref" : "#/definitions/ClusterSummaryDTO" + } + }, + "xml" : { + "name" : "clusterSummaryEntity" + } + }, + "ClusterDTO" : { + "type" : "object", + "properties" : { + "nodes" : { + "type" : "array", + "description" : "The collection of nodes that are part of the cluster.", + "items" : { + "$ref" : "#/definitions/NodeDTO" + } + }, + "generated" : { + "type" : "string", + "description" : "The timestamp the report was generated." + } + } + }, + "ClusterEntity" : { + "type" : "object", + "properties" : { + "cluster" : { + "$ref" : "#/definitions/ClusterDTO" + } + }, + "xml" : { + "name" : "clusterEntity" + } + }, + "ClusterSearchResultsEntity" : { + "type" : "object", + "properties" : { + "nodeResults" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/NodeSearchResultDTO" + } + } + }, + "xml" : { + "name" : "clusterSearchResultsEntity" + } + }, + "ClusterSummaryDTO" : { + "type" : "object", + "properties" : { + "connectedNodes" : { + "type" : "string", + "description" : "When clustered, reports the number of nodes connected vs the number of nodes in the cluster." + }, + "connectedNodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of nodes that are currently connected to the cluster" + }, + "totalNodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of nodes in the cluster, regardless of whether or not they are connected" + }, + "clustered" : { + "type" : "boolean", + "description" : "Whether this NiFi instance is clustered." + }, + "connectedToCluster" : { + "type" : "boolean", + "description" : "Whether this NiFi instance is connected to a cluster." + } + } + }, + "ComponentDetailsDTO" : { + "type" : "object" + }, + "ComponentDifferenceDTO" : { + "type" : "object", + "properties" : { + "componentType" : { + "type" : "string", + "description" : "The type of component" + }, + "componentId" : { + "type" : "string", + "description" : "The ID of the component" + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component" + }, + "processGroupId" : { + "type" : "string", + "description" : "The ID of the Process Group that the component belongs to" + }, + "differences" : { + "type" : "array", + "description" : "The differences in the component between the two flows", + "items" : { + "$ref" : "#/definitions/DifferenceDTO" + } + } + } + }, + "ComponentHistoryDTO" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The component id." + }, + "propertyHistory" : { + "type" : "object", + "description" : "The history for the properties of the component.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyHistoryDTO" + } + } + } + }, + "ComponentHistoryEntity" : { + "type" : "object", + "properties" : { + "componentHistory" : { + "$ref" : "#/definitions/ComponentHistoryDTO" + } + }, + "xml" : { + "name" : "componentHistoryEntity" + } + }, + "ComponentLifecycle" : { + "type" : "object" + }, + "ComponentManifest" : { + "type" : "object", + "properties" : { + "apis" : { + "type" : "array", + "description" : "Public interfaces defined in this bundle", + "items" : { + "$ref" : "#/definitions/DefinedType" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "Controller Services provided in this bundle", + "items" : { + "$ref" : "#/definitions/ControllerServiceDefinition" + } + }, + "processors" : { + "type" : "array", + "description" : "Processors provided in this bundle", + "items" : { + "$ref" : "#/definitions/ProcessorDefinition" + } + }, + "reportingTasks" : { + "type" : "array", + "description" : "Reporting Tasks provided in this bundle", + "items" : { + "$ref" : "#/definitions/ReportingTaskDefinition" + } + } + } + }, + "ComponentReferenceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the component." + } + } + }, + "ComponentReferenceEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "component" : { + "$ref" : "#/definitions/ComponentReferenceDTO" + } + }, + "xml" : { + "name" : "componentReferenceEntity" + } + }, + "ComponentRestrictionPermissionDTO" : { + "type" : "object", + "properties" : { + "requiredPermission" : { + "description" : "The required permission necessary for this restriction.", + "$ref" : "#/definitions/RequiredPermissionDTO" + }, + "permissions" : { + "description" : "The permissions for this component restriction. Note: the read permission are not used and will always be false.", + "$ref" : "#/definitions/PermissionsDTO" + } + } + }, + "ComponentSearchResultDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component that matched the search." + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the component that matched the search." + }, + "parentGroup" : { + "description" : "The parent group of the component that matched the search.", + "$ref" : "#/definitions/SearchResultGroupDTO" + }, + "versionedGroup" : { + "description" : "The nearest versioned ancestor group of the component that matched the search.", + "$ref" : "#/definitions/SearchResultGroupDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the component that matched the search." + }, + "matches" : { + "type" : "array", + "description" : "What matched the search from the component.", + "items" : { + "type" : "string" + } + } + } + }, + "ComponentStateDTO" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The component identifier." + }, + "stateDescription" : { + "type" : "string", + "description" : "Description of the state this component persists." + }, + "clusterState" : { + "description" : "The cluster state for this component, or null if this NiFi is a standalone instance.", + "$ref" : "#/definitions/StateMapDTO" + }, + "localState" : { + "description" : "The local state for this component.", + "$ref" : "#/definitions/StateMapDTO" + } + } + }, + "ComponentStateEntity" : { + "type" : "object", + "properties" : { + "componentState" : { + "description" : "The component state.", + "$ref" : "#/definitions/ComponentStateDTO" + } + }, + "xml" : { + "name" : "componentStateEntity" + } + }, + "ComponentValidationResultDTO" : { + "type" : "object", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this component is in" + }, + "id" : { + "type" : "string", + "description" : "The UUID of this component" + }, + "referenceType" : { + "type" : "string", + "description" : "The type of this component", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT" ] + }, + "name" : { + "type" : "string", + "description" : "The name of this component." + }, + "state" : { + "type" : "string", + "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string" + } + }, + "currentlyValid" : { + "type" : "boolean", + "description" : "Whether or not the component is currently valid" + }, + "resultsValid" : { + "type" : "boolean", + "description" : "Whether or not the component will be valid if the Parameter Context is changed" + }, + "resultantValidationErrors" : { + "type" : "array", + "description" : "The validation errors that will apply to the component if the Parameter Context is changed", + "items" : { + "type" : "string" + } + } + } + }, + "ComponentValidationResultEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ComponentValidationResultDTO" + } + }, + "xml" : { + "name" : "componentValidationResultEntity" + } + }, + "ComponentValidationResultsEntity" : { + "type" : "object", + "properties" : { + "validationResults" : { + "type" : "array", + "description" : "A List of ComponentValidationResultEntity, one for each component that is validated", + "items" : { + "$ref" : "#/definitions/ComponentValidationResultEntity" + } + } + }, + "xml" : { + "name" : "componentValidationResults" + } + }, + "ConfigVerificationResultDTO" : { + "type" : "object", + "properties" : { + "outcome" : { + "type" : "string", + "description" : "The outcome of the verification", + "enum" : [ "SUCCESSFUL", "FAILED", "SKIPPED" ] + }, + "verificationStepName" : { + "type" : "string", + "description" : "The name of the verification step" + }, + "explanation" : { + "type" : "string", + "description" : "An explanation of why the step was or was not successful" + } + } + }, + "ConfigurationAnalysisDTO" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The ID of the component" + }, + "properties" : { + "type" : "object", + "description" : "The configured properties for the component", + "additionalProperties" : { + "type" : "string" + } + }, + "referencedAttributes" : { + "type" : "object", + "description" : "The attributes that are referenced by the properties, mapped to recently used values", + "additionalProperties" : { + "type" : "string" + } + }, + "supportsVerification" : { + "type" : "boolean", + "description" : "Whether or not the component supports verification" + } + } + }, + "ConfigurationAnalysisEntity" : { + "type" : "object", + "properties" : { + "configurationAnalysis" : { + "description" : "The configuration analysis", + "$ref" : "#/definitions/ConfigurationAnalysisDTO" + } + }, + "xml" : { + "name" : "configurationAnalysis" + } + }, + "ConnectableComponent" : { + "type" : "object", + "required" : [ "groupId", "id", "type" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "type" : { + "type" : "string", + "description" : "The type of component the connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "name" : { + "type" : "string", + "description" : "The name of the connectable component" + }, + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + } + } + }, + "ConnectableDTO" : { + "type" : "object", + "required" : [ "groupId", "id", "type" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "type" : { + "type" : "string", + "description" : "The type of component the connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "name" : { + "type" : "string", + "description" : "The name of the connectable component" + }, + "running" : { + "type" : "boolean", + "description" : "Reflects the current state of the connectable component." + }, + "transmitting" : { + "type" : "boolean", + "description" : "If the connectable component represents a remote port, indicates if the target is configured to transmit." + }, + "exists" : { + "type" : "boolean", + "description" : "If the connectable component represents a remote port, indicates if the target exists." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + } + } + }, + "ConnectionDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "source" : { + "description" : "The source of the connection.", + "$ref" : "#/definitions/ConnectableDTO" + }, + "destination" : { + "description" : "The destination of the connection.", + "$ref" : "#/definitions/ConnectableDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the connection." + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "availableRelationships" : { + "type" : "array", + "description" : "The relationships that the source of the connection currently supports.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." + }, + "backPressureDataSizeThreshold" : { + "type" : "string", + "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." + }, + "flowFileExpiration" : { + "type" : "string", + "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string" + } + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/PositionDTO" + } + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "How to load balance the data in this Connection across the nodes in the cluster.", + "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] + }, + "loadBalancePartitionAttribute" : { + "type" : "string", + "description" : "The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE" + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not data should be compressed when being transferred between nodes in the cluster.", + "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "loadBalanceStatus" : { + "type" : "string", + "description" : "The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.", + "readOnly" : true, + "enum" : [ "LOAD_BALANCE_NOT_CONFIGURED", "LOAD_BALANCE_INACTIVE", "LOAD_BALANCE_ACTIVE" ] + } + } + }, + "ConnectionDiagnosticsDTO" : { + "type" : "object", + "properties" : { + "connection" : { + "description" : "Details about the connection", + "readOnly" : true, + "$ref" : "#/definitions/ConnectionDTO" + }, + "aggregateSnapshot" : { + "description" : "Aggregate values for all nodes in the cluster, or for this instance if not clustered", + "readOnly" : true, + "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A list of values for each node in the cluster, if clustered.", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/ConnectionDiagnosticsSnapshotDTO" + } + } + } + }, + "ConnectionDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "totalFlowFileCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of FlowFiles owned by the Connection" + }, + "totalByteCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" + }, + "nodeIdentifier" : { + "type" : "string", + "description" : "The Node Identifier that this information pertains to" + }, + "localQueuePartition" : { + "description" : "The local queue partition, from which components can pull FlowFiles on this node.", + "$ref" : "#/definitions/LocalQueuePartitionDTO" + }, + "remoteQueuePartitions" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/RemoteQueuePartitionDTO" + } + } + } + }, + "ConnectionEntity" : { + "type" : "object", + "required" : [ "destinationType", "sourceType" ], + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ConnectionDTO" + }, + "status" : { + "description" : "The status of the connection.", + "$ref" : "#/definitions/ConnectionStatusDTO" + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/PositionDTO" + } + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "sourceId" : { + "type" : "string", + "description" : "The identifier of the source of this connection." + }, + "sourceGroupId" : { + "type" : "string", + "description" : "The identifier of the group of the source of this connection." + }, + "sourceType" : { + "type" : "string", + "description" : "The type of component the source connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "destinationId" : { + "type" : "string", + "description" : "The identifier of the destination of this connection." + }, + "destinationGroupId" : { + "type" : "string", + "description" : "The identifier of the group of the destination of this connection." + }, + "destinationType" : { + "type" : "string", + "description" : "The type of component the destination connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + } + }, + "xml" : { + "name" : "connectionEntity" + } + }, + "ConnectionStatisticsDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the connection" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + }, + "aggregateSnapshot" : { + "description" : "The status snapshot that represents the aggregate stats of the cluster", + "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A list of status snapshots for each node", + "items" : { + "$ref" : "#/definitions/NodeConnectionStatisticsSnapshotDTO" + } + } + } + }, + "ConnectionStatisticsEntity" : { + "type" : "object", + "properties" : { + "connectionStatistics" : { + "$ref" : "#/definitions/ConnectionStatisticsDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "connectionStatisticsEntity" + } + }, + "ConnectionStatisticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "predictedMillisUntilCountBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." + }, + "predictedMillisUntilBytesBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." + }, + "predictedCountAtNextInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted number of queued objects at the next configured interval." + }, + "predictedBytesAtNextInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted total number of bytes in the queue at the next configured interval." + }, + "predictedPercentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted percentage of queued objects at the next configured interval." + }, + "predictedPercentBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted percentage of bytes in the queue against current threshold at the next configured interval." + }, + "predictionIntervalMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The prediction interval in seconds" + } + } + }, + "ConnectionStatusDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the connection" + }, + "groupId" : { + "type" : "string", + "description" : "The ID of the Process Group that the connection belongs to" + }, + "name" : { + "type" : "string", + "description" : "The name of the connection" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + }, + "sourceId" : { + "type" : "string", + "description" : "The ID of the source component" + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source component" + }, + "destinationId" : { + "type" : "string", + "description" : "The ID of the destination component" + }, + "destinationName" : { + "type" : "string", + "description" : "The name of the destination component" + }, + "aggregateSnapshot" : { + "description" : "The status snapshot that represents the aggregate stats of the cluster", + "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A list of status snapshots for each node", + "items" : { + "$ref" : "#/definitions/NodeConnectionStatusSnapshotDTO" + } + } + } + }, + "ConnectionStatusEntity" : { + "type" : "object", + "properties" : { + "connectionStatus" : { + "$ref" : "#/definitions/ConnectionStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "connectionStatusEntity" + } + }, + "ConnectionStatusPredictionsSnapshotDTO" : { + "type" : "object", + "properties" : { + "predictedMillisUntilCountBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count." + }, + "predictedMillisUntilBytesBackpressure" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue." + }, + "predictionIntervalSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "The configured interval (in seconds) for predicting connection queue count and size (and percent usage)." + }, + "predictedCountAtNextInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "The predicted number of queued objects at the next configured interval." + }, + "predictedBytesAtNextInterval" : { + "type" : "integer", + "format" : "int64", + "description" : "The predicted total number of bytes in the queue at the next configured interval." + }, + "predictedPercentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Predicted connection percent use regarding queued flow files count and backpressure threshold if configured." + }, + "predictedPercentBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "Predicted connection percent use regarding queued flow files size and backpressure threshold if configured." + } + } + }, + "ConnectionStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the process group the connection belongs to." + }, + "name" : { + "type" : "string", + "description" : "The name of the connection." + }, + "sourceId" : { + "type" : "string", + "description" : "The id of the source of the connection." + }, + "sourceName" : { + "type" : "string", + "description" : "The name of the source of the connection." + }, + "destinationId" : { + "type" : "string", + "description" : "The id of the destination of the connection." + }, + "destinationName" : { + "type" : "string", + "description" : "The name of the destination of the connection." + }, + "predictions" : { + "description" : "Predictions, if available, for this connection (null if not available)", + "$ref" : "#/definitions/ConnectionStatusPredictionsSnapshotDTO" + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have come into the connection in the last 5 minutes." + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that have come into the connection in the last 5 minutes." + }, + "input" : { + "type" : "string", + "description" : "The input count/size for the connection in the last 5 minutes, pretty printed." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have left the connection in the last 5 minutes." + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have left the connection in the last 5 minutes." + }, + "output" : { + "type" : "string", + "description" : "The output count/sie for the connection in the last 5 minutes, pretty printed." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that are currently queued in the connection." + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that are currently queued in the connection." + }, + "queued" : { + "type" : "string", + "description" : "The total count and size of queued flowfiles formatted." + }, + "queuedSize" : { + "type" : "string", + "description" : "The total size of flowfiles that are queued formatted." + }, + "queuedCount" : { + "type" : "string", + "description" : "The number of flowfiles that are queued, pretty printed." + }, + "percentUseCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Connection percent use regarding queued flow files count and backpressure threshold if configured." + }, + "percentUseBytes" : { + "type" : "integer", + "format" : "int32", + "description" : "Connection percent use regarding queued flow files size and backpressure threshold if configured." + }, + "flowFileAvailability" : { + "type" : "string", + "description" : "The availability of FlowFiles in this connection" + } + } + }, + "ConnectionStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connection." + }, + "connectionStatusSnapshot" : { + "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "ConnectionsEntity" : { + "type" : "object", + "properties" : { + "connections" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionEntity" + } + } + }, + "xml" : { + "name" : "connectionsEntity" + } + }, + "ControllerBulletinsEntity" : { + "type" : "object", + "properties" : { + "bulletins" : { + "type" : "array", + "description" : "System level bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "controllerServiceBulletins" : { + "type" : "array", + "description" : "Controller service bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "reportingTaskBulletins" : { + "type" : "array", + "description" : "Reporting task bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "parameterProviderBulletins" : { + "type" : "array", + "description" : "Parameter provider bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "flowRegistryClientBulletins" : { + "type" : "array", + "description" : "Flow registry client bulletins to be reported to the user.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + } + }, + "xml" : { + "name" : "controllerConfigurationEntity" + } + }, + "ControllerConfigurationDTO" : { + "type" : "object", + "properties" : { + "maxTimerDrivenThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of timer driven threads the NiFi has available." + }, + "maxEventDrivenThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of event driven threads the NiFi has available." + } + } + }, + "ControllerConfigurationEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "description" : "The controller configuration.", + "$ref" : "#/definitions/ControllerConfigurationDTO" + } + }, + "xml" : { + "name" : "controllerConfigurationEntity" + } + }, + "ControllerDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the NiFi." + }, + "name" : { + "type" : "string", + "description" : "The name of the NiFi." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the NiFi." + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in the NiFi." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the NiFi." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the NiFi." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the NiFi." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports contained in the NiFi." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports contained in the NiFi." + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports contained in the NiFi." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the NiFi." + }, + "remoteSiteListeningPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." + }, + "remoteSiteHttpListeningPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null." + }, + "siteToSiteSecure" : { + "type" : "boolean", + "description" : "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)." + }, + "instanceId" : { + "type" : "string", + "description" : "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi." + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports available to send data to for the NiFi.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports available to received data from the NiFi.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + } + } + }, + "ControllerEntity" : { + "type" : "object", + "properties" : { + "controller" : { + "$ref" : "#/definitions/ControllerDTO" + } + }, + "xml" : { + "name" : "controllerEntity" + } + }, + "ControllerServiceAPI" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this service interface.", + "$ref" : "#/definitions/Bundle" + } + } + }, + "ControllerServiceApiDTO" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this service interface.", + "$ref" : "#/definitions/BundleDTO" + } + } + }, + "ControllerServiceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the controller service." + }, + "type" : { + "type" : "string", + "description" : "The type of the controller service." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/BundleDTO" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceApiDTO" + } + }, + "comments" : { + "type" : "string", + "description" : "The comments for the controller service." + }, + "state" : { + "type" : "string", + "description" : "The state of the controller service.", + "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the controller service persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the controller service requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the ontroller service has been deprecated." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the controller service has multiple versions available." + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether the controller service supports sensitive dynamic properties." + }, + "properties" : { + "type" : "object", + "description" : "The properties of the controller service.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the controller service properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "sensitiveDynamicPropertyNames" : { + "type" : "array", + "description" : "Set of sensitive dynamic property names", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the controller services custom configuration UI if applicable." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "referencingComponents" : { + "type" : "array", + "description" : "All components referencing this controller service.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" + } + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the controller service will report bulletins." + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ControllerServiceDefinition" : { + "type" : "object", + "required" : [ "type" ], + "properties" : { + "group" : { + "type" : "string", + "description" : "The group name of the bundle that provides the referenced type." + }, + "artifact" : { + "type" : "string", + "description" : "The artifact name of the bundle that provides the referenced type." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle that provides the referenced type." + }, + "type" : { + "type" : "string", + "description" : "The fully-qualified class type" + }, + "typeDescription" : { + "type" : "string", + "description" : "The description of the type." + }, + "buildInfo" : { + "description" : "The build metadata for this component", + "$ref" : "#/definitions/BuildInfo" + }, + "providedApiImplementations" : { + "type" : "array", + "description" : "If this type represents a provider for an interface, this lists the APIs it implements", + "items" : { + "$ref" : "#/definitions/DefinedType" + } + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "seeAlso" : { + "type" : "array", + "description" : "The names of other component types that may be related", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether or not the component has been deprecated" + }, + "deprecationReason" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" + }, + "deprecationAlternatives" : { + "type" : "array", + "description" : "If this component has been deprecated, this optional field provides alternatives to use", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether or not the component has a general restriction" + }, + "restrictedExplanation" : { + "type" : "string", + "description" : "An optional description of the general restriction" + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "Explicit restrictions that indicate a require permission to use the component", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/Restriction" + } + }, + "stateful" : { + "description" : "Indicates if the component stores state", + "$ref" : "#/definitions/Stateful" + }, + "systemResourceConsiderations" : { + "type" : "array", + "description" : "The system resource considerations for the given component", + "items" : { + "$ref" : "#/definitions/SystemResourceConsideration" + } + }, + "additionalDetails" : { + "type" : "boolean", + "description" : "Indicates if the component has additional details documentation" + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "Descriptions of configuration properties applicable to this component.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptor" + } + }, + "supportsDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of dynamic (user-set) properties." + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of sensitive dynamic (user-set) properties." + }, + "dynamicProperties" : { + "type" : "array", + "description" : "Describes the dynamic properties supported by this component", + "items" : { + "$ref" : "#/definitions/DynamicProperty" + } + } + } + }, + "ControllerServiceDiagnosticsDTO" : { + "type" : "object", + "properties" : { + "controllerService" : { + "description" : "The Controller Service", + "$ref" : "#/definitions/ControllerServiceEntity" + }, + "classLoaderDiagnostics" : { + "description" : "Information about the Controller Service's Class Loader", + "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" + } + } + }, + "ControllerServiceEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this ControllerService." + }, + "component" : { + "$ref" : "#/definitions/ControllerServiceDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "status" : { + "description" : "The status for this ControllerService.", + "readOnly" : true, + "$ref" : "#/definitions/ControllerServiceStatusDTO" + } + }, + "xml" : { + "name" : "controllerServiceEntity" + } + }, + "ControllerServiceReferencingComponentDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank." + }, + "id" : { + "type" : "string", + "description" : "The id of the component referencing a controller service." + }, + "name" : { + "type" : "string", + "description" : "The name of the component referencing a controller service." + }, + "type" : { + "type" : "string", + "description" : "The type of the component referencing a controller service in simple Java class name format without package name." + }, + "state" : { + "type" : "string", + "description" : "The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state." + }, + "properties" : { + "type" : "object", + "description" : "The properties for the component.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the component properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the component.", + "items" : { + "type" : "string" + } + }, + "referenceType" : { + "type" : "string", + "description" : "The type of reference this is.", + "enum" : [ "Processor", "ControllerService", "ReportingTask", "FlowRegistryClient" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the referencing component." + }, + "referenceCycle" : { + "type" : "boolean", + "description" : "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy." + }, + "referencingComponents" : { + "type" : "array", + "description" : "If the referencing component represents a controller service, these are the components that reference it.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" + } + } + } + }, + "ControllerServiceReferencingComponentEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "controllerServiceReferencingComponentEntity" + } + }, + "ControllerServiceReferencingComponentsEntity" : { + "type" : "object", + "properties" : { + "controllerServiceReferencingComponents" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceReferencingComponentEntity" + } + } + }, + "xml" : { + "name" : "controllerServiceReferencingComponentsEntity" + } + }, + "ControllerServiceRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the ControllerService.", + "enum" : [ "ENABLED", "DISABLED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "uiOnly" : { + "type" : "boolean", + "description" : "Indicates whether or not responses should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ControllerServiceStatusDTO" : { + "type" : "object", + "properties" : { + "runStatus" : { + "type" : "string", + "description" : "The run status of this ControllerService", + "readOnly" : true, + "enum" : [ "ENABLED", "ENABLING", "DISABLED", "DISABLING" ] + }, + "validationStatus" : { + "type" : "string", + "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the component." + } + } + }, + "ControllerServiceTypesEntity" : { + "type" : "object", + "properties" : { + "controllerServiceTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "controllerServiceTypesEntity" + } + }, + "ControllerServicesEntity" : { + "type" : "object", + "properties" : { + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "controllerServices" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceEntity" + } + } + }, + "xml" : { + "name" : "controllerServicesEntity" + } + }, + "ControllerStatusDTO" : { + "type" : "object", + "properties" : { + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads in the NiFi." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of terminated threads in the NiFi." + }, + "queued" : { + "type" : "string", + "description" : "The number of flowfiles queued in the NiFi." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles queued across the entire flow" + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles queued across the entire flow" + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in the NiFi." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the NiFi." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the NiFi." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the NiFi." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the NiFi." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the NiFi." + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the NiFi." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the NiFi." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the NiFi." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the NiFi." + }, + "syncFailureCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of versioned process groups in the NiFi that are unable to sync to a registry." + } + } + }, + "ControllerStatusEntity" : { + "type" : "object", + "properties" : { + "controllerStatus" : { + "$ref" : "#/definitions/ControllerStatusDTO" + } + }, + "xml" : { + "name" : "controllerStatusEntity" + } + }, + "CopySnippetRequestEntity" : { + "type" : "object", + "properties" : { + "snippetId" : { + "type" : "string", + "description" : "The identifier of the snippet." + }, + "originX" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." + }, + "originY" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "copySnippetRequestEntity" + } + }, + "CounterDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the counter." + }, + "context" : { + "type" : "string", + "description" : "The context of the counter." + }, + "name" : { + "type" : "string", + "description" : "The name of the counter." + }, + "valueCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The value count." + }, + "value" : { + "type" : "string", + "description" : "The value of the counter." + } + } + }, + "CounterEntity" : { + "type" : "object", + "properties" : { + "counter" : { + "$ref" : "#/definitions/CounterDTO" + } + }, + "xml" : { + "name" : "counterEntity" + } + }, + "CountersDTO" : { + "type" : "object", + "properties" : { + "aggregateSnapshot" : { + "description" : "A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", + "$ref" : "#/definitions/CountersSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", + "items" : { + "$ref" : "#/definitions/NodeCountersSnapshotDTO" + } + } + } + }, + "CountersEntity" : { + "type" : "object", + "properties" : { + "counters" : { + "$ref" : "#/definitions/CountersDTO" + } + }, + "xml" : { + "name" : "countersEntity" + } + }, + "CountersSnapshotDTO" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "The timestamp when the report was generated." + }, + "counters" : { + "type" : "array", + "description" : "All counters in the NiFi.", + "items" : { + "$ref" : "#/definitions/CounterDTO" + } + } + } + }, + "CreateActiveRequestEntity" : { + "type" : "object", + "properties" : { + "processGroupId" : { + "type" : "string", + "description" : "The Process Group ID that this active request will update" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "createActiveRequestEntity" + } + }, + "CreateTemplateRequestEntity" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the template." + }, + "description" : { + "type" : "string", + "description" : "The description of the template." + }, + "snippetId" : { + "type" : "string", + "description" : "The identifier of the snippet." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "createTemplateRequestEntity" + } + }, + "CurrentUserEntity" : { + "type" : "object", + "properties" : { + "identity" : { + "type" : "string", + "description" : "The user identity being serialized." + }, + "anonymous" : { + "type" : "boolean", + "description" : "Whether the current user is anonymous." + }, + "provenancePermissions" : { + "description" : "Permissions for querying provenance.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "countersPermissions" : { + "description" : "Permissions for accessing counters.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "tenantsPermissions" : { + "description" : "Permissions for accessing tenants.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "controllerPermissions" : { + "description" : "Permissions for accessing the controller.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "policiesPermissions" : { + "description" : "Permissions for accessing the policies.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "systemPermissions" : { + "description" : "Permissions for accessing system.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "parameterContextPermissions" : { + "description" : "Permissions for accessing parameter contexts.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "restrictedComponentsPermissions" : { + "description" : "Permissions for accessing restricted components. Note: the read permission are not used and will always be false.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "componentRestrictionPermissions" : { + "type" : "array", + "description" : "Permissions for specific component restrictions.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentRestrictionPermissionDTO" + } + }, + "canVersionFlows" : { + "type" : "boolean", + "description" : "Whether the current user can version flows." + } + }, + "xml" : { + "name" : "currentEntity" + } + }, + "DefinedType" : { + "type" : "object", + "required" : [ "type" ], + "properties" : { + "group" : { + "type" : "string", + "description" : "The group name of the bundle that provides the referenced type." + }, + "artifact" : { + "type" : "string", + "description" : "The artifact name of the bundle that provides the referenced type." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle that provides the referenced type." + }, + "type" : { + "type" : "string", + "description" : "The fully-qualified class type" + }, + "typeDescription" : { + "type" : "string", + "description" : "The description of the type." + } + } + }, + "DifferenceDTO" : { + "type" : "object", + "properties" : { + "differenceType" : { + "type" : "string", + "description" : "The type of difference" + }, + "difference" : { + "type" : "string", + "description" : "Description of the difference" + } + } + }, + "DimensionsDTO" : { + "type" : "object", + "properties" : { + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + } + } + }, + "DocumentedTypeDTO" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the type." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this type.", + "$ref" : "#/definitions/BundleDTO" + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "If this type represents a ControllerService, this lists the APIs it implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceApiDTO" + } + }, + "description" : { + "type" : "string", + "description" : "The description of the type." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether this type is restricted." + }, + "usageRestriction" : { + "type" : "string", + "description" : "The optional description of why the usage of this component is restricted." + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ExplicitRestrictionDTO" + } + }, + "deprecationReason" : { + "type" : "string", + "description" : "The description of why the usage of this component is restricted." + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "DropRequestDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id for this drop request." + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this drop request." + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this drop request was updated." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "failureReason" : { + "type" : "string", + "description" : "The reason, if any, that this drop request failed." + }, + "currentCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files currently queued." + }, + "currentSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files currently queued in bytes." + }, + "current" : { + "type" : "string", + "description" : "The count and size of flow files currently queued." + }, + "originalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files to be dropped as a result of this request." + }, + "originalSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files to be dropped as a result of this request in bytes." + }, + "original" : { + "type" : "string", + "description" : "The count and size of flow files to be dropped as a result of this request." + }, + "droppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flow files that have been dropped thus far." + }, + "droppedSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of flow files that have been dropped thus far in bytes." + }, + "dropped" : { + "type" : "string", + "description" : "The count and size of flow files that have been dropped thus far." + }, + "state" : { + "type" : "string", + "description" : "The current state of the drop request." + } + } + }, + "DropRequestEntity" : { + "type" : "object", + "properties" : { + "dropRequest" : { + "$ref" : "#/definitions/DropRequestDTO" + } + }, + "xml" : { + "name" : "dropRequestEntity" + } + }, + "DtoFactory" : { + "type" : "object" + }, + "DynamicProperty" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The description of the dynamic property name" + }, + "value" : { + "type" : "string", + "description" : "The description of the dynamic property value" + }, + "description" : { + "type" : "string", + "description" : "The description of the dynamic property" + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "The scope of the expression language support", + "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] + } + } + }, + "DynamicRelationship" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The description of the dynamic relationship name" + }, + "description" : { + "type" : "string", + "description" : "The description of the dynamic relationship" + } + } + }, + "Entity" : { + "type" : "object", + "xml" : { + "name" : "entity" + } + }, + "ExplicitRestrictionDTO" : { + "type" : "object", + "properties" : { + "requiredPermission" : { + "description" : "The required permission necessary for this restriction.", + "$ref" : "#/definitions/RequiredPermissionDTO" + }, + "explanation" : { + "type" : "string", + "description" : "The description of why the usage of this component is restricted for this required permission." + } + } + }, + "ExternalControllerServiceReference" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the controller service" + }, + "name" : { + "type" : "string", + "description" : "The name of the controller service" + } + } + }, + "FlowBreadcrumbDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the group." + }, + "name" : { + "type" : "string", + "description" : "The id of the group." + }, + "versionControlInformation" : { + "description" : "The process group version control information or null if not version controlled.", + "$ref" : "#/definitions/VersionControlInformationDTO" + } + } + }, + "FlowBreadcrumbEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of this ancestor ProcessGroup." + }, + "permissions" : { + "description" : "The permissions for this ancestor ProcessGroup.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "breadcrumb" : { + "description" : "This breadcrumb.", + "$ref" : "#/definitions/FlowBreadcrumbDTO" + }, + "parentBreadcrumb" : { + "description" : "The parent breadcrumb for this breadcrumb.", + "$ref" : "#/definitions/FlowBreadcrumbEntity" + } + }, + "xml" : { + "name" : "flowEntity" + } + }, + "FlowComparisonEntity" : { + "type" : "object", + "properties" : { + "componentDifferences" : { + "type" : "array", + "description" : "The list of differences for each component in the flow that is not the same between the two flows", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentDifferenceDTO" + } + } + }, + "xml" : { + "name" : "flowComparisonEntity" + } + }, + "FlowConfigurationDTO" : { + "type" : "object", + "properties" : { + "supportsManagedAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", + "readOnly" : true + }, + "supportsConfigurableAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi supports a configurable authorizer.", + "readOnly" : true + }, + "supportsConfigurableUsersAndGroups" : { + "type" : "boolean", + "description" : "Whether this NiFi supports configurable users and groups.", + "readOnly" : true + }, + "autoRefreshIntervalSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "The interval in seconds between the automatic NiFi refresh requests.", + "readOnly" : true + }, + "currentTime" : { + "type" : "string", + "description" : "The current time on the system." + }, + "timeOffset" : { + "type" : "integer", + "format" : "int32", + "description" : "The time offset of the system." + }, + "defaultBackPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "The default back pressure object threshold." + }, + "defaultBackPressureDataSizeThreshold" : { + "type" : "string", + "description" : "The default back pressure data size threshold." + } + } + }, + "FlowConfigurationEntity" : { + "type" : "object", + "properties" : { + "flowConfiguration" : { + "description" : "The controller configuration.", + "$ref" : "#/definitions/FlowConfigurationDTO" + } + }, + "xml" : { + "name" : "flowConfigurationEntity" + } + }, + "FlowDTO" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "description" : "The process groups in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The remote process groups in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + }, + "processors" : { + "type" : "array", + "description" : "The processors in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessorEntity" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + }, + "connections" : { + "type" : "array", + "description" : "The connections in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionEntity" + } + }, + "labels" : { + "type" : "array", + "description" : "The labels in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/LabelEntity" + } + }, + "funnels" : { + "type" : "array", + "description" : "The funnels in this flow.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FunnelEntity" + } + } + } + }, + "FlowEntity" : { + "type" : "object", + "properties" : { + "flow" : { + "$ref" : "#/definitions/FlowDTO" + } + }, + "xml" : { + "name" : "flowEntity" + } + }, + "FlowFileDTO" : { + "type" : "object", + "properties" : { + "uri" : { + "type" : "string", + "description" : "The URI that can be used to access this FlowFile." + }, + "uuid" : { + "type" : "string", + "description" : "The FlowFile UUID." + }, + "filename" : { + "type" : "string", + "description" : "The FlowFile filename." + }, + "position" : { + "type" : "integer", + "format" : "int32", + "description" : "The FlowFile's position in the queue." + }, + "size" : { + "type" : "integer", + "format" : "int64", + "description" : "The FlowFile file size." + }, + "queuedDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "How long this FlowFile has been enqueued." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration since the FlowFile's greatest ancestor entered the flow." + }, + "penaltyExpiresIn" : { + "type" : "integer", + "format" : "int64", + "description" : "How long in milliseconds until the FlowFile penalty expires." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this FlowFile resides." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where this FlowFile resides." + }, + "attributes" : { + "type" : "object", + "description" : "The FlowFile attributes.", + "additionalProperties" : { + "type" : "string" + } + }, + "contentClaimSection" : { + "type" : "string", + "description" : "The section in which the content claim lives." + }, + "contentClaimContainer" : { + "type" : "string", + "description" : "The container in which the content claim lives." + }, + "contentClaimIdentifier" : { + "type" : "string", + "description" : "The identifier of the content claim." + }, + "contentClaimOffset" : { + "type" : "integer", + "format" : "int64", + "description" : "The offset into the content claim where the flowfile's content begins." + }, + "contentClaimFileSize" : { + "type" : "string", + "description" : "The file size of the content claim formatted." + }, + "contentClaimFileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The file size of the content claim in bytes." + }, + "penalized" : { + "type" : "boolean", + "description" : "If the FlowFile is penalized." + } + } + }, + "FlowFileEntity" : { + "type" : "object", + "properties" : { + "flowFile" : { + "$ref" : "#/definitions/FlowFileDTO" + } + }, + "xml" : { + "name" : "flowFileEntity" + } + }, + "FlowFileSummaryDTO" : { + "type" : "object", + "properties" : { + "uri" : { + "type" : "string", + "description" : "The URI that can be used to access this FlowFile." + }, + "uuid" : { + "type" : "string", + "description" : "The FlowFile UUID." + }, + "filename" : { + "type" : "string", + "description" : "The FlowFile filename." + }, + "position" : { + "type" : "integer", + "format" : "int32", + "description" : "The FlowFile's position in the queue." + }, + "size" : { + "type" : "integer", + "format" : "int64", + "description" : "The FlowFile file size." + }, + "queuedDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "How long this FlowFile has been enqueued." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "Duration since the FlowFile's greatest ancestor entered the flow." + }, + "penaltyExpiresIn" : { + "type" : "integer", + "format" : "int64", + "description" : "How long in milliseconds until the FlowFile penalty expires." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this FlowFile resides." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where this FlowFile resides." + }, + "penalized" : { + "type" : "boolean", + "description" : "If the FlowFile is penalized." + } + } + }, + "FlowRegistryBucket" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64" + }, + "permissions" : { + "$ref" : "#/definitions/FlowRegistryPermissions" + } + } + }, + "FlowRegistryBucketDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The bucket identifier" + }, + "name" : { + "type" : "string", + "description" : "The bucket name" + }, + "description" : { + "type" : "string", + "description" : "The bucket description" + }, + "created" : { + "type" : "integer", + "format" : "int64", + "description" : "The created timestamp of this bucket" + } + } + }, + "FlowRegistryBucketEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "bucket" : { + "$ref" : "#/definitions/FlowRegistryBucketDTO" + }, + "permissions" : { + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "bucketEntity" + } + }, + "FlowRegistryBucketsEntity" : { + "type" : "object", + "properties" : { + "buckets" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FlowRegistryBucketEntity" + } + } + }, + "xml" : { + "name" : "bucketsEntity" + } + }, + "FlowRegistryClientDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The registry identifier" + }, + "name" : { + "type" : "string", + "description" : "The registry name" + }, + "description" : { + "type" : "string", + "description" : "The registry description" + }, + "uri" : { + "type" : "string" + }, + "type" : { + "type" : "string", + "description" : "The type of the controller service." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/BundleDTO" + }, + "properties" : { + "type" : "object", + "description" : "The properties of the controller service.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the controller service properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "sensitiveDynamicPropertyNames" : { + "type" : "array", + "description" : "Set of sensitive dynamic property names", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether the reporting task supports sensitive dynamic properties." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the reporting task requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the reporting task has been deprecated." + }, + "validationErrors" : { + "type" : "array", + "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the flow registry client has multiple versions available." + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "FlowRegistryClientEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "registry" : { + "$ref" : "#/definitions/FlowRegistryClientDTO" + }, + "operatePermissions" : { + "$ref" : "#/definitions/PermissionsDTO" + }, + "component" : { + "$ref" : "#/definitions/FlowRegistryClientDTO" + } + }, + "xml" : { + "name" : "registryClientEntity" + } + }, + "FlowRegistryClientTypesEntity" : { + "type" : "object", + "properties" : { + "flowRegistryClientTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "flowRegistryClientTypesEntity" + } + }, + "FlowRegistryClientsEntity" : { + "type" : "object", + "properties" : { + "registries" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FlowRegistryClientEntity" + } + } + }, + "xml" : { + "name" : "registryClientsEntity" + } + }, + "FlowRegistryPermissions" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean" + }, + "canWrite" : { + "type" : "boolean" + }, + "canDelete" : { + "type" : "boolean" + } + } + }, + "FlowSnippetDTO" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "description" : "The process groups in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupDTO" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The remote process groups in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupDTO" + } + }, + "processors" : { + "type" : "array", + "description" : "The processors in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessorDTO" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The input ports in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortDTO" + } + }, + "connections" : { + "type" : "array", + "description" : "The connections in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionDTO" + } + }, + "labels" : { + "type" : "array", + "description" : "The labels in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/LabelDTO" + } + }, + "funnels" : { + "type" : "array", + "description" : "The funnels in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FunnelDTO" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "The controller services in this flow snippet.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceDTO" + } + } + } + }, + "FunnelDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + } + } + }, + "FunnelEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/FunnelDTO" + } + }, + "xml" : { + "name" : "funnelEntity" + } + }, + "FunnelsEntity" : { + "type" : "object", + "properties" : { + "funnels" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/FunnelEntity" + } + } + }, + "xml" : { + "name" : "funnelsEntity" + } + }, + "GCDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the Snapshot was taken" + }, + "collectionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of times that Garbage Collection has occurred" + }, + "collectionMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of milliseconds that the Garbage Collector spent performing Garbage Collection duties" + } + } + }, + "GarbageCollectionDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the garbage collector." + }, + "collectionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of times garbage collection has run." + }, + "collectionTime" : { + "type" : "string", + "description" : "The total amount of time spent garbage collecting." + }, + "collectionMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of milliseconds spent garbage collecting." + } + } + }, + "GarbageCollectionDiagnosticsDTO" : { + "type" : "object", + "properties" : { + "memoryManagerName" : { + "type" : "string", + "description" : "The name of the Memory Manager that this Garbage Collection information pertains to" + }, + "snapshots" : { + "type" : "array", + "description" : "A list of snapshots that have been taken to determine the health of the JVM's heap", + "items" : { + "$ref" : "#/definitions/GCDiagnosticsSnapshotDTO" + } + } + } + }, + "HistoryDTO" : { + "type" : "object", + "properties" : { + "total" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of number of actions that matched the search criteria.." + }, + "lastRefreshed" : { + "type" : "string", + "description" : "The timestamp when the report was generated." + }, + "actions" : { + "type" : "array", + "description" : "The actions.", + "items" : { + "$ref" : "#/definitions/ActionEntity" + } + } + } + }, + "HistoryEntity" : { + "type" : "object", + "properties" : { + "history" : { + "$ref" : "#/definitions/HistoryDTO" + } + }, + "xml" : { + "name" : "historyEntity" + } + }, + "InputPortsEntity" : { + "type" : "object", + "properties" : { + "inputPorts" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + } + }, + "xml" : { + "name" : "inputPortsEntity" + } + }, + "InputStream" : { + "type" : "object" + }, + "InstantiateTemplateRequestEntity" : { + "type" : "object", + "properties" : { + "originX" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate of the origin of the bounding box where the new components will be placed." + }, + "originY" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate of the origin of the bounding box where the new components will be placed." + }, + "templateId" : { + "type" : "string", + "description" : "The identifier of the template." + }, + "encodingVersion" : { + "type" : "string", + "description" : "The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency." + }, + "snippet" : { + "description" : "A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.", + "$ref" : "#/definitions/FlowSnippetDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "instantiateTemplateRequestEntity" + } + }, + "JVMControllerDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "primaryNode" : { + "type" : "boolean", + "description" : "Whether or not this node is primary node" + }, + "clusterCoordinator" : { + "type" : "boolean", + "description" : "Whether or not this node is cluster coordinator" + }, + "maxTimerDrivenThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of timer-driven threads" + }, + "maxEventDrivenThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of event-driven threads" + } + } + }, + "JVMDiagnosticsDTO" : { + "type" : "object", + "properties" : { + "clustered" : { + "type" : "boolean", + "description" : "Whether or not the NiFi instance is clustered" + }, + "connected" : { + "type" : "boolean", + "description" : "Whether or not the node is connected to the cluster" + }, + "aggregateSnapshot" : { + "description" : "Aggregate JVM diagnostic information about the entire cluster", + "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "Node-wise breakdown of JVM diagnostic information", + "items" : { + "$ref" : "#/definitions/NodeJVMDiagnosticsSnapshotDTO" + } + } + } + }, + "JVMDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "systemDiagnosticsDto" : { + "description" : "System-related diagnostics information", + "$ref" : "#/definitions/JVMSystemDiagnosticsSnapshotDTO" + }, + "flowDiagnosticsDto" : { + "description" : "Flow-related diagnostics information", + "$ref" : "#/definitions/JVMFlowDiagnosticsSnapshotDTO" + }, + "controllerDiagnostics" : { + "description" : "Controller-related diagnostics information", + "$ref" : "#/definitions/JVMControllerDiagnosticsSnapshotDTO" + } + } + }, + "JVMFlowDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "uptime" : { + "type" : "string", + "description" : "How long this node has been running, formatted as hours:minutes:seconds.milliseconds" + }, + "timeZone" : { + "type" : "string", + "description" : "The name of the Time Zone that is configured, if available" + }, + "activeTimerDrivenThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of timer-driven threads that are active" + }, + "activeEventDrivenThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of event-driven threads that are active" + }, + "bundlesLoaded" : { + "type" : "array", + "description" : "The NiFi Bundles (NARs) that are loaded by NiFi", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/BundleDTO" + } + } + } + }, + "JVMSystemDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "flowFileRepositoryStorageUsage" : { + "description" : "Information about the FlowFile Repository's usage", + "$ref" : "#/definitions/RepositoryUsageDTO" + }, + "contentRepositoryStorageUsage" : { + "type" : "array", + "description" : "Information about the Content Repository's usage", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RepositoryUsageDTO" + } + }, + "provenanceRepositoryStorageUsage" : { + "type" : "array", + "description" : "Information about the Provenance Repository's usage", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RepositoryUsageDTO" + } + }, + "maxHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The maximum number of bytes that the JVM heap is configured to use for heap" + }, + "maxHeap" : { + "type" : "string", + "description" : "The maximum number of bytes that the JVM heap is configured to use, as a human-readable value" + }, + "garbageCollectionDiagnostics" : { + "type" : "array", + "description" : "Diagnostic information about the JVM's garbage collections", + "items" : { + "$ref" : "#/definitions/GarbageCollectionDiagnosticsDTO" + } + }, + "cpuCores" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of CPU Cores available on the system" + }, + "cpuLoadAverage" : { + "type" : "number", + "format" : "double", + "description" : "The 1-minute CPU Load Average" + }, + "physicalMemoryBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of RAM available on the system" + }, + "physicalMemory" : { + "type" : "string", + "description" : "The number of bytes of RAM available on the system as a human-readable value" + }, + "openFileDescriptors" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of files that are open by the NiFi process" + }, + "maxOpenFileDescriptors" : { + "type" : "integer", + "format" : "int64", + "description" : "The maximum number of open file descriptors that are available to each process" + } + } + }, + "JmxMetricsResultDTO" : { + "type" : "object", + "properties" : { + "beanName" : { + "type" : "string", + "description" : "The bean name of the metrics bean." + }, + "attributeName" : { + "type" : "string", + "description" : "The attribute name of the metrics bean's attribute." + }, + "attributeValue" : { + "type" : "object", + "description" : "The attribute value of the the metrics bean's attribute" + } + } + }, + "JmxMetricsResultsEntity" : { + "type" : "object", + "properties" : { + "jmxMetricsResults" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/JmxMetricsResultDTO" + } + } + }, + "xml" : { + "name" : "jmxMetricsResult" + } + }, + "LabelDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the label." + }, + "style" : { + "type" : "object", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "LabelEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "dimensions" : { + "$ref" : "#/definitions/DimensionsDTO" + }, + "getzIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the label." + }, + "component" : { + "$ref" : "#/definitions/LabelDTO" + } + }, + "xml" : { + "name" : "labelEntity" + } + }, + "LabelsEntity" : { + "type" : "object", + "properties" : { + "labels" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/LabelEntity" + } + } + }, + "xml" : { + "name" : "labelsEntity" + } + }, + "LineageDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of this lineage query." + }, + "uri" : { + "type" : "string", + "description" : "The URI for this lineage query for later retrieval and deletion." + }, + "submissionTime" : { + "type" : "string", + "description" : "When the lineage query was submitted." + }, + "expiration" : { + "type" : "string", + "description" : "When the lineage query will expire." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The percent complete for the lineage query." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the lineage query has finished." + }, + "request" : { + "description" : "The initial lineage result.", + "$ref" : "#/definitions/LineageRequestDTO" + }, + "results" : { + "description" : "The results of the lineage query.", + "$ref" : "#/definitions/LineageResultsDTO" + } + } + }, + "LineageEntity" : { + "type" : "object", + "properties" : { + "lineage" : { + "$ref" : "#/definitions/LineageDTO" + } + }, + "xml" : { + "name" : "lineageEntity" + } + }, + "LineageRequestDTO" : { + "type" : "object", + "properties" : { + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored." + }, + "lineageRequestType" : { + "type" : "string", + "description" : "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.", + "enum" : [ "PARENTS", "CHILDREN", "and FLOWFILE" ] + }, + "uuid" : { + "type" : "string", + "description" : "The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node where this lineage originated if clustered." + } + } + }, + "LineageResultsDTO" : { + "type" : "object", + "properties" : { + "errors" : { + "type" : "array", + "description" : "Any errors that occurred while generating the lineage.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "nodes" : { + "type" : "array", + "description" : "The nodes in the lineage.", + "items" : { + "$ref" : "#/definitions/ProvenanceNodeDTO" + } + }, + "links" : { + "type" : "array", + "description" : "The links between the nodes in the lineage.", + "items" : { + "$ref" : "#/definitions/ProvenanceLinkDTO" + } + } + } + }, + "ListingRequestDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id for this listing request." + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this listing request." + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this listing request was updated." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "failureReason" : { + "type" : "string", + "description" : "The reason, if any, that this listing request failed." + }, + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of FlowFileSummary objects to return" + }, + "state" : { + "type" : "string", + "description" : "The current state of the listing request." + }, + "queueSize" : { + "description" : "The size of the queue", + "$ref" : "#/definitions/QueueSizeDTO" + }, + "flowFileSummaries" : { + "type" : "array", + "description" : "The FlowFile summaries. The summaries will be populated once the request has completed.", + "items" : { + "$ref" : "#/definitions/FlowFileSummaryDTO" + } + }, + "destinationRunning" : { + "type" : "boolean", + "description" : "Whether the destination of the connection is running" + }, + "sourceRunning" : { + "type" : "boolean", + "description" : "Whether the source of the connection is running" + } + } + }, + "ListingRequestEntity" : { + "type" : "object", + "properties" : { + "listingRequest" : { + "$ref" : "#/definitions/ListingRequestDTO" + } + }, + "xml" : { + "name" : "listingRequestEntity" + } + }, + "LocalQueuePartitionDTO" : { + "type" : "object", + "properties" : { + "totalFlowFileCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of FlowFiles owned by the Connection" + }, + "totalByteCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" + }, + "activeQueueFlowFileCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" + }, + "activeQueueByteCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" + }, + "swapFlowFileCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The total number of FlowFiles that are swapped out for this Connection" + }, + "swapByteCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" + }, + "swapFiles" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of Swap Files that exist for this Connection" + }, + "inFlightFlowFileCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." + }, + "inFlightByteCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" + }, + "allActiveQueueFlowFilesPenalized" : { + "type" : "boolean", + "description" : "Whether or not all of the FlowFiles in the Active Queue are penalized" + }, + "anyActiveQueueFlowFilesPenalized" : { + "type" : "boolean", + "description" : "Whether or not any of the FlowFiles in the Active Queue are penalized" + } + } + }, + "NodeConnectionStatisticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statisticsSnapshot" : { + "description" : "The connection status snapshot from the node.", + "$ref" : "#/definitions/ConnectionStatisticsSnapshotDTO" + } + } + }, + "NodeConnectionStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The connection status snapshot from the node.", + "$ref" : "#/definitions/ConnectionStatusSnapshotDTO" + } + } + }, + "NodeCountersSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "snapshot" : { + "description" : "The counters from the node.", + "$ref" : "#/definitions/CountersSnapshotDTO" + } + } + }, + "NodeDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The id of the node.", + "readOnly" : true + }, + "address" : { + "type" : "string", + "description" : "The node's host/ip address.", + "readOnly" : true + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The port the node is listening for API requests.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "The node's status." + }, + "heartbeat" : { + "type" : "string", + "description" : "the time of the nodes's last heartbeat.", + "readOnly" : true + }, + "connectionRequested" : { + "type" : "string", + "description" : "The time of the node's last connection request.", + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "The roles of this node.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active threads for the NiFi on the node.", + "readOnly" : true + }, + "queued" : { + "type" : "string", + "description" : "The queue the NiFi on the node.", + "readOnly" : true + }, + "events" : { + "type" : "array", + "description" : "The node's events.", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/NodeEventDTO" + } + }, + "nodeStartTime" : { + "type" : "string", + "description" : "The time at which this Node was last refreshed.", + "readOnly" : true + } + } + }, + "NodeEntity" : { + "type" : "object", + "properties" : { + "node" : { + "$ref" : "#/definitions/NodeDTO" + } + }, + "xml" : { + "name" : "nodeEntity" + } + }, + "NodeEventDTO" : { + "type" : "object", + "properties" : { + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the node event." + }, + "category" : { + "type" : "string", + "description" : "The category of the node event." + }, + "message" : { + "type" : "string", + "description" : "The message in the node event." + } + } + }, + "NodeIdentifier" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "apiAddress" : { + "type" : "string" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32" + }, + "socketAddress" : { + "type" : "string" + }, + "socketPort" : { + "type" : "integer", + "format" : "int32" + }, + "loadBalanceAddress" : { + "type" : "string" + }, + "loadBalancePort" : { + "type" : "integer", + "format" : "int32" + }, + "siteToSiteAddress" : { + "type" : "string" + }, + "siteToSitePort" : { + "type" : "integer", + "format" : "int32" + }, + "siteToSiteHttpApiPort" : { + "type" : "integer", + "format" : "int32" + }, + "siteToSiteSecure" : { + "type" : "boolean" + }, + "nodeIdentities" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "fullDescription" : { + "type" : "string" + } + } + }, + "NodeJVMDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "snapshot" : { + "description" : "The JVM Diagnostics Snapshot", + "$ref" : "#/definitions/JVMDiagnosticsSnapshotDTO" + } + } + }, + "NodePortStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The port status snapshot from the node.", + "$ref" : "#/definitions/PortStatusSnapshotDTO" + } + } + }, + "NodeProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The process group status snapshot from the node.", + "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" + } + } + }, + "NodeProcessorStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The processor status snapshot from the node.", + "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" + } + } + }, + "NodeRemoteProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "statusSnapshot" : { + "description" : "The remote process group status snapshot from the node.", + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" + } + } + }, + "NodeReplayLastEventSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "snapshot" : { + "description" : "The snapshot from the node", + "$ref" : "#/definitions/ReplayLastEventSnapshotDTO" + } + }, + "xml" : { + "name" : "nodeReplayLastEventSnapshot" + } + }, + "NodeResponse" : { + "type" : "object", + "properties" : { + "httpMethod" : { + "type" : "string" + }, + "requestUri" : { + "type" : "string", + "format" : "uri" + }, + "response" : { + "$ref" : "#/definitions/Response" + }, + "nodeId" : { + "$ref" : "#/definitions/NodeIdentifier" + }, + "throwable" : { + "$ref" : "#/definitions/Throwable" + }, + "updatedEntity" : { + "$ref" : "#/definitions/Entity" + }, + "requestId" : { + "type" : "string" + }, + "inputStream" : { + "$ref" : "#/definitions/InputStream" + }, + "clientResponse" : { + "$ref" : "#/definitions/Response" + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "is2xx" : { + "type" : "boolean" + }, + "is5xx" : { + "type" : "boolean" + } + } + }, + "NodeSearchResultDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the node that matched the search." + }, + "address" : { + "type" : "string", + "description" : "The address of the node that matched the search." + } + } + }, + "NodeStatusSnapshotsDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The id of the node." + }, + "address" : { + "type" : "string", + "description" : "The node's host/ip address." + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The port the node is listening for API requests." + }, + "statusSnapshots" : { + "type" : "array", + "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.", + "items" : { + "$ref" : "#/definitions/StatusSnapshotDTO" + } + } + } + }, + "NodeSystemDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The unique ID that identifies the node" + }, + "address" : { + "type" : "string", + "description" : "The API address of the node" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The API port used to communicate with the node" + }, + "snapshot" : { + "description" : "The System Diagnostics snapshot from the node.", + "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" + } + } + }, + "OutputPortsEntity" : { + "type" : "object", + "properties" : { + "outputPorts" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/PortEntity" + } + } + }, + "xml" : { + "name" : "outputPortsEntity" + } + }, + "ParameterContextDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The Name of the Parameter Context." + }, + "description" : { + "type" : "string", + "description" : "The Description of the Parameter Context." + }, + "parameters" : { + "type" : "array", + "description" : "The Parameters for the Parameter Context", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ParameterEntity" + } + }, + "boundProcessGroups" : { + "type" : "array", + "description" : "The Process Groups that are bound to this Parameter Context", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + }, + "inheritedParameterContexts" : { + "type" : "array", + "description" : "A list of references of Parameter Contexts from which this one inherits parameters", + "items" : { + "$ref" : "#/definitions/ParameterContextReferenceEntity" + } + }, + "parameterProviderConfiguration" : { + "description" : "Optional configuration for a Parameter Provider", + "$ref" : "#/definitions/ParameterProviderConfigurationEntity" + }, + "id" : { + "type" : "string", + "description" : "The ID the Parameter Context.", + "readOnly" : true + } + } + }, + "ParameterContextEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "description" : "The Parameter Context", + "$ref" : "#/definitions/ParameterContextDTO" + } + }, + "xml" : { + "name" : "parameterContextEntity" + } + }, + "ParameterContextReferenceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the Parameter Context" + }, + "name" : { + "type" : "string", + "description" : "The name of the Parameter Context" + } + } + }, + "ParameterContextReferenceEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "component" : { + "$ref" : "#/definitions/ParameterContextReferenceDTO" + } + }, + "xml" : { + "name" : "parameterContextReferenceEntity" + } + }, + "ParameterContextUpdateEntity" : { + "type" : "object", + "properties" : { + "parameterContextRevision" : { + "description" : "The Revision of the Parameter Context", + "$ref" : "#/definitions/RevisionDTO" + }, + "parameterContext" : { + "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", + "readOnly" : true, + "$ref" : "#/definitions/ParameterContextDTO" + }, + "referencingComponents" : { + "type" : "array", + "description" : "The components that are referenced by the update.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + }, + "xml" : { + "name" : "parameterContextUpdateEntity" + } + }, + "ParameterContextUpdateRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextUpdateStepDTO" + } + }, + "parameterContext" : { + "description" : "The Parameter Context that is being operated on. This may not be populated until the request has successfully completed.", + "readOnly" : true, + "$ref" : "#/definitions/ParameterContextDTO" + }, + "referencingComponents" : { + "type" : "array", + "description" : "The components that are referenced by the update.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "ParameterContextUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "parameterContextRevision" : { + "description" : "The Revision of the Parameter Context", + "$ref" : "#/definitions/RevisionDTO" + }, + "request" : { + "description" : "The Update Request", + "$ref" : "#/definitions/ParameterContextUpdateRequestDTO" + } + }, + "xml" : { + "name" : "parameterContextUpdateRequestEntity" + } + }, + "ParameterContextUpdateStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "ParameterContextValidationRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextValidationStepDTO" + } + }, + "parameterContext" : { + "description" : "The Parameter Context that is being operated on.", + "$ref" : "#/definitions/ParameterContextDTO" + }, + "componentValidationResults" : { + "description" : "The Validation Results that were calculated for each component. This value may not be set until the request completes.", + "readOnly" : true, + "$ref" : "#/definitions/ComponentValidationResultsEntity" + } + } + }, + "ParameterContextValidationRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "description" : "The Update Request", + "$ref" : "#/definitions/ParameterContextValidationRequestDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "parameterContextValidationRequestEntity" + } + }, + "ParameterContextValidationStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "ParameterContextsEntity" : { + "type" : "object", + "properties" : { + "parameterContexts" : { + "type" : "array", + "description" : "The Parameter Contexts", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextEntity" + } + }, + "currentTime" : { + "type" : "string", + "description" : "The current time on the system.", + "readOnly" : true + } + }, + "xml" : { + "name" : "parameterContexts" + } + }, + "ParameterDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the Parameter" + }, + "description" : { + "type" : "string", + "description" : "The description of the Parameter" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the Parameter is sensitive" + }, + "value" : { + "type" : "string", + "description" : "The value of the Parameter" + }, + "valueRemoved" : { + "type" : "boolean", + "description" : "Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The absence of the value may be used either to indicate that the value is not to be changed, or that the value is to be set to null (i.e., removed). This denotes which of the two scenarios is being encountered." + }, + "provided" : { + "type" : "boolean", + "description" : "Whether or not the Parameter is provided by a ParameterProvider" + }, + "referencingComponents" : { + "type" : "array", + "description" : "The set of all components in the flow that are referencing this Parameter", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + }, + "parameterContext" : { + "description" : "A reference to the Parameter Context that contains this one", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "inherited" : { + "type" : "boolean", + "description" : "Whether or not the Parameter is inherited from another context", + "readOnly" : true + } + } + }, + "ParameterEntity" : { + "type" : "object", + "properties" : { + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + }, + "parameter" : { + "description" : "The parameter information", + "$ref" : "#/definitions/ParameterDTO" + } + }, + "xml" : { + "name" : "parameterEntity" + } + }, + "ParameterGroupConfigurationEntity" : { + "type" : "object", + "properties" : { + "groupName" : { + "type" : "string", + "description" : "The name of the external parameter group to which the provided parameter names apply." + }, + "parameterContextName" : { + "type" : "string", + "description" : "The name of the ParameterContext that receives the parameters in this group" + }, + "parameterSensitivities" : { + "type" : "object", + "description" : "All fetched parameter names that should be applied.", + "additionalProperties" : { + "type" : "string", + "enum" : [ "SENSITIVE", "NON_SENSITIVE" ] + } + }, + "synchronized" : { + "type" : "boolean", + "description" : "True if this group should be synchronized to a ParameterContext, including creating one if it does not exist." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ParameterProviderApplyParametersRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/ParameterProviderApplyParametersUpdateStepDTO" + } + }, + "parameterProvider" : { + "description" : "The Parameter Provider that is being operated on. This may not be populated until the request has successfully completed.", + "readOnly" : true, + "$ref" : "#/definitions/ParameterProviderDTO" + }, + "parameterContextUpdates" : { + "type" : "array", + "description" : "The Parameter Contexts updated by this Parameter Provider. This may not be populated until the request has successfully completed.", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/ParameterContextUpdateEntity" + } + }, + "referencingComponents" : { + "type" : "array", + "description" : "The components that are referenced by the update.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "ParameterProviderApplyParametersRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "description" : "The Apply Parameters Request", + "$ref" : "#/definitions/ParameterProviderApplyParametersRequestDTO" + } + }, + "xml" : { + "name" : "parameterProviderApplyParametersRequestEntity" + } + }, + "ParameterProviderApplyParametersUpdateStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "ParameterProviderConfigurationDTO" : { + "type" : "object", + "properties" : { + "parameterProviderId" : { + "type" : "string", + "description" : "The ID of the Parameter Provider" + }, + "parameterProviderName" : { + "type" : "string", + "description" : "The name of the Parameter Provider" + }, + "parameterGroupName" : { + "type" : "string", + "description" : "The Parameter Group name that maps to the Parameter Context" + }, + "synchronized" : { + "type" : "boolean", + "description" : "True if the Parameter Context should receive the parameters from the mapped Parameter Group" + } + } + }, + "ParameterProviderConfigurationEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "component" : { + "$ref" : "#/definitions/ParameterProviderConfigurationDTO" + } + }, + "xml" : { + "name" : "parameterProviderConfigurationEntity" + } + }, + "ParameterProviderDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the parameter provider." + }, + "type" : { + "type" : "string", + "description" : "The fully qualified type of the parameter provider." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this parameter provider type.", + "$ref" : "#/definitions/BundleDTO" + }, + "comments" : { + "type" : "string", + "description" : "The comments of the parameter provider." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the parameter provider persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the parameter provider requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the parameter provider has been deprecated." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the parameter provider has multiple versions available." + }, + "properties" : { + "type" : "object", + "description" : "The properties of the parameter provider.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the parameter providers properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "parameterGroupConfigurations" : { + "type" : "array", + "description" : "Configuration for any fetched parameter groups.", + "items" : { + "$ref" : "#/definitions/ParameterGroupConfigurationEntity" + } + }, + "affectedComponents" : { + "type" : "array", + "description" : "The set of all components in the flow that are referencing Parameters provided by this provider", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + }, + "parameterStatus" : { + "type" : "array", + "description" : "The status of all provided parameters for this parameter provider", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ParameterStatusDTO" + } + }, + "referencingParameterContexts" : { + "type" : "array", + "description" : "The Parameter Contexts that reference this Parameter Provider", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ParameterProviderReferencingComponentEntity" + } + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the custom configuration UI for the parameter provider." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the parameter provider. This is how the custom UI relays configuration to the parameter provider." + }, + "validationErrors" : { + "type" : "array", + "description" : "Gets the validation errors from the parameter provider. These validation errors represent the problems with the parameter provider that must be resolved before it can be scheduled to run.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "Indicates whether the Parameter Provider is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Parameter Provider is valid)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ParameterProviderEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ParameterProviderDTO" + } + }, + "xml" : { + "name" : "parameterProviderEntity" + } + }, + "ParameterProviderParameterApplicationEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the parameter provider." + }, + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "parameterGroupConfigurations" : { + "type" : "array", + "description" : "Configuration for the fetched Parameter Groups", + "items" : { + "$ref" : "#/definitions/ParameterGroupConfigurationEntity" + } + } + }, + "xml" : { + "name" : "entity" + } + }, + "ParameterProviderParameterFetchEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the parameter provider." + }, + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ParameterProviderReference" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the parameter provider" + }, + "name" : { + "type" : "string", + "description" : "The name of the parameter provider" + }, + "type" : { + "type" : "string", + "description" : "The fully qualified name of the parameter provider class." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this parameter provider.", + "$ref" : "#/definitions/Bundle" + } + } + }, + "ParameterProviderReferencingComponentDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component referencing a parameter provider." + }, + "name" : { + "type" : "string", + "description" : "The name of the component referencing a parameter provider." + } + } + }, + "ParameterProviderReferencingComponentEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ParameterProviderReferencingComponentDTO" + } + }, + "xml" : { + "name" : "parameterProviderReferencingComponentEntity" + } + }, + "ParameterProviderReferencingComponentsEntity" : { + "type" : "object", + "properties" : { + "parameterProviderReferencingComponents" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ParameterProviderReferencingComponentEntity" + } + } + }, + "xml" : { + "name" : "parameterProviderReferencingComponentsEntity" + } + }, + "ParameterProviderTypesEntity" : { + "type" : "object", + "properties" : { + "parameterProviderTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "parameterProviderTypesEntity" + } + }, + "ParameterProvidersEntity" : { + "type" : "object", + "properties" : { + "parameterProviders" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ParameterProviderEntity" + } + } + }, + "xml" : { + "name" : "parameterProvidersEntity" + } + }, + "ParameterStatusDTO" : { + "type" : "object", + "properties" : { + "parameter" : { + "description" : "The name of the Parameter", + "$ref" : "#/definitions/ParameterEntity" + }, + "status" : { + "type" : "string", + "description" : "Indicates the status of the parameter, compared to the existing parameter context", + "enum" : [ "NEW", "CHANGED", "REMOVED", "MISSING_BUT_REFERENCED", "UNCHANGED" ] + } + } + }, + "PeerDTO" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "The hostname of this peer." + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "The port number of this peer." + }, + "secure" : { + "type" : "boolean", + "description" : "Returns if this peer connection is secure." + }, + "flowFileCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of flowFiles this peer holds." + } + } + }, + "PeersEntity" : { + "type" : "object", + "properties" : { + "peers" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/PeerDTO" + } + } + }, + "xml" : { + "name" : "peersEntity" + } + }, + "PermissionsDTO" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + } + } + }, + "PortDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the port." + }, + "state" : { + "type" : "string", + "description" : "The state of the port.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "userAccessControl" : { + "type" : "array", + "description" : "The users that are allowed to access the port.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "groupAccessControl" : { + "type" : "array", + "description" : "The user groups that are allowed to access the port.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." + }, + "validationErrors" : { + "type" : "array", + "description" : "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.", + "items" : { + "type" : "string" + } + } + } + }, + "PortEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/PortDTO" + }, + "status" : { + "description" : "The status of the port.", + "$ref" : "#/definitions/PortStatusDTO" + }, + "portType" : { + "type" : "string" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether this port can be accessed remotely via Site-to-Site protocol." + } + }, + "xml" : { + "name" : "portEntity" + } + }, + "PortRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the Port.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "PortStatusDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group of the port." + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the port.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "aggregateSnapshot" : { + "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", + "$ref" : "#/definitions/PortStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", + "items" : { + "$ref" : "#/definitions/NodePortStatusSnapshotDTO" + } + } + } + }, + "PortStatusEntity" : { + "type" : "object", + "properties" : { + "portStatus" : { + "$ref" : "#/definitions/PortStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "portStatusEntity" + } + }, + "PortStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group of the port." + }, + "name" : { + "type" : "string", + "description" : "The name of the port." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active thread count for the port." + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been accepted in the last 5 minutes." + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of hte FlowFiles that have been accepted in the last 5 minutes." + }, + "input" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been processed in the last 5 minutes." + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have been processed in the last 5 minutes." + }, + "output" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the port has incoming or outgoing connections to a remote NiFi." + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the port.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + } + } + }, + "PortStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "portStatusSnapshot" : { + "$ref" : "#/definitions/PortStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "Position" : { + "type" : "object", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + }, + "description" : "The position of a component on the graph" + }, + "PositionDTO" : { + "type" : "object", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + } + }, + "PreviousValueDTO" : { + "type" : "object", + "properties" : { + "previousValue" : { + "type" : "string", + "description" : "The previous value." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when the value was modified." + }, + "userIdentity" : { + "type" : "string", + "description" : "The user who changed the previous value." + } + } + }, + "PrioritizerTypesEntity" : { + "type" : "object", + "properties" : { + "prioritizerTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "prioritizerTypesEntity" + } + }, + "ProcessGroupDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the process group." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the process group." + }, + "variables" : { + "type" : "object", + "description" : "The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.", + "readOnly" : true, + "additionalProperties" : { + "type" : "string" + } + }, + "versionControlInformation" : { + "description" : "The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control", + "$ref" : "#/definitions/VersionControlInformationDTO" + }, + "parameterContext" : { + "description" : "The Parameter Context that this Process Group is bound to.", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "flowfileConcurrency" : { + "type" : "string", + "description" : "The FlowFile Concurrency for this Process Group.", + "enum" : [ "UNBOUNDED", "SINGLE_FLOWFILE_PER_NODE", "SINGLE_BATCH_PER_NODE" ] + }, + "flowfileOutboundPolicy" : { + "type" : "string", + "description" : "The Outbound Policy that is used for determining how FlowFiles should be transferred out of the Process Group.", + "enum" : [ "STREAM_WHEN_AVAILABLE", "BATCH_OUTPUT" ] + }, + "defaultFlowFileExpiration" : { + "type" : "string", + "description" : "The default FlowFile Expiration for this Process Group." + }, + "defaultBackPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied." + }, + "defaultBackPressureDataSizeThreshold" : { + "type" : "string", + "description" : "Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied." + }, + "logFileSuffix" : { + "type" : "string", + "description" : "The log file suffix for this Process Group for dedicated logging." + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in this process group." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the process group." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the process group." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the process group." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the process group." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the process group." + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the process group." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the process group." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the process group." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the process group." + }, + "syncFailureCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." + }, + "localInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local input ports in the process group." + }, + "localOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local output ports in the process group." + }, + "publicInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public input ports in the process group." + }, + "publicOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public output ports in the process group." + }, + "contents" : { + "description" : "The contents of this process group.", + "$ref" : "#/definitions/FlowSnippetDTO" + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports in the process group.", + "readOnly" : true + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the process group.", + "readOnly" : true + } + } + }, + "ProcessGroupEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ProcessGroupDTO" + }, + "status" : { + "description" : "The status of the process group.", + "$ref" : "#/definitions/ProcessGroupStatusDTO" + }, + "versionedFlowSnapshot" : { + "description" : "Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported", + "readOnly" : true, + "$ref" : "#/definitions/RegisteredFlowSnapshot" + }, + "runningCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of running components in this process group." + }, + "stoppedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stopped components in the process group." + }, + "invalidCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of invalid components in the process group." + }, + "disabledCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of disabled components in the process group." + }, + "activeRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote ports in the process group." + }, + "inactiveRemotePortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote ports in the process group." + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "upToDateCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of up to date versioned process groups in the process group." + }, + "locallyModifiedCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified versioned process groups in the process group." + }, + "staleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of stale versioned process groups in the process group." + }, + "locallyModifiedAndStaleCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of locally modified and stale versioned process groups in the process group." + }, + "syncFailureCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of versioned process groups in the process group that are unable to sync to a registry." + }, + "localInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local input ports in the process group." + }, + "localOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of local output ports in the process group." + }, + "publicInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public input ports in the process group." + }, + "publicOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of public output ports in the process group." + }, + "parameterContext" : { + "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "processGroupUpdateStrategy" : { + "type" : "string", + "description" : "Determines the process group update strategy", + "enum" : [ "DIRECT_CHILDREN", "ALL_DESCENDANTS" ] + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of input ports in the process group.", + "readOnly" : true + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of output ports in the process group.", + "readOnly" : true + } + }, + "xml" : { + "name" : "processGroupEntity" + } + }, + "ProcessGroupFlowDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "parameterContext" : { + "description" : "The Parameter Context, or null if no Parameter Context has been bound to the Process Group", + "$ref" : "#/definitions/ParameterContextReferenceEntity" + }, + "breadcrumb" : { + "description" : "The breadcrumb of the process group.", + "$ref" : "#/definitions/FlowBreadcrumbEntity" + }, + "flow" : { + "description" : "The flow structure starting at this Process Group.", + "$ref" : "#/definitions/FlowDTO" + }, + "lastRefreshed" : { + "type" : "string", + "description" : "The time the flow for the process group was last refreshed." + } + } + }, + "ProcessGroupFlowEntity" : { + "type" : "object", + "properties" : { + "permissions" : { + "description" : "The access policy for this process group.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "processGroupFlow" : { + "$ref" : "#/definitions/ProcessGroupFlowDTO" + } + }, + "xml" : { + "name" : "processGroupFlowEntity" + } + }, + "ProcessGroupImportEntity" : { + "type" : "object", + "properties" : { + "processGroupRevision" : { + "description" : "The Revision for the Process Group", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "versionedFlowSnapshot" : { + "description" : "The Versioned Flow Snapshot to import", + "$ref" : "#/definitions/RegisteredFlowSnapshot" + } + }, + "xml" : { + "name" : "processGroupImportEntity" + } + }, + "ProcessGroupNameDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the Process Group" + }, + "name" : { + "type" : "string", + "description" : "The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group" + } + } + }, + "ProcessGroupReplaceRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The unique ID of this request.", + "readOnly" : true + }, + "processGroupId" : { + "type" : "string", + "description" : "The unique ID of the Process Group being updated" + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this drop request.", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this request was updated.", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this request has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this request failed, or null if this request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The percentage complete for the request, between 0 and 100", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the request", + "readOnly" : true + } + } + }, + "ProcessGroupReplaceRequestEntity" : { + "type" : "object", + "properties" : { + "processGroupRevision" : { + "description" : "The revision for the Process Group being updated.", + "$ref" : "#/definitions/RevisionDTO" + }, + "request" : { + "description" : "The Process Group Change Request", + "$ref" : "#/definitions/ProcessGroupReplaceRequestDTO" + }, + "versionedFlowSnapshot" : { + "description" : "Returns the Versioned Flow to replace with", + "readOnly" : true, + "$ref" : "#/definitions/RegisteredFlowSnapshot" + } + }, + "xml" : { + "name" : "processGroupReplaceRequestEntity" + } + }, + "ProcessGroupStatusDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the Process Group" + }, + "name" : { + "type" : "string", + "description" : "The name of the Process Group" + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "aggregateSnapshot" : { + "description" : "The aggregate status of all nodes in the cluster", + "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.", + "items" : { + "$ref" : "#/definitions/NodeProcessGroupStatusSnapshotDTO" + } + } + } + }, + "ProcessGroupStatusEntity" : { + "type" : "object", + "properties" : { + "processGroupStatus" : { + "$ref" : "#/definitions/ProcessGroupStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "processGroupStatusEntity" + } + }, + "ProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the process group." + }, + "name" : { + "type" : "string", + "description" : "The name of this process group." + }, + "connectionStatusSnapshots" : { + "type" : "array", + "description" : "The status of all connections in the process group.", + "items" : { + "$ref" : "#/definitions/ConnectionStatusSnapshotEntity" + } + }, + "processorStatusSnapshots" : { + "type" : "array", + "description" : "The status of all processors in the process group.", + "items" : { + "$ref" : "#/definitions/ProcessorStatusSnapshotEntity" + } + }, + "processGroupStatusSnapshots" : { + "type" : "array", + "description" : "The status of all process groups in the process group.", + "items" : { + "$ref" : "#/definitions/ProcessGroupStatusSnapshotEntity" + } + }, + "remoteProcessGroupStatusSnapshots" : { + "type" : "array", + "description" : "The status of all remote process groups in the process group.", + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotEntity" + } + }, + "inputPortStatusSnapshots" : { + "type" : "array", + "description" : "The status of all input ports in the process group.", + "items" : { + "$ref" : "#/definitions/PortStatusSnapshotEntity" + } + }, + "outputPortStatusSnapshots" : { + "type" : "array", + "description" : "The status of all output ports in the process group.", + "items" : { + "$ref" : "#/definitions/PortStatusSnapshotEntity" + } + }, + "versionedFlowState" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes" + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that have come into this ProcessGroup in the last 5 minutes" + }, + "input" : { + "type" : "string", + "description" : "The input count/size for the process group in the last 5 minutes (pretty printed)." + }, + "flowFilesQueued" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that are queued up in this ProcessGroup right now" + }, + "bytesQueued" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that are queued up in this ProcessGroup right now" + }, + "queued" : { + "type" : "string", + "description" : "The count/size that is queued in the the process group." + }, + "queuedCount" : { + "type" : "string", + "description" : "The count that is queued for the process group." + }, + "queuedSize" : { + "type" : "string", + "description" : "The size that is queued for the process group." + }, + "bytesRead" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes read by components in this ProcessGroup in the last 5 minutes" + }, + "read" : { + "type" : "string", + "description" : "The number of bytes read in the last 5 minutes." + }, + "bytesWritten" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes written by components in this ProcessGroup in the last 5 minutes" + }, + "written" : { + "type" : "string", + "description" : "The number of bytes written in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes" + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes transferred out of this ProcessGroup in the last 5 minutes" + }, + "output" : { + "type" : "string", + "description" : "The output count/size for the process group in the last 5 minutes." + }, + "flowFilesTransferred" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes" + }, + "bytesTransferred" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes transferred in this ProcessGroup in the last 5 minutes" + }, + "transferred" : { + "type" : "string", + "description" : "The count/size transferred to/from queues in the process group in the last 5 minutes." + }, + "bytesReceived" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes" + }, + "flowFilesReceived" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes" + }, + "received" : { + "type" : "string", + "description" : "The count/size sent to the process group in the last 5 minutes." + }, + "bytesSent" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes" + }, + "flowFilesSent" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes" + }, + "sent" : { + "type" : "string", + "description" : "The count/size sent from this process group in the last 5 minutes." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The active thread count for this process group." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently terminated for the process group." + }, + "processingNanos" : { + "type" : "integer", + "format" : "int64" + } + } + }, + "ProcessGroupStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the process group." + }, + "processGroupStatusSnapshot" : { + "$ref" : "#/definitions/ProcessGroupStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessGroupsEntity" : { + "type" : "object", + "properties" : { + "processGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessGroupEntity" + } + } + }, + "xml" : { + "name" : "processGroupsEntity" + } + }, + "ProcessorConfigDTO" : { + "type" : "object", + "properties" : { + "properties" : { + "type" : "object", + "description" : "The properties for the processor. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "Descriptors for the processor's properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "sensitiveDynamicPropertyNames" : { + "type" : "array", + "description" : "Set of sensitive dynamic property names", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "Indcates whether the prcessor should be scheduled to run in event or timer driven mode." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amount of time that is used when the process penalizes a flowfile." + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." + }, + "autoTerminatedRelationships" : { + "type" : "array", + "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "comments" : { + "type" : "string", + "description" : "The comments for the processor." + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the processor's custom configuration UI if applicable." + }, + "lossTolerant" : { + "type" : "boolean", + "description" : "Whether the processor is loss tolerant." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." + }, + "defaultConcurrentTasks" : { + "type" : "object", + "description" : "Maps default values for concurrent tasks for each applicable scheduling strategy.", + "additionalProperties" : { + "type" : "string" + } + }, + "defaultSchedulingPeriod" : { + "type" : "object", + "description" : "Maps default values for scheduling period for each applicable scheduling strategy.", + "additionalProperties" : { + "type" : "string" + } + }, + "retryCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Overall number of retries." + }, + "retriedRelationships" : { + "type" : "array", + "description" : "All the relationships should be retried.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backoffMechanism" : { + "type" : "string", + "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", + "readOnly" : true, + "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] + }, + "maxBackoffPeriod" : { + "type" : "string", + "description" : "Maximum amount of time to be waited during a retry period." + } + } + }, + "ProcessorDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the processor." + }, + "type" : { + "type" : "string", + "description" : "The type of the processor." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this processor type.", + "$ref" : "#/definitions/BundleDTO" + }, + "state" : { + "type" : "string", + "description" : "The state of the processor", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "style" : { + "type" : "object", + "description" : "Styles for the processor (background-color : #eee).", + "additionalProperties" : { + "type" : "string" + } + }, + "relationships" : { + "type" : "array", + "description" : "The available relationships that the processor currently supports.", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/RelationshipDTO" + } + }, + "description" : { + "type" : "string", + "description" : "The description of the processor." + }, + "supportsParallelProcessing" : { + "type" : "boolean", + "description" : "Whether the processor supports parallel processing." + }, + "supportsEventDriven" : { + "type" : "boolean", + "description" : "Whether the processor supports event driven scheduling." + }, + "supportsBatching" : { + "type" : "boolean", + "description" : "Whether the processor supports batching. This makes the run duration settings available." + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether the processor supports sensitive dynamic properties." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the processor persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the processor requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the processor has been deprecated." + }, + "executionNodeRestricted" : { + "type" : "boolean", + "description" : "Indicates if the execution node of a processor is restricted to run only on the primary node" + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the processor has multiple versions available." + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement for this processor." + }, + "config" : { + "description" : "The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.", + "$ref" : "#/definitions/ProcessorConfigDTO" + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ProcessorDefinition" : { + "type" : "object", + "required" : [ "type" ], + "properties" : { + "group" : { + "type" : "string", + "description" : "The group name of the bundle that provides the referenced type." + }, + "artifact" : { + "type" : "string", + "description" : "The artifact name of the bundle that provides the referenced type." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle that provides the referenced type." + }, + "type" : { + "type" : "string", + "description" : "The fully-qualified class type" + }, + "typeDescription" : { + "type" : "string", + "description" : "The description of the type." + }, + "buildInfo" : { + "description" : "The build metadata for this component", + "$ref" : "#/definitions/BuildInfo" + }, + "providedApiImplementations" : { + "type" : "array", + "description" : "If this type represents a provider for an interface, this lists the APIs it implements", + "items" : { + "$ref" : "#/definitions/DefinedType" + } + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "seeAlso" : { + "type" : "array", + "description" : "The names of other component types that may be related", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether or not the component has been deprecated" + }, + "deprecationReason" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" + }, + "deprecationAlternatives" : { + "type" : "array", + "description" : "If this component has been deprecated, this optional field provides alternatives to use", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether or not the component has a general restriction" + }, + "restrictedExplanation" : { + "type" : "string", + "description" : "An optional description of the general restriction" + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "Explicit restrictions that indicate a require permission to use the component", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/Restriction" + } + }, + "stateful" : { + "description" : "Indicates if the component stores state", + "$ref" : "#/definitions/Stateful" + }, + "systemResourceConsiderations" : { + "type" : "array", + "description" : "The system resource considerations for the given component", + "items" : { + "$ref" : "#/definitions/SystemResourceConsideration" + } + }, + "additionalDetails" : { + "type" : "boolean", + "description" : "Indicates if the component has additional details documentation" + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "Descriptions of configuration properties applicable to this component.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptor" + } + }, + "supportsDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of dynamic (user-set) properties." + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of sensitive dynamic (user-set) properties." + }, + "dynamicProperties" : { + "type" : "array", + "description" : "Describes the dynamic properties supported by this component", + "items" : { + "$ref" : "#/definitions/DynamicProperty" + } + }, + "inputRequirement" : { + "type" : "string", + "description" : "Any input requirements this processor has.", + "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] + }, + "supportedRelationships" : { + "type" : "array", + "description" : "The supported relationships for this processor.", + "items" : { + "$ref" : "#/definitions/Relationship" + } + }, + "supportsDynamicRelationships" : { + "type" : "boolean", + "description" : "Whether or not this processor supports dynamic relationships." + }, + "dynamicRelationship" : { + "description" : "If the processor supports dynamic relationships, this describes the dynamic relationship", + "$ref" : "#/definitions/DynamicRelationship" + }, + "triggerSerially" : { + "type" : "boolean", + "description" : "Whether or not this processor should be triggered serially (i.e. no concurrent execution)." + }, + "triggerWhenEmpty" : { + "type" : "boolean", + "description" : "Whether or not this processor should be triggered when incoming queues are empty." + }, + "triggerWhenAnyDestinationAvailable" : { + "type" : "boolean", + "description" : "Whether or not this processor should be triggered when any destination queue has room." + }, + "supportsBatching" : { + "type" : "boolean", + "description" : "Whether or not this processor supports batching. If a Processor uses this annotation, it allows the Framework to batch calls to session commits, as well as allowing the Framework to return the same session multiple times." + }, + "supportsEventDriven" : { + "type" : "boolean", + "description" : "Whether or not this processor supports event driven scheduling. Indicates to the framework that the Processor is eligible to be scheduled to run based on the occurrence of an \"Event\" (e.g., when a FlowFile is enqueued in an incoming Connection), rather than being triggered periodically." + }, + "primaryNodeOnly" : { + "type" : "boolean", + "description" : "Whether or not this processor should be scheduled only on the primary node in a cluster." + }, + "sideEffectFree" : { + "type" : "boolean", + "description" : "Whether or not this processor is considered side-effect free. Side-effect free indicate that the processor's operations on FlowFiles can be safely repeated across process sessions." + }, + "supportedSchedulingStrategies" : { + "type" : "array", + "description" : "The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN.", + "items" : { + "type" : "string" + } + }, + "defaultSchedulingStrategy" : { + "type" : "string", + "description" : "The default scheduling strategy for the processor." + }, + "defaultConcurrentTasksBySchedulingStrategy" : { + "type" : "object", + "description" : "The default concurrent tasks for each scheduling strategy.", + "additionalProperties" : { + "type" : "integer", + "format" : "int32" + } + }, + "defaultSchedulingPeriodBySchedulingStrategy" : { + "type" : "object", + "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".", + "additionalProperties" : { + "type" : "string" + } + }, + "defaultPenaltyDuration" : { + "type" : "string", + "description" : "The default penalty duration as a time period, such as \"30 sec\"." + }, + "defaultYieldDuration" : { + "type" : "string", + "description" : "The default yield duration as a time period, such as \"1 sec\"." + }, + "defaultBulletinLevel" : { + "type" : "string", + "description" : "The default bulletin level, such as WARN, INFO, DEBUG, etc." + }, + "readsAttributes" : { + "type" : "array", + "description" : "The FlowFile attributes this processor reads", + "items" : { + "$ref" : "#/definitions/Attribute" + } + }, + "writesAttributes" : { + "type" : "array", + "description" : "The FlowFile attributes this processor writes/updates", + "items" : { + "$ref" : "#/definitions/Attribute" + } + } + } + }, + "ProcessorDiagnosticsDTO" : { + "type" : "object", + "properties" : { + "processor" : { + "description" : "Information about the Processor for which the Diagnostic Report is generated", + "$ref" : "#/definitions/ProcessorDTO" + }, + "processorStatus" : { + "description" : "The Status for the Processor for which the Diagnostic Report is generated", + "$ref" : "#/definitions/ProcessorStatusDTO" + }, + "referencedControllerServices" : { + "type" : "array", + "description" : "Diagnostic Information about all Controller Services that the Processor is referencing", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ControllerServiceDiagnosticsDTO" + } + }, + "incomingConnections" : { + "type" : "array", + "description" : "Diagnostic Information about all incoming Connections", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionDiagnosticsDTO" + } + }, + "outgoingConnections" : { + "type" : "array", + "description" : "Diagnostic Information about all outgoing Connections", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ConnectionDiagnosticsDTO" + } + }, + "jvmDiagnostics" : { + "description" : "Diagnostic Information about the JVM and system-level diagnostics", + "$ref" : "#/definitions/JVMDiagnosticsDTO" + }, + "threadDumps" : { + "type" : "array", + "description" : "Thread Dumps that were taken of the threads that are active in the Processor", + "items" : { + "$ref" : "#/definitions/ThreadDumpDTO" + } + }, + "classLoaderDiagnostics" : { + "description" : "Information about the Controller Service's Class Loader", + "$ref" : "#/definitions/ClassLoaderDiagnosticsDTO" + } + } + }, + "ProcessorDiagnosticsEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "description" : "The Processor Diagnostics", + "$ref" : "#/definitions/ProcessorDiagnosticsDTO" + } + }, + "xml" : { + "name" : "processorDiagnosticsEntity" + } + }, + "ProcessorEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ProcessorDTO" + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement for this processor." + }, + "status" : { + "$ref" : "#/definitions/ProcessorStatusDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "processorEntity" + } + }, + "ProcessorRunStatusDetailsDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The ID of the processor" + }, + "name" : { + "type" : "string", + "description" : "The name of the processor" + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the processor", + "enum" : [ "Running", "Stopped", "Invalid", "Validating", "Disabled" ] + }, + "validationErrors" : { + "type" : "array", + "description" : "The processor's validation errors", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The current number of threads that the processor is currently using" + } + } + }, + "ProcessorRunStatusDetailsEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for the Processor.", + "$ref" : "#/definitions/RevisionDTO" + }, + "permissions" : { + "description" : "The permissions for the Processor.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "runStatusDetails" : { + "description" : "The details of a Processor's run status", + "$ref" : "#/definitions/ProcessorRunStatusDetailsDTO" + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessorRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the Processor.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED", "RUN_ONCE" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessorStatusDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The unique ID of the process group that the Processor belongs to" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the Processor" + }, + "name" : { + "type" : "string", + "description" : "The name of the Processor" + }, + "type" : { + "type" : "string", + "description" : "The type of the Processor" + }, + "runStatus" : { + "type" : "string", + "description" : "The run status of the Processor", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The timestamp of when the stats were last refreshed" + }, + "aggregateSnapshot" : { + "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", + "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", + "items" : { + "$ref" : "#/definitions/NodeProcessorStatusSnapshotDTO" + } + } + } + }, + "ProcessorStatusEntity" : { + "type" : "object", + "properties" : { + "processorStatus" : { + "$ref" : "#/definitions/ProcessorStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "processorStatusEntity" + } + }, + "ProcessorStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the processor." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group to which the processor belongs." + }, + "name" : { + "type" : "string", + "description" : "The name of the prcessor." + }, + "type" : { + "type" : "string", + "description" : "The type of the processor." + }, + "runStatus" : { + "type" : "string", + "description" : "The state of the processor.", + "enum" : [ "Running", "Stopped", "Validating", "Disabled", "Invalid" ] + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute.", + "enum" : [ "ALL", "PRIMARY" ] + }, + "bytesRead" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes read by this Processor in the last 5 mintues" + }, + "bytesWritten" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes written by this Processor in the last 5 minutes" + }, + "read" : { + "type" : "string", + "description" : "The number of bytes read in the last 5 minutes." + }, + "written" : { + "type" : "string", + "description" : "The number of bytes written in the last 5 minutes." + }, + "flowFilesIn" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles that have been accepted in the last 5 minutes" + }, + "bytesIn" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles that have been accepted in the last 5 minutes" + }, + "input" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been accepted in the last 5 minutes." + }, + "flowFilesOut" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles transferred to a Connection in the last 5 minutes" + }, + "bytesOut" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles transferred to a Connection in the last 5 minutes" + }, + "output" : { + "type" : "string", + "description" : "The count/size of flowfiles that have been processed in the last 5 minutes." + }, + "taskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of times this Processor has run in the last 5 minutes" + }, + "tasksDurationNanos" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of nanoseconds that this Processor has spent running in the last 5 minutes" + }, + "tasks" : { + "type" : "string", + "description" : "The total number of task this connectable has completed over the last 5 minutes." + }, + "tasksDuration" : { + "type" : "string", + "description" : "The total duration of all tasks for this connectable over the last 5 minutes." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently executing in the processor." + }, + "terminatedThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of threads currently terminated for the processor." + } + } + }, + "ProcessorStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the processor." + }, + "processorStatusSnapshot" : { + "$ref" : "#/definitions/ProcessorStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "ProcessorTypesEntity" : { + "type" : "object", + "properties" : { + "processorTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "processorTypesEntity" + } + }, + "ProcessorsEntity" : { + "type" : "object", + "properties" : { + "processors" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ProcessorEntity" + } + } + }, + "xml" : { + "name" : "processorsEntity" + } + }, + "ProcessorsRunStatusDetailsEntity" : { + "type" : "object", + "properties" : { + "runStatusDetails" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ProcessorRunStatusDetailsEntity" + } + } + }, + "xml" : { + "name" : "processorsRunStatusDetails" + } + }, + "PropertyAllowableValue" : { + "type" : "object", + "required" : [ "value" ], + "properties" : { + "value" : { + "type" : "string", + "description" : "The internal value" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the value, if different from the internal value" + }, + "description" : { + "type" : "string", + "description" : "The description of the value, e.g., the behavior it produces." + } + } + }, + "PropertyDependency" : { + "type" : "object", + "properties" : { + "propertyName" : { + "type" : "string", + "description" : "The name of the property that is depended upon" + }, + "propertyDisplayName" : { + "type" : "string", + "description" : "The name of the property that is depended upon" + }, + "dependentValues" : { + "type" : "array", + "description" : "The values that satisfy the dependency", + "items" : { + "type" : "string" + } + } + } + }, + "PropertyDependencyDTO" : { + "type" : "object", + "properties" : { + "propertyName" : { + "type" : "string", + "description" : "The name of the property that is being depended upon" + }, + "dependentValues" : { + "type" : "array", + "description" : "The values for the property that satisfies the dependency, or null if the dependency is satisfied by the presence of any value for the associated property name", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "PropertyDescriptor" : { + "type" : "object", + "required" : [ "name" ], + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the property key" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the property key, if different from the name" + }, + "description" : { + "type" : "string", + "description" : "The description of what the property does" + }, + "allowableValues" : { + "type" : "array", + "description" : "A list of the allowable values for the property", + "items" : { + "$ref" : "#/definitions/PropertyAllowableValue" + } + }, + "defaultValue" : { + "type" : "string", + "description" : "The default value if a user-set value is not specified" + }, + "required" : { + "type" : "boolean", + "description" : "Whether or not the property is required for the component" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the value of the property is considered sensitive (e.g., passwords and keys)" + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "The scope of expression language supported by this property", + "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] + }, + "expressionLanguageScopeDescription" : { + "type" : "string", + "description" : "The description of the expression language scope supported by this property", + "readOnly" : true + }, + "typeProvidedByValue" : { + "description" : "Indicates that this property is for selecting a controller service of the specified type", + "$ref" : "#/definitions/DefinedType" + }, + "validRegex" : { + "type" : "string", + "description" : "A regular expression that can be used to validate the value of this property" + }, + "validator" : { + "type" : "string", + "description" : "Name of the validator used for this property descriptor" + }, + "dynamic" : { + "type" : "boolean", + "description" : "Whether or not the descriptor is for a dynamically added property" + }, + "resourceDefinition" : { + "description" : "Indicates that this property references external resources", + "$ref" : "#/definitions/PropertyResourceDefinition" + }, + "dependencies" : { + "type" : "array", + "description" : "The dependencies that this property has on other properties", + "items" : { + "$ref" : "#/definitions/PropertyDependency" + } + } + } + }, + "PropertyDescriptorDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name for the property." + }, + "displayName" : { + "type" : "string", + "description" : "The human readable name for the property." + }, + "description" : { + "type" : "string", + "description" : "The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent." + }, + "defaultValue" : { + "type" : "string", + "description" : "The default value for the property." + }, + "allowableValues" : { + "type" : "array", + "description" : "Allowable values for the property. If empty then the allowed values are not constrained.", + "items" : { + "$ref" : "#/definitions/AllowableValueEntity" + } + }, + "required" : { + "type" : "boolean", + "description" : "Whether the property is required." + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether the property is sensitive and protected whenever stored or represented." + }, + "dynamic" : { + "type" : "boolean", + "description" : "Whether the property is dynamic (user-defined)." + }, + "supportsEl" : { + "type" : "boolean", + "description" : "Whether the property supports expression language." + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "Scope of the Expression Language evaluation for the property." + }, + "identifiesControllerService" : { + "type" : "string", + "description" : "If the property identifies a controller service this returns the fully qualified type." + }, + "identifiesControllerServiceBundle" : { + "description" : "If the property identifies a controller service this returns the bundle of the type, null otherwise.", + "$ref" : "#/definitions/BundleDTO" + }, + "dependencies" : { + "type" : "array", + "description" : "A list of dependencies that must be met in order for this Property to be relevant. If any of these dependencies is not met, the property described by this Property Descriptor is not relevant.", + "items" : { + "$ref" : "#/definitions/PropertyDependencyDTO" + } + } + } + }, + "PropertyDescriptorEntity" : { + "type" : "object", + "properties" : { + "propertyDescriptor" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "xml" : { + "name" : "propertyDescriptor" + } + }, + "PropertyHistoryDTO" : { + "type" : "object", + "properties" : { + "previousValues" : { + "type" : "array", + "description" : "Previous values for a given property.", + "items" : { + "$ref" : "#/definitions/PreviousValueDTO" + } + } + } + }, + "PropertyResourceDefinition" : { + "type" : "object", + "properties" : { + "cardinality" : { + "type" : "string", + "description" : "The cardinality of the resource definition (i.e. single or multiple)", + "enum" : [ "SINGLE", "MULTIPLE" ] + }, + "resourceTypes" : { + "type" : "array", + "description" : "The types of resources that can be referenced", + "uniqueItems" : true, + "items" : { + "type" : "string", + "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] + } + } + } + }, + "ProvenanceDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the provenance query." + }, + "uri" : { + "type" : "string", + "description" : "The URI for this query. Used for obtaining/deleting the request at a later time" + }, + "submissionTime" : { + "type" : "string", + "description" : "The timestamp when the query was submitted." + }, + "expiration" : { + "type" : "string", + "description" : "The timestamp when the query will expire." + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The current percent complete." + }, + "finished" : { + "type" : "boolean", + "description" : "Whether the query has finished." + }, + "request" : { + "description" : "The provenance request.", + "$ref" : "#/definitions/ProvenanceRequestDTO" + }, + "results" : { + "description" : "The provenance results.", + "$ref" : "#/definitions/ProvenanceResultsDTO" + } + } + }, + "ProvenanceEntity" : { + "type" : "object", + "properties" : { + "provenance" : { + "$ref" : "#/definitions/ProvenanceDTO" + } + }, + "xml" : { + "name" : "provenanceEntity" + } + }, + "ProvenanceEventDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The event uuid." + }, + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "The event id. This is a one up number thats unique per node." + }, + "eventTime" : { + "type" : "string", + "description" : "The timestamp of the event." + }, + "eventDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The event duration in milliseconds." + }, + "lineageDuration" : { + "type" : "integer", + "format" : "int64", + "description" : "The duration since the lineage began, in milliseconds." + }, + "eventType" : { + "type" : "string", + "description" : "The type of the event." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The uuid of the flowfile for the event." + }, + "fileSize" : { + "type" : "string", + "description" : "The size of the flowfile for the event." + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the flowfile in bytes for the event." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier for the node where the event originated." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where the event originated." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set." + }, + "componentId" : { + "type" : "string", + "description" : "The id of the component that generated the event." + }, + "componentType" : { + "type" : "string", + "description" : "The type of the component that generated the event." + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component that generated the event." + }, + "sourceSystemFlowFileId" : { + "type" : "string", + "description" : "The source system flowfile id." + }, + "alternateIdentifierUri" : { + "type" : "string", + "description" : "The alternate identifier uri for the fileflow for the event." + }, + "attributes" : { + "type" : "array", + "description" : "The attributes of the flowfile for the event.", + "items" : { + "$ref" : "#/definitions/AttributeDTO" + } + }, + "parentUuids" : { + "type" : "array", + "description" : "The parent uuids for the event.", + "items" : { + "type" : "string" + } + }, + "childUuids" : { + "type" : "array", + "description" : "The child uuids for the event.", + "items" : { + "type" : "string" + } + }, + "transitUri" : { + "type" : "string", + "description" : "The source/destination system uri if the event was a RECEIVE/SEND." + }, + "relationship" : { + "type" : "string", + "description" : "The relationship to which the flowfile was routed if the event is of type ROUTE." + }, + "details" : { + "type" : "string", + "description" : "The event details." + }, + "contentEqual" : { + "type" : "boolean", + "description" : "Whether the input and output content claim is the same." + }, + "inputContentAvailable" : { + "type" : "boolean", + "description" : "Whether the input content is still available." + }, + "inputContentClaimSection" : { + "type" : "string", + "description" : "The section in which the input content claim lives." + }, + "inputContentClaimContainer" : { + "type" : "string", + "description" : "The container in which the input content claim lives." + }, + "inputContentClaimIdentifier" : { + "type" : "string", + "description" : "The identifier of the input content claim." + }, + "inputContentClaimOffset" : { + "type" : "integer", + "format" : "int64", + "description" : "The offset into the input content claim where the flowfiles content begins." + }, + "inputContentClaimFileSize" : { + "type" : "string", + "description" : "The file size of the input content claim formatted." + }, + "inputContentClaimFileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The file size of the intput content claim in bytes." + }, + "outputContentAvailable" : { + "type" : "boolean", + "description" : "Whether the output content is still available." + }, + "outputContentClaimSection" : { + "type" : "string", + "description" : "The section in which the output content claim lives." + }, + "outputContentClaimContainer" : { + "type" : "string", + "description" : "The container in which the output content claim lives." + }, + "outputContentClaimIdentifier" : { + "type" : "string", + "description" : "The identifier of the output content claim." + }, + "outputContentClaimOffset" : { + "type" : "integer", + "format" : "int64", + "description" : "The offset into the output content claim where the flowfiles content begins." + }, + "outputContentClaimFileSize" : { + "type" : "string", + "description" : "The file size of the output content claim formatted." + }, + "outputContentClaimFileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The file size of the output content claim in bytes." + }, + "replayAvailable" : { + "type" : "boolean", + "description" : "Whether or not replay is available." + }, + "replayExplanation" : { + "type" : "string", + "description" : "Explanation as to why replay is unavailable." + }, + "sourceConnectionIdentifier" : { + "type" : "string", + "description" : "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event." + } + } + }, + "ProvenanceEventEntity" : { + "type" : "object", + "properties" : { + "provenanceEvent" : { + "$ref" : "#/definitions/ProvenanceEventDTO" + } + }, + "xml" : { + "name" : "provenanceEventEntity" + } + }, + "ProvenanceLinkDTO" : { + "type" : "object", + "properties" : { + "sourceId" : { + "type" : "string", + "description" : "The source node id of the link." + }, + "targetId" : { + "type" : "string", + "description" : "The target node id of the link." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The flowfile uuid that traversed the link." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the link (based on the destination)." + }, + "millis" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of this link in milliseconds." + } + } + }, + "ProvenanceNodeDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the node." + }, + "flowFileUuid" : { + "type" : "string", + "description" : "The uuid of the flowfile associated with the provenance event." + }, + "parentUuids" : { + "type" : "array", + "description" : "The uuid of the parent flowfiles of the provenance event.", + "items" : { + "type" : "string" + } + }, + "childUuids" : { + "type" : "array", + "description" : "The uuid of the childrent flowfiles of the provenance event.", + "items" : { + "type" : "string" + } + }, + "clusterNodeIdentifier" : { + "type" : "string", + "description" : "The identifier of the node that this event/flowfile originated from." + }, + "type" : { + "type" : "string", + "description" : "The type of the node.", + "enum" : [ "FLOWFILE", "EVENT" ] + }, + "eventType" : { + "type" : "string", + "description" : "If the type is EVENT, this is the type of event." + }, + "millis" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of the node in milliseconds." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp of the node formatted." + } + } + }, + "ProvenanceOptionsDTO" : { + "type" : "object", + "properties" : { + "searchableFields" : { + "type" : "array", + "description" : "The available searchable field for the NiFi.", + "items" : { + "$ref" : "#/definitions/ProvenanceSearchableFieldDTO" + } + } + } + }, + "ProvenanceOptionsEntity" : { + "type" : "object", + "properties" : { + "provenanceOptions" : { + "$ref" : "#/definitions/ProvenanceOptionsDTO" + } + }, + "xml" : { + "name" : "provenanceOptionsEntity" + } + }, + "ProvenanceRequestDTO" : { + "type" : "object", + "properties" : { + "searchTerms" : { + "type" : "object", + "description" : "The search terms used to perform the search.", + "additionalProperties" : { + "$ref" : "#/definitions/ProvenanceSearchValueDTO" + } + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The id of the node in the cluster where this provenance originated." + }, + "startDate" : { + "type" : "string", + "description" : "The earliest event time to include in the query." + }, + "endDate" : { + "type" : "string", + "description" : "The latest event time to include in the query." + }, + "minimumFileSize" : { + "type" : "string", + "description" : "The minimum file size to include in the query." + }, + "maximumFileSize" : { + "type" : "string", + "description" : "The maximum file size to include in the query." + }, + "maxResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The maximum number of results to include." + }, + "summarize" : { + "type" : "boolean", + "description" : "Whether or not to summarize provenance events returned. This property is false by default." + }, + "incrementalResults" : { + "type" : "boolean", + "description" : "Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default." + } + } + }, + "ProvenanceResultsDTO" : { + "type" : "object", + "properties" : { + "provenanceEvents" : { + "type" : "array", + "description" : "The provenance events that matched the search criteria.", + "items" : { + "$ref" : "#/definitions/ProvenanceEventDTO" + } + }, + "total" : { + "type" : "string", + "description" : "The total number of results formatted." + }, + "totalCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of results." + }, + "generated" : { + "type" : "string", + "description" : "Then the search was performed." + }, + "oldestEvent" : { + "type" : "string", + "description" : "The oldest event available in the provenance repository." + }, + "timeOffset" : { + "type" : "integer", + "format" : "int32", + "description" : "The time offset of the server that's used for event time." + }, + "errors" : { + "type" : "array", + "description" : "Any errors that occurred while performing the provenance request.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "ProvenanceSearchValueDTO" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string", + "description" : "The search value." + }, + "inverse" : { + "type" : "boolean", + "description" : "Query for all except for search value." + } + } + }, + "ProvenanceSearchableFieldDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the searchable field." + }, + "field" : { + "type" : "string", + "description" : "The searchable field." + }, + "label" : { + "type" : "string", + "description" : "The label for the searchable field." + }, + "type" : { + "type" : "string", + "description" : "The type of the searchable field." + } + } + }, + "QueueSizeDTO" : { + "type" : "object", + "properties" : { + "byteCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of objects in a queue." + }, + "objectCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The count of objects in a queue." + } + } + }, + "RegisteredFlow" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "bucketIdentifier" : { + "type" : "string" + }, + "bucketName" : { + "type" : "string" + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64" + }, + "lastModifiedTimestamp" : { + "type" : "integer", + "format" : "int64" + }, + "permissions" : { + "$ref" : "#/definitions/FlowRegistryPermissions" + }, + "versionCount" : { + "type" : "integer", + "format" : "int64" + }, + "versionInfo" : { + "$ref" : "#/definitions/RegisteredFlowVersionInfo" + } + } + }, + "RegisteredFlowSnapshot" : { + "type" : "object", + "properties" : { + "snapshotMetadata" : { + "$ref" : "#/definitions/RegisteredFlowSnapshotMetadata" + }, + "flow" : { + "$ref" : "#/definitions/RegisteredFlow" + }, + "bucket" : { + "$ref" : "#/definitions/FlowRegistryBucket" + }, + "flowContents" : { + "$ref" : "#/definitions/VersionedProcessGroup" + }, + "externalControllerServices" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/definitions/ExternalControllerServiceReference" + } + }, + "parameterContexts" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedParameterContext" + } + }, + "flowEncodingVersion" : { + "type" : "string" + }, + "parameterProviders" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/definitions/ParameterProviderReference" + } + }, + "latest" : { + "type" : "boolean" + } + } + }, + "RegisteredFlowSnapshotMetadata" : { + "type" : "object", + "properties" : { + "bucketIdentifier" : { + "type" : "string" + }, + "flowIdentifier" : { + "type" : "string" + }, + "version" : { + "type" : "integer", + "format" : "int32" + }, + "timestamp" : { + "type" : "integer", + "format" : "int64" + }, + "author" : { + "type" : "string" + }, + "comments" : { + "type" : "string" + } + } + }, + "RegisteredFlowVersionInfo" : { + "type" : "object", + "properties" : { + "version" : { + "type" : "integer", + "format" : "int64" + } + } + }, + "Relationship" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the relationship" + }, + "description" : { + "type" : "string", + "description" : "The description of the relationship" + } + } + }, + "RelationshipDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The relationship name." + }, + "description" : { + "type" : "string", + "description" : "The relationship description." + }, + "autoTerminate" : { + "type" : "boolean", + "description" : "Whether or not flowfiles sent to this relationship should auto terminate." + }, + "retry" : { + "type" : "boolean", + "description" : "Whether or not flowfiles sent to this relationship should retry." + } + } + }, + "RemotePortRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the RemotePort.", + "enum" : [ "TRANSMITTING", "STOPPED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "RemoteProcessGroupContentsDTO" : { + "type" : "object", + "properties" : { + "inputPorts" : { + "type" : "array", + "description" : "The input ports to which data can be sent.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupPortDTO" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The output ports from which data can be retrieved.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupPortDTO" + } + } + } + }, + "RemoteProcessGroupDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "targetUri" : { + "type" : "string", + "description" : "The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null." + }, + "targetUris" : { + "type" : "string", + "description" : "The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null." + }, + "targetSecure" : { + "type" : "boolean", + "description" : "Whether the target is running securely." + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "comments" : { + "type" : "string", + "description" : "The comments for the remote process group." + }, + "communicationsTimeout" : { + "type" : "string", + "description" : "The time period used for the timeout when communicating with the target." + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + }, + "transportProtocol" : { + "type" : "string" + }, + "localNetworkInterface" : { + "type" : "string", + "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "proxyPassword" : { + "type" : "string" + }, + "authorizationIssues" : { + "type" : "array", + "description" : "Any remote authorization issues for the remote process group.", + "items" : { + "type" : "string" + } + }, + "validationErrors" : { + "type" : "array", + "description" : "The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.", + "items" : { + "type" : "string" + } + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the remote process group is actively transmitting." + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote input ports currently available on the target." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote output ports currently available on the target." + }, + "activeRemoteInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote input ports." + }, + "inactiveRemoteInputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote input ports." + }, + "activeRemoteOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active remote output ports." + }, + "inactiveRemoteOutputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of inactive remote output ports." + }, + "flowRefreshed" : { + "type" : "string", + "description" : "The timestamp when this remote process group was last refreshed." + }, + "contents" : { + "description" : "The contents of the remote process group. Will contain available input/output ports.", + "$ref" : "#/definitions/RemoteProcessGroupContentsDTO" + } + } + }, + "RemoteProcessGroupEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/RemoteProcessGroupDTO" + }, + "status" : { + "description" : "The status of the remote process group.", + "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" + }, + "inputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote input ports currently available on the target." + }, + "outputPortCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of remote output ports currently available on the target." + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "remoteProcessGroupEntity" + } + }, + "RemoteProcessGroupPortDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the port." + }, + "targetId" : { + "type" : "string", + "description" : "The id of the target port." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "groupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "name" : { + "type" : "string", + "description" : "The name of the target port." + }, + "comments" : { + "type" : "string", + "description" : "The comments as configured on the target port." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of task that may transmit flowfiles to the target port concurrently." + }, + "transmitting" : { + "type" : "boolean", + "description" : "Whether the remote port is configured for transmission." + }, + "useCompression" : { + "type" : "boolean", + "description" : "Whether the flowfiles are compressed when sent to the target port." + }, + "exists" : { + "type" : "boolean", + "description" : "Whether the target port exists." + }, + "targetRunning" : { + "type" : "boolean", + "description" : "Whether the target port is running." + }, + "connected" : { + "type" : "boolean", + "description" : "Whether the port has either an incoming or outgoing connection." + }, + "batchSettings" : { + "description" : "The batch settings for data transmission.", + "$ref" : "#/definitions/BatchSettingsDTO" + } + } + }, + "RemoteProcessGroupPortEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "remoteProcessGroupPort" : { + "$ref" : "#/definitions/RemoteProcessGroupPortDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + } + }, + "xml" : { + "name" : "remoteProcessGroupPortEntity" + } + }, + "RemoteProcessGroupStatusDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The unique ID of the process group that the Processor belongs to" + }, + "id" : { + "type" : "string", + "description" : "The unique ID of the Processor" + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "targetUri" : { + "type" : "string", + "description" : "The URI of the target system." + }, + "transmissionStatus" : { + "type" : "string", + "description" : "The transmission status of the remote process group." + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "The time the status for the process group was last refreshed." + }, + "validationStatus" : { + "type" : "string", + "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "aggregateSnapshot" : { + "description" : "A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", + "items" : { + "$ref" : "#/definitions/NodeRemoteProcessGroupStatusSnapshotDTO" + } + } + } + }, + "RemoteProcessGroupStatusEntity" : { + "type" : "object", + "properties" : { + "remoteProcessGroupStatus" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "remoteProcessGroupStatusEntity" + } + }, + "RemoteProcessGroupStatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the remote process group." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the parent process group the remote process group resides in." + }, + "name" : { + "type" : "string", + "description" : "The name of the remote process group." + }, + "targetUri" : { + "type" : "string", + "description" : "The URI of the target system." + }, + "transmissionStatus" : { + "type" : "string", + "description" : "The transmission status of the remote process group." + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the remote process group." + }, + "flowFilesSent" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles sent to the remote process group in the last 5 minutes." + }, + "bytesSent" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles sent to the remote process group in the last 5 minutes." + }, + "sent" : { + "type" : "string", + "description" : "The count/size of the flowfiles sent to the remote process group in the last 5 minutes." + }, + "flowFilesReceived" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of FlowFiles received from the remote process group in the last 5 minutes." + }, + "bytesReceived" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the FlowFiles received from the remote process group in the last 5 minutes." + }, + "received" : { + "type" : "string", + "description" : "The count/size of the flowfiles received from the remote process group in the last 5 minutes." + } + } + }, + "RemoteProcessGroupStatusSnapshotEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the remote process group." + }, + "remoteProcessGroupStatusSnapshot" : { + "$ref" : "#/definitions/RemoteProcessGroupStatusSnapshotDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "entity" + } + }, + "RemoteProcessGroupsEntity" : { + "type" : "object", + "properties" : { + "remoteProcessGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/RemoteProcessGroupEntity" + } + } + }, + "xml" : { + "name" : "remoteProcessGroupsEntity" + } + }, + "RemoteQueuePartitionDTO" : { + "type" : "object", + "properties" : { + "totalFlowFileCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of FlowFiles owned by the Connection" + }, + "totalByteCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes that make up the content for the FlowFiles owned by this Connection" + }, + "activeQueueFlowFileCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component" + }, + "activeQueueByteCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue" + }, + "swapFlowFileCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The total number of FlowFiles that are swapped out for this Connection" + }, + "swapByteCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection" + }, + "swapFiles" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of Swap Files that exist for this Connection" + }, + "inFlightFlowFileCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc." + }, + "inFlightByteCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number bytes that make up the content of the FlowFiles that are In-Flight" + }, + "nodeIdentifier" : { + "type" : "string", + "description" : "The Node Identifier that this queue partition is sending to" + } + } + }, + "ReplayLastEventRequestEntity" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The UUID of the component whose last event should be replayed." + }, + "nodes" : { + "type" : "string", + "description" : "Which nodes are to replay their last provenance event.", + "enum" : [ "ALL", "PRIMARY" ] + } + }, + "xml" : { + "name" : "replayLastEventRequestEntity" + } + }, + "ReplayLastEventResponseEntity" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The UUID of the component whose last event should be replayed." + }, + "nodes" : { + "type" : "string", + "description" : "Which nodes were requested to replay their last provenance event.", + "enum" : [ "ALL", "PRIMARY" ] + }, + "aggregateSnapshot" : { + "description" : "The aggregate result of all nodes' responses", + "$ref" : "#/definitions/ReplayLastEventSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "The node-wise results", + "items" : { + "$ref" : "#/definitions/NodeReplayLastEventSnapshotDTO" + } + } + }, + "xml" : { + "name" : "replayLastEventResponseEntity" + } + }, + "ReplayLastEventSnapshotDTO" : { + "type" : "object", + "properties" : { + "eventsReplayed" : { + "type" : "array", + "description" : "The IDs of the events that were successfully replayed", + "items" : { + "type" : "integer", + "format" : "int64" + } + }, + "failureExplanation" : { + "type" : "string", + "description" : "If unable to replay an event, specifies why the event could not be replayed" + }, + "eventAvailable" : { + "type" : "boolean", + "description" : "Whether or not an event was available. This may not be populated if there was a failure." + } + }, + "xml" : { + "name" : "replayLastEventSnapshot" + } + }, + "ReportingTaskDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "name" : { + "type" : "string", + "description" : "The name of the reporting task." + }, + "type" : { + "type" : "string", + "description" : "The fully qualified type of the reporting task." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this reporting task type.", + "$ref" : "#/definitions/BundleDTO" + }, + "state" : { + "type" : "string", + "description" : "The state of the reporting task.", + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "comments" : { + "type" : "string", + "description" : "The comments of the reporting task." + }, + "persistsState" : { + "type" : "boolean", + "description" : "Whether the reporting task persists state." + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether the reporting task requires elevated privileges." + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether the reporting task has been deprecated." + }, + "multipleVersionsAvailable" : { + "type" : "boolean", + "description" : "Whether the reporting task has multiple versions available." + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether the reporting task supports sensitive dynamic properties." + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the reporting task. The format of the value will depend on the value of the schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "The scheduling strategy that determines how the schedulingPeriod value should be interpreted." + }, + "defaultSchedulingPeriod" : { + "type" : "object", + "description" : "The default scheduling period for the different scheduling strategies.", + "additionalProperties" : { + "type" : "string" + } + }, + "properties" : { + "type" : "object", + "description" : "The properties of the reporting task.", + "additionalProperties" : { + "type" : "string" + } + }, + "descriptors" : { + "type" : "object", + "description" : "The descriptors for the reporting tasks properties.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptorDTO" + } + }, + "sensitiveDynamicPropertyNames" : { + "type" : "array", + "description" : "Set of sensitive dynamic property names", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "customUiUrl" : { + "type" : "string", + "description" : "The URL for the custom configuration UI for the reporting task." + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task." + }, + "validationErrors" : { + "type" : "array", + "description" : "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.", + "items" : { + "type" : "string" + } + }, + "validationStatus" : { + "type" : "string", + "description" : "Indicates whether the Reporting Task is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Reporting Task is valid)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the reporting task." + }, + "extensionMissing" : { + "type" : "boolean", + "description" : "Whether the underlying extension is missing." + } + } + }, + "ReportingTaskDefinition" : { + "type" : "object", + "required" : [ "type" ], + "properties" : { + "group" : { + "type" : "string", + "description" : "The group name of the bundle that provides the referenced type." + }, + "artifact" : { + "type" : "string", + "description" : "The artifact name of the bundle that provides the referenced type." + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle that provides the referenced type." + }, + "type" : { + "type" : "string", + "description" : "The fully-qualified class type" + }, + "typeDescription" : { + "type" : "string", + "description" : "The description of the type." + }, + "buildInfo" : { + "description" : "The build metadata for this component", + "$ref" : "#/definitions/BuildInfo" + }, + "providedApiImplementations" : { + "type" : "array", + "description" : "If this type represents a provider for an interface, this lists the APIs it implements", + "items" : { + "$ref" : "#/definitions/DefinedType" + } + }, + "tags" : { + "type" : "array", + "description" : "The tags associated with this type", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "seeAlso" : { + "type" : "array", + "description" : "The names of other component types that may be related", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "deprecated" : { + "type" : "boolean", + "description" : "Whether or not the component has been deprecated" + }, + "deprecationReason" : { + "type" : "string", + "description" : "If this component has been deprecated, this optional field can be used to provide an explanation" + }, + "deprecationAlternatives" : { + "type" : "array", + "description" : "If this component has been deprecated, this optional field provides alternatives to use", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "restricted" : { + "type" : "boolean", + "description" : "Whether or not the component has a general restriction" + }, + "restrictedExplanation" : { + "type" : "string", + "description" : "An optional description of the general restriction" + }, + "explicitRestrictions" : { + "type" : "array", + "description" : "Explicit restrictions that indicate a require permission to use the component", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/Restriction" + } + }, + "stateful" : { + "description" : "Indicates if the component stores state", + "$ref" : "#/definitions/Stateful" + }, + "systemResourceConsiderations" : { + "type" : "array", + "description" : "The system resource considerations for the given component", + "items" : { + "$ref" : "#/definitions/SystemResourceConsideration" + } + }, + "additionalDetails" : { + "type" : "boolean", + "description" : "Indicates if the component has additional details documentation" + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "Descriptions of configuration properties applicable to this component.", + "additionalProperties" : { + "$ref" : "#/definitions/PropertyDescriptor" + } + }, + "supportsDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of dynamic (user-set) properties." + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean", + "description" : "Whether or not this component makes use of sensitive dynamic (user-set) properties." + }, + "dynamicProperties" : { + "type" : "array", + "description" : "Describes the dynamic properties supported by this component", + "items" : { + "$ref" : "#/definitions/DynamicProperty" + } + }, + "supportedSchedulingStrategies" : { + "type" : "array", + "description" : "The supported scheduling strategies, such as TIME_DRIVER or CRON.", + "items" : { + "type" : "string" + } + }, + "defaultSchedulingStrategy" : { + "type" : "string", + "description" : "The default scheduling strategy for the reporting task." + }, + "defaultSchedulingPeriodBySchedulingStrategy" : { + "type" : "object", + "description" : "The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "ReportingTaskEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/ReportingTaskDTO" + }, + "operatePermissions" : { + "description" : "The permissions for this component operations.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "status" : { + "description" : "The status for this ReportingTask.", + "readOnly" : true, + "$ref" : "#/definitions/ReportingTaskStatusDTO" + } + }, + "xml" : { + "name" : "reportingTaskEntity" + } + }, + "ReportingTaskRunStatusEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "state" : { + "type" : "string", + "description" : "The run status of the ReportingTask.", + "enum" : [ "RUNNING", "STOPPED" ] + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "entity" + } + }, + "ReportingTaskStatusDTO" : { + "type" : "object", + "properties" : { + "runStatus" : { + "type" : "string", + "description" : "The run status of this ReportingTask", + "readOnly" : true, + "enum" : [ "RUNNING", "STOPPED", "DISABLED" ] + }, + "validationStatus" : { + "type" : "string", + "description" : "Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)", + "readOnly" : true, + "enum" : [ "VALID", "INVALID", "VALIDATING" ] + }, + "activeThreadCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of active threads for the component." + } + } + }, + "ReportingTaskTypesEntity" : { + "type" : "object", + "properties" : { + "reportingTaskTypes" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/DocumentedTypeDTO" + } + } + }, + "xml" : { + "name" : "reportingTaskTypesEntity" + } + }, + "ReportingTasksEntity" : { + "type" : "object", + "properties" : { + "reportingTasks" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ReportingTaskEntity" + } + } + }, + "xml" : { + "name" : "reportingTasksEntity" + } + }, + "RepositoryUsageDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the repository" + }, + "fileStoreHash" : { + "type" : "string", + "description" : "A SHA-256 hash of the File Store name/path that is used to store the repository's data. This information is exposed as a hash in order to avoid exposing potentially sensitive information that is not generally relevant. What is typically relevant is whether or not multiple repositories on the same node are using the same File Store, as this indicates that the repositories are competing for the resources of the backing disk/storage mechanism." + }, + "freeSpace" : { + "type" : "string", + "description" : "Amount of free space." + }, + "totalSpace" : { + "type" : "string", + "description" : "Amount of total space." + }, + "freeSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of free space." + }, + "totalSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of total space." + }, + "utilization" : { + "type" : "string", + "description" : "Utilization of this storage location." + } + } + }, + "RequiredPermissionDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The required sub-permission necessary for this restriction." + }, + "label" : { + "type" : "string", + "description" : "The label for the required sub-permission necessary for this restriction." + } + } + }, + "ResourceDTO" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the resource." + }, + "name" : { + "type" : "string", + "description" : "The name of the resource." + } + } + }, + "ResourcesEntity" : { + "type" : "object", + "properties" : { + "resources" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ResourceDTO" + } + } + }, + "xml" : { + "name" : "resourcesEntity" + } + }, + "Response" : { + "type" : "object", + "properties" : { + "metadata" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "items" : { + "type" : "object" + } + } + }, + "status" : { + "type" : "integer", + "format" : "int32" + }, + "entity" : { + "type" : "object" + } + } + }, + "Restriction" : { + "type" : "object", + "properties" : { + "requiredPermission" : { + "type" : "string", + "description" : "The permission required for this restriction" + }, + "explanation" : { + "type" : "string", + "description" : "The explanation of this restriction" + } + } + }, + "RevisionDTO" : { + "type" : "object", + "properties" : { + "clientId" : { + "type" : "string", + "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back" + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." + }, + "lastModifier" : { + "type" : "string", + "description" : "The user that last modified the flow.", + "readOnly" : true + } + } + }, + "RunStatusDetailsRequestEntity" : { + "type" : "object", + "properties" : { + "processorIds" : { + "type" : "array", + "description" : "The IDs of all processors whose run status details should be provided", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + }, + "xml" : { + "name" : "runStatusDetailsRequest" + } + }, + "RuntimeManifest" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "A unique identifier for the manifest" + }, + "agentType" : { + "type" : "string", + "description" : "The type of the runtime binary, e.g., 'minifi-java' or 'minifi-cpp'" + }, + "version" : { + "type" : "string", + "description" : "The version of the runtime binary, e.g., '1.0.1'" + }, + "buildInfo" : { + "description" : "Build summary for this runtime binary", + "$ref" : "#/definitions/BuildInfo" + }, + "bundles" : { + "type" : "array", + "description" : "All extension bundles included with this runtime", + "items" : { + "$ref" : "#/definitions/Bundle" + } + }, + "schedulingDefaults" : { + "description" : "Scheduling defaults for components defined in this manifest", + "$ref" : "#/definitions/SchedulingDefaults" + } + } + }, + "RuntimeManifestEntity" : { + "type" : "object", + "properties" : { + "runtimeManifest" : { + "$ref" : "#/definitions/RuntimeManifest" + } + }, + "xml" : { + "name" : "runtimeManifestEntity" + } + }, + "ScheduleComponentsEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the ProcessGroup" + }, + "state" : { + "type" : "string", + "description" : "The desired state of the descendant components", + "enum" : [ "RUNNING", "STOPPED", "ENABLED", "DISABLED" ] + }, + "components" : { + "type" : "object", + "description" : "Optional components to schedule. If not specified, all authorized descendant components will be used.", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "scheduleComponentEntity" + } + }, + "SchedulingDefaults" : { + "type" : "object", + "properties" : { + "defaultSchedulingStrategy" : { + "type" : "string", + "description" : "The name of the default scheduling strategy", + "enum" : [ "EVENT_DRIVEN", "TIMER_DRIVEN", "PRIMARY_NODE_ONLY", "CRON_DRIVEN" ] + }, + "defaultSchedulingPeriodMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The default scheduling period in milliseconds" + }, + "penalizationPeriodMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The default penalization period in milliseconds" + }, + "yieldDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The default yield duration in milliseconds" + }, + "defaultRunDurationNanos" : { + "type" : "integer", + "format" : "int64", + "description" : "The default run duration in nano-seconds" + }, + "defaultMaxConcurrentTasks" : { + "type" : "string", + "description" : "The default concurrent tasks" + }, + "defaultConcurrentTasksBySchedulingStrategy" : { + "type" : "object", + "description" : "The default concurrent tasks for each scheduling strategy", + "additionalProperties" : { + "type" : "integer", + "format" : "int32" + } + }, + "defaultSchedulingPeriodsBySchedulingStrategy" : { + "type" : "object", + "description" : "The default scheduling period for each scheduling strategy", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "SearchResultGroupDTO" : { + "type" : "object", + "required" : [ "id" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the group." + }, + "name" : { + "type" : "string", + "description" : "The name of the group." + } + } + }, + "SearchResultsDTO" : { + "type" : "object", + "properties" : { + "processorResults" : { + "type" : "array", + "description" : "The processors that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "connectionResults" : { + "type" : "array", + "description" : "The connections that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "processGroupResults" : { + "type" : "array", + "description" : "The process groups that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "inputPortResults" : { + "type" : "array", + "description" : "The input ports that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "outputPortResults" : { + "type" : "array", + "description" : "The output ports that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "remoteProcessGroupResults" : { + "type" : "array", + "description" : "The remote process groups that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "funnelResults" : { + "type" : "array", + "description" : "The funnels that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "labelResults" : { + "type" : "array", + "description" : "The labels that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "controllerServiceNodeResults" : { + "type" : "array", + "description" : "The controller service nodes that matched the search", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "parameterContextResults" : { + "type" : "array", + "description" : "The parameter contexts that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "parameterProviderNodeResults" : { + "type" : "array", + "description" : "The parameter provider nodes that matched the search", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + }, + "parameterResults" : { + "type" : "array", + "description" : "The parameters that matched the search.", + "items" : { + "$ref" : "#/definitions/ComponentSearchResultDTO" + } + } + } + }, + "SearchResultsEntity" : { + "type" : "object", + "properties" : { + "searchResultsDTO" : { + "$ref" : "#/definitions/SearchResultsDTO" + } + }, + "xml" : { + "name" : "searchResultsEntity" + } + }, + "SnippetDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the snippet." + }, + "uri" : { + "type" : "string", + "description" : "The URI of the snippet." + }, + "parentGroupId" : { + "type" : "string", + "description" : "The group id for the components in the snippet." + }, + "processGroups" : { + "type" : "object", + "description" : "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "remoteProcessGroups" : { + "type" : "object", + "description" : "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "processors" : { + "type" : "object", + "description" : "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "inputPorts" : { + "type" : "object", + "description" : "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "outputPorts" : { + "type" : "object", + "description" : "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "connections" : { + "type" : "object", + "description" : "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "labels" : { + "type" : "object", + "description" : "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "funnels" : { + "type" : "object", + "description" : "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + } + } + }, + "SnippetEntity" : { + "type" : "object", + "properties" : { + "snippet" : { + "description" : "The snippet.", + "$ref" : "#/definitions/SnippetDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "snippetEntity" + } + }, + "StackTraceElement" : { + "type" : "object", + "properties" : { + "classLoaderName" : { + "type" : "string" + }, + "moduleName" : { + "type" : "string" + }, + "moduleVersion" : { + "type" : "string" + }, + "methodName" : { + "type" : "string" + }, + "fileName" : { + "type" : "string" + }, + "lineNumber" : { + "type" : "integer", + "format" : "int32" + }, + "nativeMethod" : { + "type" : "boolean" + }, + "className" : { + "type" : "string" + } + } + }, + "StartVersionControlRequestEntity" : { + "type" : "object", + "properties" : { + "versionedFlow" : { + "description" : "The versioned flow", + "$ref" : "#/definitions/VersionedFlowDTO" + }, + "processGroupRevision" : { + "description" : "The Revision of the Process Group under Version Control", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "startVersionControlRequestEntity" + } + }, + "StateEntryDTO" : { + "type" : "object", + "properties" : { + "key" : { + "type" : "string", + "description" : "The key for this state." + }, + "value" : { + "type" : "string", + "description" : "The value for this state." + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier for the node where the state originated." + }, + "clusterNodeAddress" : { + "type" : "string", + "description" : "The label for the node where the state originated." + } + } + }, + "StateMapDTO" : { + "type" : "object", + "properties" : { + "scope" : { + "type" : "string", + "description" : "The scope of this StateMap." + }, + "totalEntryCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The total number of state entries. When the state map is lengthy, only of portion of the entries are returned." + }, + "state" : { + "type" : "array", + "description" : "The state.", + "items" : { + "$ref" : "#/definitions/StateEntryDTO" + } + } + } + }, + "Stateful" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Description of what information is being stored in the StateManager" + }, + "scopes" : { + "type" : "array", + "description" : "Indicates the Scope(s) associated with the State that is stored and retrieved", + "uniqueItems" : true, + "items" : { + "type" : "string", + "enum" : [ "CLUSTER", "LOCAL" ] + } + } + } + }, + "StatusDescriptorDTO" : { + "type" : "object", + "properties" : { + "field" : { + "type" : "string", + "description" : "The name of the status field." + }, + "label" : { + "type" : "string", + "description" : "The label for the status field." + }, + "description" : { + "type" : "string", + "description" : "The description of the status field." + }, + "formatter" : { + "type" : "string", + "description" : "The formatter for the status descriptor." + } + } + }, + "StatusHistoryDTO" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "When the status history was generated." + }, + "componentDetails" : { + "type" : "object", + "description" : "A Map of key/value pairs that describe the component that the status history belongs to", + "additionalProperties" : { + "type" : "string" + } + }, + "fieldDescriptors" : { + "type" : "array", + "description" : "The Descriptors that provide information on each of the metrics provided in the status history", + "items" : { + "$ref" : "#/definitions/StatusDescriptorDTO" + } + }, + "aggregateSnapshots" : { + "type" : "array", + "description" : "A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.", + "items" : { + "$ref" : "#/definitions/StatusSnapshotDTO" + } + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.", + "items" : { + "$ref" : "#/definitions/NodeStatusSnapshotsDTO" + } + } + } + }, + "StatusHistoryEntity" : { + "type" : "object", + "properties" : { + "statusHistory" : { + "$ref" : "#/definitions/StatusHistoryDTO" + }, + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "statusHistoryEntity" + } + }, + "StatusSnapshotDTO" : { + "type" : "object", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of the snapshot." + }, + "statusMetrics" : { + "type" : "object", + "description" : "The status metrics.", + "additionalProperties" : { + "type" : "integer", + "format" : "int64" + } + } + } + }, + "StorageUsageDTO" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration." + }, + "freeSpace" : { + "type" : "string", + "description" : "Amount of free space." + }, + "totalSpace" : { + "type" : "string", + "description" : "Amount of total space." + }, + "usedSpace" : { + "type" : "string", + "description" : "Amount of used space." + }, + "freeSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of free space." + }, + "totalSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of total space." + }, + "usedSpaceBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of used space." + }, + "utilization" : { + "type" : "string", + "description" : "Utilization of this storage location." + } + } + }, + "StreamingOutput" : { + "type" : "object" + }, + "SubmitReplayRequestEntity" : { + "type" : "object", + "properties" : { + "eventId" : { + "type" : "integer", + "format" : "int64", + "description" : "The event identifier" + }, + "clusterNodeId" : { + "type" : "string", + "description" : "The identifier of the node where to submit the replay request." + } + }, + "xml" : { + "name" : "copySnippetRequestEntity" + } + }, + "SystemDiagnosticsDTO" : { + "type" : "object", + "properties" : { + "aggregateSnapshot" : { + "description" : "A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.", + "$ref" : "#/definitions/SystemDiagnosticsSnapshotDTO" + }, + "nodeSnapshots" : { + "type" : "array", + "description" : "A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.", + "items" : { + "$ref" : "#/definitions/NodeSystemDiagnosticsSnapshotDTO" + } + } + } + }, + "SystemDiagnosticsEntity" : { + "type" : "object", + "properties" : { + "systemDiagnostics" : { + "$ref" : "#/definitions/SystemDiagnosticsDTO" + } + }, + "xml" : { + "name" : "systemDiagnosticsEntity" + } + }, + "SystemDiagnosticsSnapshotDTO" : { + "type" : "object", + "properties" : { + "totalNonHeap" : { + "type" : "string", + "description" : "Total size of non heap." + }, + "totalNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes allocated to the JVM not used for heap" + }, + "usedNonHeap" : { + "type" : "string", + "description" : "Amount of use non heap." + }, + "usedNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of bytes used by the JVM not in the heap space" + }, + "freeNonHeap" : { + "type" : "string", + "description" : "Amount of free non heap." + }, + "freeNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total number of free non-heap bytes available to the JVM" + }, + "maxNonHeap" : { + "type" : "string", + "description" : "Maximum size of non heap." + }, + "maxNonHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The maximum number of bytes that the JVM can use for non-heap purposes" + }, + "nonHeapUtilization" : { + "type" : "string", + "description" : "Utilization of non heap." + }, + "totalHeap" : { + "type" : "string", + "description" : "Total size of heap." + }, + "totalHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The total number of bytes that are available for the JVM heap to use" + }, + "usedHeap" : { + "type" : "string", + "description" : "Amount of used heap." + }, + "usedHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes of JVM heap that are currently being used" + }, + "freeHeap" : { + "type" : "string", + "description" : "Amount of free heap." + }, + "freeHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of bytes that are allocated to the JVM heap but not currently being used" + }, + "maxHeap" : { + "type" : "string", + "description" : "Maximum size of heap." + }, + "maxHeapBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "The maximum number of bytes that can be used by the JVM" + }, + "heapUtilization" : { + "type" : "string", + "description" : "Utilization of heap." + }, + "availableProcessors" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of available processors if supported by the underlying system." + }, + "processorLoadAverage" : { + "type" : "number", + "format" : "double", + "description" : "The processor load average if supported by the underlying system." + }, + "totalThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of threads." + }, + "daemonThreads" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of daemon threads." + }, + "uptime" : { + "type" : "string", + "description" : "The uptime of the Java virtual machine" + }, + "flowFileRepositoryStorageUsage" : { + "description" : "The flowfile repository storage usage.", + "$ref" : "#/definitions/StorageUsageDTO" + }, + "contentRepositoryStorageUsage" : { + "type" : "array", + "description" : "The content repository storage usage.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/StorageUsageDTO" + } + }, + "provenanceRepositoryStorageUsage" : { + "type" : "array", + "description" : "The provenance repository storage usage.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/StorageUsageDTO" + } + }, + "garbageCollection" : { + "type" : "array", + "description" : "The garbage collection details.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/GarbageCollectionDTO" + } + }, + "statsLastRefreshed" : { + "type" : "string", + "description" : "When the diagnostics were generated." + }, + "versionInfo" : { + "description" : "The nifi, os, java, and build version information", + "$ref" : "#/definitions/VersionInfoDTO" + } + } + }, + "SystemResourceConsideration" : { + "type" : "object", + "properties" : { + "resource" : { + "type" : "string", + "description" : "The resource to consider" + }, + "description" : { + "type" : "string", + "description" : "The description of how the resource is affected" + } + } + }, + "TemplateDTO" : { + "type" : "object", + "properties" : { + "uri" : { + "type" : "string", + "description" : "The URI for the template." + }, + "id" : { + "type" : "string", + "description" : "The id of the template." + }, + "groupId" : { + "type" : "string", + "description" : "The id of the Process Group that the template belongs to." + }, + "name" : { + "type" : "string", + "description" : "The name of the template." + }, + "description" : { + "type" : "string", + "description" : "The description of the template." + }, + "timestamp" : { + "type" : "string", + "description" : "The timestamp when this template was created." + }, + "encodingVersion" : { + "type" : "string", + "xml" : { + "name" : "encoding-version", + "attribute" : true + }, + "description" : "The encoding version of this template." + }, + "snippet" : { + "description" : "The contents of the template.", + "$ref" : "#/definitions/FlowSnippetDTO" + } + }, + "xml" : { + "name" : "template" + } + }, + "TemplateEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "template" : { + "$ref" : "#/definitions/TemplateDTO" + } + }, + "xml" : { + "name" : "templateEntity" + } + }, + "TemplatesEntity" : { + "type" : "object", + "properties" : { + "templates" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TemplateEntity" + } + }, + "generated" : { + "type" : "string", + "description" : "When this content was generated." + } + }, + "xml" : { + "name" : "templatesEntity" + } + }, + "TenantDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + } + } + }, + "TenantEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/TenantDTO" + } + }, + "xml" : { + "name" : "tenantEntity" + } + }, + "TenantsEntity" : { + "type" : "object", + "properties" : { + "users" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "userGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + } + }, + "xml" : { + "name" : "tenantsEntity" + } + }, + "ThreadDumpDTO" : { + "type" : "object", + "properties" : { + "nodeId" : { + "type" : "string", + "description" : "The ID of the node in the cluster" + }, + "nodeAddress" : { + "type" : "string", + "description" : "The address of the node in the cluster" + }, + "apiPort" : { + "type" : "integer", + "format" : "int32", + "description" : "The port the node is listening for API requests." + }, + "stackTrace" : { + "type" : "string", + "description" : "The stack trace for the thread" + }, + "threadName" : { + "type" : "string", + "description" : "The name of the thread" + }, + "threadActiveMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of milliseconds that the thread has been executing in the Processor" + }, + "taskTerminated" : { + "type" : "boolean", + "description" : "Indicates whether or not the user has requested that the task be terminated. If this is true, it may indicate that the thread is in a state where it will continue running indefinitely without returning." + } + } + }, + "Throwable" : { + "type" : "object", + "properties" : { + "cause" : { + "$ref" : "#/definitions/Throwable" + }, + "stackTrace" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/StackTraceElement" + } + }, + "message" : { + "type" : "string" + }, + "suppressed" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Throwable" + } + }, + "localizedMessage" : { + "type" : "string" + } + } + }, + "TransactionResultEntity" : { + "type" : "object", + "properties" : { + "flowFileSent" : { + "type" : "integer", + "format" : "int32" + }, + "responseCode" : { + "type" : "integer", + "format" : "int32" + }, + "message" : { + "type" : "string" + } + }, + "xml" : { + "name" : "transactionResultEntity" + } + }, + "UpdateControllerServiceReferenceRequestEntity" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The identifier of the Controller Service." + }, + "state" : { + "type" : "string", + "description" : "The new state of the references for the controller service.", + "enum" : [ "ENABLED", "DISABLED", "RUNNING", "STOPPED" ] + }, + "referencingComponentRevisions" : { + "type" : "object", + "description" : "The revisions for all referencing components.", + "additionalProperties" : { + "$ref" : "#/definitions/RevisionDTO" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "uiOnly" : { + "type" : "boolean", + "description" : "Indicates whether or not the response should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI." + } + }, + "xml" : { + "name" : "updateControllerServiceReferenceRequestEntity" + } + }, + "UserDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + }, + "userGroups" : { + "type" : "array", + "description" : "The groups to which the user belongs. This field is read only and it provided for convenience.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "accessPolicies" : { + "type" : "array", + "description" : "The access policies this user belongs to.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicySummaryEntity" + } + } + } + }, + "UserEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/UserDTO" + } + }, + "xml" : { + "name" : "userEntity" + } + }, + "UserGroupDTO" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "versionedComponentId" : { + "type" : "string", + "description" : "The ID of the corresponding component that is under version control" + }, + "parentGroupId" : { + "type" : "string", + "description" : "The id of parent process group of this component if applicable." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "identity" : { + "type" : "string", + "description" : "The identity of the tenant." + }, + "configurable" : { + "type" : "boolean", + "description" : "Whether this tenant is configurable." + }, + "users" : { + "type" : "array", + "description" : "The users that belong to the user group.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/TenantEntity" + } + }, + "accessPolicies" : { + "type" : "array", + "description" : "The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicyEntity" + } + } + } + }, + "UserGroupEntity" : { + "type" : "object", + "properties" : { + "revision" : { + "description" : "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.", + "$ref" : "#/definitions/RevisionDTO" + }, + "id" : { + "type" : "string", + "description" : "The id of the component." + }, + "uri" : { + "type" : "string", + "description" : "The URI for futures requests to the component." + }, + "position" : { + "description" : "The position of this component in the UI if applicable.", + "$ref" : "#/definitions/PositionDTO" + }, + "permissions" : { + "description" : "The permissions for this component.", + "$ref" : "#/definitions/PermissionsDTO" + }, + "bulletins" : { + "type" : "array", + "description" : "The bulletins for this component.", + "items" : { + "$ref" : "#/definitions/BulletinEntity" + } + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "component" : { + "$ref" : "#/definitions/UserGroupDTO" + } + }, + "xml" : { + "name" : "userGroupEntity" + } + }, + "UserGroupsEntity" : { + "type" : "object", + "properties" : { + "userGroups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/UserGroupEntity" + } + } + }, + "xml" : { + "name" : "userGroupsEntity" + } + }, + "UsersEntity" : { + "type" : "object", + "properties" : { + "generated" : { + "type" : "string", + "description" : "When this content was generated." + }, + "users" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/UserEntity" + } + } + }, + "xml" : { + "name" : "usersEntity" + } + }, + "VariableDTO" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the variable" + }, + "value" : { + "type" : "string", + "description" : "The value of the variable" + }, + "processGroupId" : { + "type" : "string", + "description" : "The ID of the Process Group where this Variable is defined", + "readOnly" : true + }, + "affectedComponents" : { + "type" : "array", + "description" : "A set of all components that will be affected if the value of this variable is changed", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "VariableEntity" : { + "type" : "object", + "properties" : { + "variable" : { + "description" : "The variable information", + "$ref" : "#/definitions/VariableDTO" + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + } + }, + "xml" : { + "name" : "variableEntity" + } + }, + "VariableRegistryDTO" : { + "type" : "object", + "properties" : { + "variables" : { + "type" : "array", + "description" : "The variables that are available in this Variable Registry", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VariableEntity" + } + }, + "processGroupId" : { + "type" : "string", + "description" : "The UUID of the Process Group that this Variable Registry belongs to" + } + } + }, + "VariableRegistryEntity" : { + "type" : "object", + "properties" : { + "processGroupRevision" : { + "description" : "The revision of the Process Group that the Variable Registry belongs to", + "$ref" : "#/definitions/RevisionDTO" + }, + "variableRegistry" : { + "description" : "The Variable Registry.", + "$ref" : "#/definitions/VariableRegistryDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "variableRegistryEntity" + } + }, + "VariableRegistryUpdateRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/VariableRegistryUpdateStepDTO" + } + }, + "processGroupId" : { + "type" : "string", + "description" : "The unique ID of the Process Group that the variable registry belongs to" + }, + "affectedComponents" : { + "type" : "array", + "description" : "A set of all components that will be affected if the value of this variable is changed", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AffectedComponentEntity" + } + } + } + }, + "VariableRegistryUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "description" : "The Variable Registry Update Request", + "$ref" : "#/definitions/VariableRegistryUpdateRequestDTO" + }, + "processGroupRevision" : { + "description" : "The revision for the Process Group that owns this variable registry.", + "$ref" : "#/definitions/RevisionDTO" + } + }, + "xml" : { + "name" : "variableRegistryUpdateRequestEntity" + } + }, + "VariableRegistryUpdateStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "VerifyConfigRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The ID of the request", + "readOnly" : true + }, + "uri" : { + "type" : "string", + "description" : "The URI for the request", + "readOnly" : true + }, + "submissionTime" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was submitted", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "The timestamp of when the request was last updated", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not the request is completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "The reason for the request failing, or null if the request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "A value between 0 and 100 (inclusive) indicating how close the request is to completion", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "A description of the current state of the request", + "readOnly" : true + }, + "updateSteps" : { + "type" : "array", + "description" : "The steps that are required in order to complete the request, along with the status of each", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/VerifyConfigUpdateStepDTO" + } + }, + "componentId" : { + "type" : "string", + "description" : "The ID of the component whose configuration was verified" + }, + "properties" : { + "type" : "object", + "description" : "The configured component properties", + "additionalProperties" : { + "type" : "string" + } + }, + "attributes" : { + "type" : "object", + "description" : "FlowFile Attributes that should be used to evaluate Expression Language for resolving property values", + "additionalProperties" : { + "type" : "string" + } + }, + "results" : { + "type" : "array", + "description" : "The Results of the verification", + "readOnly" : true, + "items" : { + "$ref" : "#/definitions/ConfigVerificationResultDTO" + } + } + } + }, + "VerifyConfigRequestEntity" : { + "type" : "object", + "properties" : { + "request" : { + "description" : "The request", + "$ref" : "#/definitions/VerifyConfigRequestDTO" + } + }, + "xml" : { + "name" : "verifyConfigRequest" + } + }, + "VerifyConfigUpdateStepDTO" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Explanation of what happens in this step", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this step has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this step failed, or null if this step did not fail", + "readOnly" : true + } + } + }, + "VersionControlComponentMappingEntity" : { + "type" : "object", + "properties" : { + "versionControlComponentMapping" : { + "type" : "object", + "description" : "The mapping of Versioned Component Identifiers to instance ID's", + "additionalProperties" : { + "type" : "string" + } + }, + "processGroupRevision" : { + "description" : "The revision of the Process Group", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "versionControlInformation" : { + "description" : "The Version Control information", + "$ref" : "#/definitions/VersionControlInformationDTO" + } + }, + "xml" : { + "name" : "versionControlComponentMappingEntity" + } + }, + "VersionControlInformationDTO" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The ID of the Process Group that is under version control" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the registry that the flow is stored in" + }, + "registryName" : { + "type" : "string", + "description" : "The name of the registry that the flow is stored in", + "readOnly" : true + }, + "bucketId" : { + "type" : "string", + "description" : "The ID of the bucket that the flow is stored in" + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket that the flow is stored in", + "readOnly" : true + }, + "flowId" : { + "type" : "string", + "description" : "The ID of the flow" + }, + "flowName" : { + "type" : "string", + "description" : "The name of the flow" + }, + "flowDescription" : { + "type" : "string", + "description" : "The description of the flow" + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of the flow" + }, + "storageLocation" : { + "type" : "string", + "description" : "The storage location" + }, + "state" : { + "type" : "string", + "description" : "The current state of the Process Group, as it relates to the Versioned Flow", + "readOnly" : true, + "enum" : [ "LOCALLY_MODIFIED", "STALE", "LOCALLY_MODIFIED_AND_STALE", "UP_TO_DATE", "SYNC_FAILURE" ] + }, + "stateExplanation" : { + "type" : "string", + "description" : "Explanation of why the group is in the specified state", + "readOnly" : true + } + } + }, + "VersionControlInformationEntity" : { + "type" : "object", + "properties" : { + "processGroupRevision" : { + "description" : "The Revision for the Process Group", + "$ref" : "#/definitions/RevisionDTO" + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + }, + "versionControlInformation" : { + "description" : "The Version Control information", + "$ref" : "#/definitions/VersionControlInformationDTO" + } + }, + "xml" : { + "name" : "versionControlInformationEntity" + } + }, + "VersionInfoDTO" : { + "type" : "object", + "properties" : { + "niFiVersion" : { + "type" : "string", + "description" : "The version of this NiFi." + }, + "javaVendor" : { + "type" : "string", + "description" : "Java JVM vendor" + }, + "javaVersion" : { + "type" : "string", + "description" : "Java version" + }, + "osName" : { + "type" : "string", + "description" : "Host operating system name" + }, + "osVersion" : { + "type" : "string", + "description" : "Host operating system version" + }, + "osArchitecture" : { + "type" : "string", + "description" : "Host operating system architecture" + }, + "buildTag" : { + "type" : "string", + "description" : "Build tag" + }, + "buildRevision" : { + "type" : "string", + "description" : "Build revision or commit hash" + }, + "buildBranch" : { + "type" : "string", + "description" : "Build branch" + }, + "buildTimestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Build timestamp" + } + } + }, + "VersionedConnection" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "source" : { + "description" : "The source of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "destination" : { + "description" : "The destination of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "zIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." + }, + "backPressureDataSizeThreshold" : { + "type" : "string", + "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." + }, + "flowFileExpiration" : { + "type" : "string", + "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string" + } + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/Position" + } + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", + "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] + }, + "partitioningAttribute" : { + "type" : "string", + "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", + "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedControllerService" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of the extension component" + }, + "bundle" : { + "description" : "Information about the bundle from which the component came", + "$ref" : "#/definitions/Bundle" + }, + "properties" : { + "type" : "object", + "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the component.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceAPI" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "scheduledState" : { + "type" : "string", + "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the controller service will report bulletins." + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedFlowCoordinates" : { + "type" : "object", + "properties" : { + "registryId" : { + "type" : "string", + "description" : "The identifier of the Flow Registry that contains the flow" + }, + "storageLocation" : { + "type" : "string", + "description" : "The location of the Flow Registry that stores the flow" + }, + "registryUrl" : { + "type" : "string", + "description" : "The URL of the Flow Registry that contains the flow" + }, + "bucketId" : { + "type" : "string", + "description" : "The UUID of the bucket that the flow resides in" + }, + "flowId" : { + "type" : "string", + "description" : "The UUID of the flow" + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of the flow" + }, + "latest" : { + "type" : "boolean", + "description" : "Whether or not these coordinates point to the latest version of the flow" + } + } + }, + "VersionedFlowDTO" : { + "type" : "object", + "properties" : { + "registryId" : { + "type" : "string", + "description" : "The ID of the registry that the flow is tracked to" + }, + "bucketId" : { + "type" : "string", + "description" : "The ID of the bucket where the flow is stored" + }, + "flowId" : { + "type" : "string", + "description" : "The ID of the flow" + }, + "flowName" : { + "type" : "string", + "description" : "The name of the flow" + }, + "description" : { + "type" : "string", + "description" : "A description of the flow" + }, + "comments" : { + "type" : "string", + "description" : "Comments for the changeset" + }, + "action" : { + "type" : "string", + "description" : "The action being performed", + "enum" : [ "COMMIT", "FORCE_COMMIT" ] + } + } + }, + "VersionedFlowEntity" : { + "type" : "object", + "properties" : { + "versionedFlow" : { + "description" : "The versioned flow", + "$ref" : "#/definitions/VersionedFlowDTO" + } + }, + "xml" : { + "name" : "versionedFlowEntity" + } + }, + "VersionedFlowSnapshotEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshot" : { + "description" : "The versioned flow snapshot", + "$ref" : "#/definitions/RegisteredFlowSnapshot" + }, + "processGroupRevision" : { + "description" : "The Revision of the Process Group under Version Control", + "$ref" : "#/definitions/RevisionDTO" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the Registry that this flow belongs to" + }, + "updateDescendantVersionedFlows" : { + "type" : "boolean", + "description" : "If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated." + }, + "disconnectedNodeAcknowledged" : { + "type" : "boolean", + "description" : "Acknowledges that this node is disconnected to allow for mutable requests to proceed." + } + }, + "xml" : { + "name" : "versionedFlowSnapshotEntity" + } + }, + "VersionedFlowSnapshotMetadataEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshotMetadata" : { + "description" : "The collection of registered flow snapshot metadata", + "$ref" : "#/definitions/RegisteredFlowSnapshotMetadata" + }, + "registryId" : { + "type" : "string", + "description" : "The ID of the Registry that this flow belongs to" + } + }, + "xml" : { + "name" : "versionedFlowSnapshotMetadataEntity" + } + }, + "VersionedFlowSnapshotMetadataSetEntity" : { + "type" : "object", + "properties" : { + "versionedFlowSnapshotMetadataSet" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadataEntity" + } + } + }, + "xml" : { + "name" : "versionedFlowSnapshotMetadataSetEntity" + } + }, + "VersionedFlowUpdateRequestDTO" : { + "type" : "object", + "properties" : { + "requestId" : { + "type" : "string", + "description" : "The unique ID of this request.", + "readOnly" : true + }, + "processGroupId" : { + "type" : "string", + "description" : "The unique ID of the Process Group being updated" + }, + "uri" : { + "type" : "string", + "description" : "The URI for future requests to this drop request.", + "readOnly" : true + }, + "lastUpdated" : { + "type" : "string", + "description" : "The last time this request was updated.", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Whether or not this request has completed", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "An explanation of why this request failed, or null if this request has not failed", + "readOnly" : true + }, + "percentCompleted" : { + "type" : "integer", + "format" : "int32", + "description" : "The percentage complete for the request, between 0 and 100", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the request", + "readOnly" : true + }, + "versionControlInformation" : { + "description" : "The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.", + "readOnly" : true, + "$ref" : "#/definitions/VersionControlInformationDTO" + } + } + }, + "VersionedFlowUpdateRequestEntity" : { + "type" : "object", + "properties" : { + "processGroupRevision" : { + "description" : "The revision for the Process Group being updated.", + "$ref" : "#/definitions/RevisionDTO" + }, + "request" : { + "description" : "The Flow Update Request", + "$ref" : "#/definitions/VersionedFlowUpdateRequestDTO" + } + }, + "xml" : { + "name" : "registeredFlowUpdateRequestEntity" + } + }, + "VersionedFlowsEntity" : { + "type" : "object", + "properties" : { + "versionedFlows" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFlowEntity" + } + } + }, + "xml" : { + "name" : "versionedFlowsEntity" + } + }, + "VersionedFunnel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedLabel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "zIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "style" : { + "type" : "object", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", + "additionalProperties" : { + "type" : "string" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedParameter" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the parameter" + }, + "description" : { + "type" : "string", + "description" : "The description of the param" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the parameter value is sensitive" + }, + "provided" : { + "type" : "boolean", + "description" : "Whether or not the parameter value is provided by a ParameterProvider" + }, + "value" : { + "type" : "string", + "description" : "The value of the parameter" + } + } + }, + "VersionedParameterContext" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "parameters" : { + "type" : "array", + "description" : "The parameters in the context", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedParameter" + } + }, + "inheritedParameterContexts" : { + "type" : "array", + "description" : "The names of additional parameter contexts from which to inherit parameters", + "items" : { + "type" : "string" + } + }, + "description" : { + "type" : "string", + "description" : "The description of the parameter context" + }, + "parameterProvider" : { + "type" : "string", + "description" : "The identifier of an optional parameter provider" + }, + "parameterGroupName" : { + "type" : "string", + "description" : "The corresponding parameter group name fetched from the parameter provider, if applicable" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "synchronized" : { + "type" : "boolean", + "description" : "True if the parameter provider is set and the context should receive updates when its parameters are next fetched" + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether or not this port allows remote access for site-to-site" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "processGroups" : { + "type" : "array", + "description" : "The child Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessGroup" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The Remote Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteProcessGroup" + } + }, + "processors" : { + "type" : "array", + "description" : "The Processors", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessor" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The Input Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The Output Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "connections" : { + "type" : "array", + "description" : "The Connections", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedConnection" + } + }, + "labels" : { + "type" : "array", + "description" : "The Labels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedLabel" + } + }, + "funnels" : { + "type" : "array", + "description" : "The Funnels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFunnel" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "The Controller Services", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedControllerService" + } + }, + "versionedFlowCoordinates" : { + "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", + "$ref" : "#/definitions/VersionedFlowCoordinates" + }, + "variables" : { + "type" : "object", + "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", + "additionalProperties" : { + "type" : "string" + } + }, + "parameterContextName" : { + "type" : "string", + "description" : "The name of the parameter context used by this process group" + }, + "defaultFlowFileExpiration" : { + "type" : "string", + "description" : "The default FlowFile Expiration for this Process Group." + }, + "defaultBackPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied." + }, + "defaultBackPressureDataSizeThreshold" : { + "type" : "string", + "description" : "Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied." + }, + "logFileSuffix" : { + "type" : "string", + "description" : "The log file suffix for this Process Group for dedicated logging." + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "flowFileOutboundPolicy" : { + "type" : "string", + "description" : "The FlowFile Outbound Policy for the Process Group" + }, + "flowFileConcurrency" : { + "type" : "string", + "description" : "The configured FlowFile Concurrency for the Process Group" + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessor" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of the extension component" + }, + "bundle" : { + "description" : "Information about the bundle from which the component came", + "$ref" : "#/definitions/Bundle" + }, + "properties" : { + "type" : "object", + "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the component.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "style" : { + "type" : "object", + "description" : "Stylistic data for rendering in a UI", + "additionalProperties" : { + "type" : "string" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "Indicates whether the processor should be scheduled to run in event or timer driven mode." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amout of time that is used when the process penalizes a flowfile." + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." + }, + "autoTerminatedRelationships" : { + "type" : "array", + "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "retryCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Overall number of retries." + }, + "retriedRelationships" : { + "type" : "array", + "description" : "All the relationships should be retried.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backoffMechanism" : { + "type" : "string", + "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", + "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] + }, + "maxBackoffPeriod" : { + "type" : "string", + "description" : "Maximum amount of time to be waited during a retry period." + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedPropertyDescriptor" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the property" + }, + "identifiesControllerService" : { + "type" : "boolean", + "description" : "Whether or not the property provides the identifier of a Controller Service" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the property is considered sensitive" + }, + "resourceDefinition" : { + "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", + "$ref" : "#/definitions/VersionedResourceDefinition" + } + } + }, + "VersionedRemoteGroupPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "remoteGroupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of task that may transmit flowfiles to the target port concurrently." + }, + "useCompression" : { + "type" : "boolean", + "description" : "Whether the flowfiles are compressed when sent to the target port." + }, + "batchSize" : { + "description" : "The batch settings for data transmission.", + "$ref" : "#/definitions/BatchSize" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "targetId" : { + "type" : "string", + "description" : "The ID of the port on the target NiFi instance" + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedRemoteProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "targetUri" : { + "type" : "string", + "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." + }, + "targetUris" : { + "type" : "string", + "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." + }, + "communicationsTimeout" : { + "type" : "string", + "description" : "The time period used for the timeout when communicating with the target." + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + }, + "transportProtocol" : { + "type" : "string", + "description" : "The Transport Protocol that is used for Site-to-Site communications", + "enum" : [ "RAW", "HTTP" ] + }, + "localNetworkInterface" : { + "type" : "string", + "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "proxyPassword" : { + "type" : "string" + }, + "inputPorts" : { + "type" : "array", + "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedReportingTask" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of the extension component" + }, + "bundle" : { + "description" : "Information about the bundle from which the component came", + "$ref" : "#/definitions/Bundle" + }, + "properties" : { + "type" : "object", + "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the component.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation for the reporting task. This is how the custom UI relays configuration to the reporting task." + }, + "scheduledState" : { + "type" : "string", + "description" : "Indicates the scheduled state for the Reporting Task", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the reporting task. The format of the value will depend on the value of schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "Indicates scheduling strategy that should dictate how the reporting task is triggered." + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedReportingTaskSnapshot" : { + "type" : "object", + "properties" : { + "reportingTasks" : { + "type" : "array", + "description" : "The reporting tasks", + "items" : { + "$ref" : "#/definitions/VersionedReportingTask" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "The controller services", + "items" : { + "$ref" : "#/definitions/VersionedControllerService" + } + } + } + }, + "VersionedResourceDefinition" : { + "type" : "object", + "properties" : { + "cardinality" : { + "type" : "string", + "description" : "The cardinality of the resource", + "enum" : [ "SINGLE", "MULTIPLE" ] + }, + "resourceTypes" : { + "type" : "array", + "description" : "The types of resource that the Property Descriptor is allowed to reference", + "uniqueItems" : true, + "items" : { + "type" : "string", + "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] + } + } + } + } + } +} \ No newline at end of file diff --git a/resources/client_gen/api_defs/registry-1.27.0.json b/resources/client_gen/api_defs/registry-1.27.0.json new file mode 100644 index 00000000..2a1b9a03 --- /dev/null +++ b/resources/client_gen/api_defs/registry-1.27.0.json @@ -0,0 +1,7129 @@ +{ + "swagger" : "2.0", + "info" : { + "description" : "The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.", + "version" : "1.27.0", + "title" : "Apache NiFi Registry REST API", + "termsOfService" : "As described in the license", + "contact" : { + "name" : "Apache NiFi Registry", + "url" : "https://nifi.apache.org", + "email" : "dev@nifi.apache.org" + }, + "license" : { + "name" : "Apache 2.0 License", + "url" : "https://www.apache.org/licenses/LICENSE-2.0.html" + } + }, + "basePath" : "/nifi-registry-api", + "tags" : [ { + "name" : "about", + "description" : "Retrieves the version information for this NiFi Registry." + }, { + "name" : "access", + "description" : "Endpoints for obtaining an access token or checking access status." + }, { + "name" : "bucket bundles", + "description" : "Create extension bundles scoped to an existing bucket in the registry. " + }, { + "name" : "bucket flows", + "description" : "Create flows scoped to an existing bucket in the registry." + }, { + "name" : "buckets", + "description" : "Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets." + }, { + "name" : "bundles", + "description" : "Gets metadata about extension bundles and their versions. " + }, { + "name" : "config", + "description" : "Retrieves the configuration for this NiFi Registry." + }, { + "name" : "extension repository", + "description" : "Interact with extension bundles via the hierarchy of bucket/group/artifact/version. " + }, { + "name" : "extensions", + "description" : "Find and retrieve extensions. " + }, { + "name" : "flows", + "description" : "Gets metadata about flows." + }, { + "name" : "items", + "description" : "Retrieve items across all buckets for which the user is authorized." + }, { + "name" : "policies", + "description" : "Endpoint for managing access policies." + }, { + "name" : "tenants", + "description" : "Endpoint for managing users and user groups." + } ], + "schemes" : [ "http", "https" ], + "paths" : { + "/about" : { + "get" : { + "tags" : [ "about" ], + "summary" : "Get version", + "description" : "Gets the NiFi Registry version.", + "operationId" : "getVersion", + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryAbout" + } + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/access" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Get access status", + "description" : "Returns the current client's authenticated identity and permissions to top-level resources", + "operationId" : "getAccessStatus", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/CurrentUser" + } + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/access/logout" : { + "delete" : { + "tags" : [ "access" ], + "summary" : "Performs a logout for other providers that have been issued a JWT.", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "logout", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "200" : { + "description" : "User was logged out successfully." + }, + "401" : { + "description" : "Authentication token provided was empty or not in the correct JWT format." + }, + "500" : { + "description" : "Client failed to log out." + } + } + } + }, + "/access/logout/complete" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Completes the logout sequence.", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "logoutComplete", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "200" : { + "description" : "User was logged out successfully." + }, + "401" : { + "description" : "Authentication token provided was empty or not in the correct JWT format." + }, + "500" : { + "description" : "Client failed to log out." + } + } + } + }, + "/access/oidc/callback" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Redirect/callback URI for processing the result of the OpenId Connect login sequence.", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "oidcCallback", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/oidc/exchange" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "oidcExchange", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + } + } + } + }, + "/access/oidc/logout" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Performs a logout in the OpenId Provider.", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "oidcLogout", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/oidc/logout/callback" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Redirect/callback URI for processing the result of the OpenId Connect logout sequence.", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "oidcLogoutCallback", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/oidc/request" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Initiates a request to authenticate through the configured OpenId Connect provider.", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "oidcRequest", + "consumes" : [ "*/*" ], + "produces" : [ "*/*" ], + "responses" : { + "default" : { + "description" : "successful operation" + } + } + } + }, + "/access/token" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Create token trying all providers", + "description" : "Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", + "operationId" : "createAccessTokenByTryingAllProviders", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + } + } + }, + "/access/token/identity-provider" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Create token using identity provider", + "description" : "Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", + "operationId" : "createAccessTokenUsingIdentityProviderCredentials", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + } + } + }, + "/access/token/identity-provider/test" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Test identity provider", + "description" : "Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.", + "operationId" : "testIdentityProviderRecognizesCredentialsFormat", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "The format of the credentials were not recognized by the currently configured identity provider." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + } + } + }, + "/access/token/identity-provider/usage" : { + "get" : { + "tags" : [ "access" ], + "summary" : "Get identity provider usage", + "description" : "Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider", + "operationId" : "getIdentityProviderUsageInstructions", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + } + } + }, + "/access/token/kerberos" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Create token using kerberos", + "description" : "Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", + "operationId" : "createAccessTokenUsingKerberosTicket", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + } + } + }, + "/access/token/login" : { + "post" : { + "tags" : [ "access" ], + "summary" : "Create token using basic auth", + "description" : "Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.", + "operationId" : "createAccessTokenUsingBasicAuthCredentials", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password." + }, + "500" : { + "description" : "NiFi Registry was unable to complete the request because an unexpected error occurred." + } + }, + "security" : [ { + "BasicAuth" : [ ] + } ] + } + }, + "/buckets" : { + "get" : { + "tags" : [ "buckets" ], + "summary" : "Get all buckets", + "description" : "The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list.", + "operationId" : "getBuckets", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Bucket" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + }, + "post" : { + "tags" : [ "buckets" ], + "summary" : "Create bucket", + "description" : "", + "operationId" : "createBucket", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The bucket to create", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Bucket" + } + }, { + "name" : "preserveSourceProperties", + "in" : "query", + "description" : "Whether source properties like identifier should be kept", + "required" : false, + "type" : "boolean" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Bucket" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets", + "action" : "write" + } + } + }, + "/buckets/fields" : { + "get" : { + "tags" : [ "buckets" ], + "summary" : "Get bucket fields", + "description" : "Retrieves bucket field names for searching or sorting on buckets.", + "operationId" : "getAvailableBucketFields", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Fields" + } + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/buckets/{bucketId}" : { + "get" : { + "tags" : [ "buckets" ], + "summary" : "Get bucket", + "description" : "Gets the bucket with the given id.", + "operationId" : "getBucket", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Bucket" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "put" : { + "tags" : [ "buckets" ], + "summary" : "Update bucket", + "description" : "Updates the bucket with the given id.", + "operationId" : "updateBucket", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated bucket", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Bucket" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Bucket" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + }, + "delete" : { + "tags" : [ "buckets" ], + "summary" : "Delete bucket", + "description" : "Deletes the bucket with the given id, along with all objects stored in the bucket", + "operationId" : "deleteBucket", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the entity.", + "required" : true, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Bucket" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "delete" + } + } + }, + "/buckets/{bucketId}/bundles" : { + "get" : { + "tags" : [ "bucket bundles" ], + "summary" : "Get extension bundles by bucket", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionBundles", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionBundle" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/buckets/{bucketId}/bundles/{bundleType}" : { + "post" : { + "tags" : [ "bucket bundles" ], + "summary" : "Create extension bundle version", + "description" : "Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "createExtensionBundleVersion", + "consumes" : [ "multipart/form-data" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "bundleType", + "in" : "path", + "description" : "The type of the bundle", + "required" : true, + "type" : "string", + "enum" : [ "nifi-nar", "minifi-cpp" ] + }, { + "name" : "file", + "in" : "formData", + "description" : "The binary content of the bundle file being uploaded.", + "required" : true, + "type" : "file" + }, { + "name" : "sha256", + "in" : "formData", + "description" : "Optional sha256 of the provided bundle", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BundleVersion" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/buckets/{bucketId}/flows" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get bucket flows", + "description" : "Retrieves all flows in the given bucket.", + "operationId" : "getFlows", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/VersionedFlow" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "post" : { + "tags" : [ "bucket flows" ], + "summary" : "Create flow", + "description" : "Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.", + "operationId" : "createFlow", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The details of the flow to create.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get bucket flow", + "description" : "Retrieves the flow with the given id in the given bucket.", + "operationId" : "getFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "put" : { + "tags" : [ "bucket flows" ], + "summary" : "Update bucket flow", + "description" : "Updates the flow with the given id in the given bucket.", + "operationId" : "updateFlow", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The updated flow", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + }, + "delete" : { + "tags" : [ "bucket flows" ], + "summary" : "Delete bucket flow", + "description" : "Deletes a flow, including all saved versions of that flow.", + "operationId" : "deleteFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the entity.", + "required" : true, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "delete" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get bucket flow diff", + "description" : "Computes the differences between two given versions of a flow.", + "operationId" : "getFlowDiff", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "name" : "versionA", + "in" : "path", + "description" : "The first version number", + "required" : true, + "type" : "integer", + "pattern" : "\\d+", + "format" : "int32" + }, { + "name" : "versionB", + "in" : "path", + "description" : "The second version number", + "required" : true, + "type" : "integer", + "pattern" : "\\d+", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowDifference" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get bucket flow versions", + "description" : "Gets summary information for all versions of a flow. Versions are ordered newest->oldest.", + "operationId" : "getFlowVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "post" : { + "tags" : [ "bucket flows" ], + "summary" : "Create flow version", + "description" : "Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.", + "operationId" : "createFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The new versioned flow snapshot.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, { + "name" : "preserveSourceProperties", + "in" : "query", + "description" : "Whether source properties like author should be kept", + "required" : false, + "type" : "boolean" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/import" : { + "post" : { + "tags" : [ "bucket flows" ], + "summary" : "Import flow version", + "description" : "Import the next version of a flow. The version number of the object being created will be the next available version integer. Flow versions are immutable after they are created.", + "operationId" : "importVersionedFlow", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "file", + "required" : false, + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, { + "name" : "Comments", + "in" : "header", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "201" : { + "description" : "The resource has been successfully created." + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/latest" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get latest bucket flow version content", + "description" : "Gets the latest version of a flow, including the metadata and content of the flow.", + "operationId" : "getLatestFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/latest/metadata" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get latest bucket flow version metadata", + "description" : "Gets the metadata for the latest version of a flow.", + "operationId" : "getLatestFlowVersionMetadata", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Get bucket flow version", + "description" : "Gets the given version of a flow, including the metadata and content for the version.", + "operationId" : "getFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "name" : "versionNumber", + "in" : "path", + "description" : "The version number", + "required" : true, + "type" : "integer", + "pattern" : "\\d+", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}/export" : { + "get" : { + "tags" : [ "bucket flows" ], + "summary" : "Exports specified bucket flow version content", + "description" : "Exports the specified version of a flow, including the metadata and content of the flow.", + "operationId" : "exportVersionedFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + }, { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "name" : "versionNumber", + "in" : "path", + "description" : "The version number", + "required" : true, + "type" : "integer", + "pattern" : "\\d+", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get all bundles", + "description" : "Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getBundles", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "query", + "description" : "Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'.", + "required" : false, + "type" : "string" + }, { + "name" : "groupId", + "in" : "query", + "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'.", + "required" : false, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "query", + "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionBundle" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/bundles/versions" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get all bundle versions", + "description" : "Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getBundleVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "groupId", + "in" : "query", + "description" : "Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'.", + "required" : false, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "query", + "description" : "Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'.", + "required" : false, + "type" : "string" + }, { + "name" : "version", + "in" : "query", + "description" : "Optional version to filter results. The value maye be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.", + "required" : false, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/BundleVersionMetadata" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/bundles/{bundleId}" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle", + "description" : "Gets the metadata about an extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetExtensionBundle", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ExtensionBundle" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "delete" : { + "tags" : [ "bundles" ], + "summary" : "Delete bundle", + "description" : "Deletes the given extension bundle and all of it's versions. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalDeleteExtensionBundle", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ExtensionBundle" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/bundles/{bundleId}/versions" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle versions", + "description" : "Gets the metadata for the versions of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetBundleVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/BundleVersionMetadata" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles/{bundleId}/versions/{version}" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version", + "description" : "Gets the descriptor for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetBundleVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BundleVersion" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + }, + "delete" : { + "tags" : [ "bundles" ], + "summary" : "Delete bundle version", + "description" : "Deletes the given extension bundle version and it's associated binary content. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalDeleteBundleVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/BundleVersion" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "write" + } + } + }, + "/bundles/{bundleId}/versions/{version}/content" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version content", + "description" : "Gets the binary content for the given version of the given extension bundle. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetBundleVersionContent", + "consumes" : [ "*/*" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version extensions", + "description" : "Gets the metadata about the extensions in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetBundleVersionExtensions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionMetadata" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions/{name}" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version extension", + "description" : "Gets the metadata about the extension with the given name in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "globalGetBundleVersionExtension", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Extension" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version extension docs", + "description" : "Gets the documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getBundleVersionExtensionDocs", + "consumes" : [ "*/*" ], + "produces" : [ "text/html" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details" : { + "get" : { + "tags" : [ "bundles" ], + "summary" : "Get bundle version extension docs details", + "description" : "Gets the additional details documentation for the given extension in the given extension bundle version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getBundleVersionExtensionAdditionalDetailsDocs", + "consumes" : [ "*/*" ], + "produces" : [ "text/html" ], + "parameters" : [ { + "name" : "bundleId", + "in" : "path", + "description" : "The extension bundle identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version of the bundle", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/config" : { + "get" : { + "tags" : [ "config" ], + "summary" : "Get configration", + "description" : "Gets the NiFi Registry configurations.", + "operationId" : "getConfiguration", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/RegistryConfiguration" + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies,/tenants", + "action" : "read" + } + } + }, + "/extension-repository" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo buckets", + "description" : "Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoBuckets", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionRepoBucket" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/extension-repository/{bucketName}" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo groups", + "description" : "Gets the groups in the extension repository in the given bucket. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionRepoGroup" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo artifacts", + "description" : "Gets the artifacts in the extension repository in the given bucket and group. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoArtifacts", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group id", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionRepoArtifact" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo versions", + "description" : "Gets the versions in the extension repository for the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionRepoVersionSummary" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo version", + "description" : "Gets information about the version in the given bucket, group, and artifact. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ExtensionRepoVersion" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo version content", + "description" : "Gets the binary content of the bundle with the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionContent", + "consumes" : [ "*/*" ], + "produces" : [ "application/octet-stream" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "format" : "byte" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo extensions", + "description" : "Gets information about the extensions in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionExtensions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ExtensionMetadata" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo extension", + "description" : "Gets information about the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionExtension", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Extension" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo extension docs", + "description" : "Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionExtensionDocs", + "consumes" : [ "*/*" ], + "produces" : [ "text/html" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo extension details", + "description" : "Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionExtensionAdditionalDetailsDocs", + "consumes" : [ "*/*" ], + "produces" : [ "text/html" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + }, { + "name" : "name", + "in" : "path", + "description" : "The fully qualified name of the extension", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get extension repo version checksum", + "description" : "Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionRepoVersionSha256", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "bucketName", + "in" : "path", + "description" : "The bucket name", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/extension-repository/{groupId}/{artifactId}/{version}/sha256" : { + "get" : { + "tags" : [ "extension repository" ], + "summary" : "Get global extension repo version checksum", + "description" : "Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets. \n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getGlobalExtensionRepoVersionSha256", + "consumes" : [ "*/*" ], + "produces" : [ "text/plain" ], + "parameters" : [ { + "name" : "groupId", + "in" : "path", + "description" : "The group identifier", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "path", + "description" : "The artifact identifier", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "The version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "string" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/extensions" : { + "get" : { + "tags" : [ "extensions" ], + "summary" : "Get all extensions", + "description" : "Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bundleType", + "in" : "query", + "description" : "The type of bundles to return", + "required" : false, + "type" : "string", + "enum" : [ "nifi-nar", "minifi-cpp" ] + }, { + "name" : "extensionType", + "in" : "query", + "description" : "The type of extensions to return", + "required" : false, + "type" : "string", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] + }, { + "name" : "tag", + "in" : "query", + "description" : "The tags to filter on, will be used in an OR statement", + "required" : false, + "type" : "array", + "items" : { + "type" : "string" + }, + "collectionFormat" : "multi" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ExtensionMetadataContainer" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/extensions/provided-service-api" : { + "get" : { + "tags" : [ "extensions" ], + "summary" : "Get extensions providing service API", + "description" : "Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getExtensionsProvidingServiceAPI", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "className", + "in" : "query", + "description" : "The name of the service API class", + "required" : true, + "type" : "string" + }, { + "name" : "groupId", + "in" : "query", + "description" : "The groupId of the bundle containing the service API class", + "required" : true, + "type" : "string" + }, { + "name" : "artifactId", + "in" : "query", + "description" : "The artifactId of the bundle containing the service API class", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "query", + "description" : "The version of the bundle containing the service API class", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ExtensionMetadataContainer" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/extensions/tags" : { + "get" : { + "tags" : [ "extensions" ], + "summary" : "Get extension tags", + "description" : "Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag.\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getTags", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/TagCount" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/flows/fields" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get flow fields", + "description" : "Retrieves the flow field names that can be used for searching or sorting on flows.", + "operationId" : "getAvailableFlowFields", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Fields" + } + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/flows/{flowId}" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get flow", + "description" : "Gets a flow by id.", + "operationId" : "globalGetFlow", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlow" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/flows/{flowId}/versions" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get flow versions", + "description" : "Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.", + "operationId" : "globalGetFlowVersions", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/flows/{flowId}/versions/latest" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get latest flow version", + "description" : "Gets the latest version of a flow, including metadata and flow content.", + "operationId" : "globalGetLatestFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/flows/{flowId}/versions/latest/metadata" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get latest flow version metadata", + "description" : "Gets the metadata for the latest version of a flow.", + "operationId" : "globalGetLatestFlowVersionMetadata", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/flows/{flowId}/versions/{versionNumber}" : { + "get" : { + "tags" : [ "flows" ], + "summary" : "Get flow version", + "description" : "Gets the given version of a flow, including metadata and flow content.", + "operationId" : "globalGetFlowVersion", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "flowId", + "in" : "path", + "description" : "The flow identifier", + "required" : true, + "type" : "string" + }, { + "name" : "versionNumber", + "in" : "path", + "description" : "The version number", + "required" : true, + "type" : "integer", + "pattern" : "\\d+", + "format" : "int32" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/VersionedFlowSnapshot" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/items" : { + "get" : { + "tags" : [ "items" ], + "summary" : "Get all items", + "description" : "Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.", + "operationId" : "getItems", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/BucketItem" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/items/fields" : { + "get" : { + "tags" : [ "items" ], + "summary" : "Get item fields", + "description" : "Retrieves the item field names for searching or sorting on bucket items.", + "operationId" : "getAvailableBucketItemFields", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Fields" + } + } + }, + "security" : [ { + "Authorization" : [ ] + } ] + } + }, + "/items/{bucketId}" : { + "get" : { + "tags" : [ "items" ], + "summary" : "Get bucket items", + "description" : "Gets the items located in the given bucket.", + "operationId" : "getItemsInBucket", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "bucketId", + "in" : "path", + "description" : "The bucket identifier", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/BucketItem" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/buckets/{bucketId}", + "action" : "read" + } + } + }, + "/policies" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Get all access policies", + "description" : "", + "operationId" : "getAccessPolicies", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/AccessPolicy" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "read" + } + }, + "post" : { + "tags" : [ "policies" ], + "summary" : "Create access policy", + "description" : "", + "operationId" : "createAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "write" + } + } + }, + "/policies/resources" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Get available resources", + "description" : "Gets the available resources that support access/authorization policies", + "operationId" : "getResources", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Resource" + } + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "read" + } + } + }, + "/policies/{action}/{resource}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Get access policy for resource", + "description" : "Gets an access policy for the specified action and resource", + "operationId" : "getAccessPolicyForResource", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "action", + "in" : "path", + "description" : "The request action.", + "required" : true, + "type" : "string", + "enum" : [ "read", "write", "delete" ] + }, { + "name" : "resource", + "in" : "path", + "description" : "The resource of the policy.", + "required" : true, + "type" : "string", + "pattern" : ".+" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "read" + } + } + }, + "/policies/{id}" : { + "get" : { + "tags" : [ "policies" ], + "summary" : "Get access policy", + "description" : "", + "operationId" : "getAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "read" + } + }, + "put" : { + "tags" : [ "policies" ], + "summary" : "Update access policy", + "description" : "", + "operationId" : "updateAccessPolicy", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The access policy configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "write" + } + }, + "delete" : { + "tags" : [ "policies" ], + "summary" : "Delete access policy", + "description" : "", + "operationId" : "removeAccessPolicy", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the entity.", + "required" : true, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The access policy id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/AccessPolicy" + } + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/policies", + "action" : "delete" + } + } + }, + "/tenants/user-groups" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Get user groups", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUserGroups", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/UserGroup" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "read" + } + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Create user group", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "createUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "write" + } + } + }, + "/tenants/user-groups/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Get user group", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "read" + } + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Update user group", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "updateUserGroup", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user group configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "write" + } + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Delete user group", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "removeUserGroup", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the entity.", + "required" : true, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The user group id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/UserGroup" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "delete" + } + } + }, + "/tenants/users" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Get all users", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUsers", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/User" + } + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "read" + } + }, + "post" : { + "tags" : [ "tenants" ], + "summary" : "Create user", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "createUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/User" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/User" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "write" + } + } + }, + "/tenants/users/{id}" : { + "get" : { + "tags" : [ "tenants" ], + "summary" : "Get user", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "getUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/User" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "read" + } + }, + "put" : { + "tags" : [ "tenants" ], + "summary" : "Update user", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "updateUser", + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + }, { + "in" : "body", + "name" : "body", + "description" : "The user configuration details.", + "required" : true, + "schema" : { + "$ref" : "#/definitions/User" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/User" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "write" + } + }, + "delete" : { + "tags" : [ "tenants" ], + "summary" : "Delete user", + "description" : "\n\nNOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.", + "operationId" : "removeUser", + "consumes" : [ "*/*" ], + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "version", + "in" : "query", + "description" : "The version is used to verify the client is working with the latest version of the entity.", + "required" : true, + "type" : "string" + }, { + "name" : "clientId", + "in" : "query", + "description" : "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", + "required" : false, + "type" : "string" + }, { + "name" : "id", + "in" : "path", + "description" : "The user id.", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/User" + } + }, + "400" : { + "description" : "NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification." + }, + "401" : { + "description" : "Client could not be authenticated." + }, + "403" : { + "description" : "Client is not authorized to make this request." + }, + "404" : { + "description" : "The specified resource could not be found." + }, + "409" : { + "description" : "NiFi Registry was unable to complete the request because it assumes a server state that is not valid." + } + }, + "security" : [ { + "Authorization" : [ ] + } ], + "x-access-policy" : { + "resource" : "/tenants", + "action" : "delete" + } + } + } + }, + "securityDefinitions" : { + "Authorization" : { + "description" : "NiFi Registry Auth Token (JWT)", + "type" : "apiKey", + "name" : "Authorization", + "in" : "header" + }, + "BasicAuth" : { + "description" : "HTTP Basic Auth", + "type" : "basic" + } + }, + "definitions" : { + "AccessPolicy" : { + "type" : "object", + "required" : [ "action", "resource" ], + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The id of the policy. Set by server at creation time.", + "readOnly" : true + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write", "delete" ] + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", + "readOnly" : true + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + }, + "users" : { + "type" : "array", + "description" : "The set of user IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/Tenant" + } + }, + "userGroups" : { + "type" : "array", + "description" : "The set of user group IDs associated with this access policy.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/Tenant" + } + } + } + }, + "AccessPolicySummary" : { + "type" : "object", + "required" : [ "action", "resource" ], + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The id of the policy. Set by server at creation time.", + "readOnly" : true + }, + "resource" : { + "type" : "string", + "description" : "The resource for this access policy." + }, + "action" : { + "type" : "string", + "description" : "The action associated with this access policy.", + "enum" : [ "read", "write", "delete" ] + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.", + "readOnly" : true + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + } + } + }, + "AllowableValue" : { + "type" : "object", + "properties" : { + "value" : { + "type" : "string", + "description" : "The value of the allowable value" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the allowable value" + }, + "description" : { + "type" : "string", + "description" : "The description of the allowable value" + } + } + }, + "Attribute" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the attribute" + }, + "description" : { + "type" : "string", + "description" : "The description of the attribute" + } + } + }, + "BatchSize" : { + "type" : "object", + "properties" : { + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Preferred number of flow files to include in a transaction." + }, + "size" : { + "type" : "string", + "description" : "Preferred number of bytes to include in a transaction." + }, + "duration" : { + "type" : "string", + "description" : "Preferred amount of time that a transaction should span." + } + } + }, + "Bucket" : { + "type" : "object", + "required" : [ "name" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the bucket." + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the bucket was first created. This is set by the server at creation time.", + "readOnly" : true, + "minimum" : 1 + }, + "description" : { + "type" : "string", + "description" : "A description of the bucket." + }, + "allowBundleRedeploy" : { + "type" : "boolean", + "description" : "Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false." + }, + "allowPublicRead" : { + "type" : "boolean", + "description" : "Indicates if this bucket allows read access to unauthenticated anonymous users" + }, + "permissions" : { + "description" : "The access that the current user has to this bucket.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + } + } + }, + "BucketItem" : { + "type" : "object", + "required" : [ "bucketIdentifier", "name", "type" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the item." + }, + "description" : { + "type" : "string", + "description" : "A description of the item." + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket this items belongs to.", + "readOnly" : true + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was created, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "modifiedTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "type" : { + "type" : "string", + "description" : "The type of item.", + "enum" : [ "Flow", "Bundle" ] + }, + "permissions" : { + "description" : "The access that the current user has to the bucket containing this item.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + } + } + }, + "BuildInfo" : { + "type" : "object", + "properties" : { + "buildTool" : { + "type" : "string", + "description" : "The tool used to build the version of the bundle" + }, + "buildFlags" : { + "type" : "string", + "description" : "The flags used to build the version of the bundle" + }, + "buildBranch" : { + "type" : "string", + "description" : "The branch used to build the version of the bundle" + }, + "buildTag" : { + "type" : "string", + "description" : "The tag used to build the version of the bundle" + }, + "buildRevision" : { + "type" : "string", + "description" : "The revision used to build the version of the bundle" + }, + "built" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp the version of the bundle was built" + }, + "builtBy" : { + "type" : "string", + "description" : "The identity of the user that performed the build" + } + } + }, + "Bundle" : { + "type" : "object", + "properties" : { + "group" : { + "type" : "string", + "description" : "The group of the bundle" + }, + "artifact" : { + "type" : "string", + "description" : "The artifact of the bundle" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle" + } + } + }, + "BundleInfo" : { + "type" : "object", + "properties" : { + "bucketId" : { + "type" : "string", + "description" : "The id of the bucket where the bundle is located" + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket where the bundle is located" + }, + "bundleId" : { + "type" : "string", + "description" : "The id of the bundle" + }, + "bundleType" : { + "type" : "string", + "description" : "The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)", + "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the bundle" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the bundle" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle" + }, + "systemApiVersion" : { + "type" : "string", + "description" : "The version of the system API the bundle was built against" + } + } + }, + "BundleVersion" : { + "type" : "object", + "required" : [ "versionMetadata" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "versionMetadata" : { + "description" : "The metadata about this version of the extension bundle", + "$ref" : "#/definitions/BundleVersionMetadata" + }, + "dependencies" : { + "type" : "array", + "description" : "The set of other bundle versions that this version is dependent on", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/BundleVersionDependency" + } + }, + "bundle" : { + "description" : "The bundle this version is for", + "readOnly" : true, + "$ref" : "#/definitions/ExtensionBundle" + }, + "bucket" : { + "description" : "The bucket that the extension bundle belongs to", + "$ref" : "#/definitions/Bucket" + }, + "filename" : { + "type" : "string" + } + } + }, + "BundleVersionDependency" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "The group id of the bundle dependency" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the bundle dependency" + }, + "version" : { + "type" : "string", + "description" : "The version of the bundle dependency" + } + } + }, + "BundleVersionMetadata" : { + "type" : "object", + "required" : [ "bucketId", "buildInfo", "contentSize", "sha256Supplied" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "id" : { + "type" : "string", + "description" : "The id of this version of the extension bundle" + }, + "bundleId" : { + "type" : "string", + "description" : "The id of the extension bundle this version is for" + }, + "bucketId" : { + "type" : "string", + "description" : "The id of the bucket the extension bundle belongs to" + }, + "groupId" : { + "type" : "string" + }, + "artifactId" : { + "type" : "string" + }, + "version" : { + "type" : "string", + "description" : "The version of the extension bundle" + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of the create date of this version", + "minimum" : 1 + }, + "author" : { + "type" : "string", + "description" : "The identity that created this version" + }, + "description" : { + "type" : "string", + "description" : "The description for this version" + }, + "sha256" : { + "type" : "string", + "description" : "The hex representation of the SHA-256 digest of the binary content for this version" + }, + "sha256Supplied" : { + "type" : "boolean", + "description" : "Whether or not the client supplied a SHA-256 when uploading the bundle" + }, + "contentSize" : { + "type" : "integer", + "format" : "int64", + "description" : "The size of the binary content for this version in bytes", + "minimum" : 0 + }, + "systemApiVersion" : { + "type" : "string", + "description" : "The version of the system API that this bundle version was built against" + }, + "buildInfo" : { + "description" : "The build information about this version", + "$ref" : "#/definitions/BuildInfo" + } + } + }, + "ComponentDifference" : { + "type" : "object", + "properties" : { + "valueA" : { + "type" : "string", + "description" : "The earlier value from the difference." + }, + "valueB" : { + "type" : "string", + "description" : "The newer value from the difference." + }, + "changeDescription" : { + "type" : "string", + "description" : "The description of the change." + }, + "differenceType" : { + "type" : "string", + "description" : "The key to the difference." + }, + "differenceTypeDescription" : { + "type" : "string", + "description" : "The description of the change type." + } + } + }, + "ComponentDifferenceGroup" : { + "type" : "object", + "properties" : { + "componentId" : { + "type" : "string", + "description" : "The id of the component whose changes are grouped together." + }, + "componentName" : { + "type" : "string", + "description" : "The name of the component whose changes are grouped together." + }, + "componentType" : { + "type" : "string", + "description" : "The type of component these changes relate to." + }, + "processGroupId" : { + "type" : "string", + "description" : "The process group id for this component." + }, + "differences" : { + "type" : "array", + "description" : "The list of changes related to this component between the 2 versions.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentDifference" + } + } + } + }, + "ConnectableComponent" : { + "type" : "object", + "required" : [ "groupId", "id", "type" ], + "properties" : { + "id" : { + "type" : "string", + "description" : "The id of the connectable component." + }, + "type" : { + "type" : "string", + "description" : "The type of component the connectable is.", + "enum" : [ "PROCESSOR", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "INPUT_PORT", "OUTPUT_PORT", "FUNNEL" ] + }, + "groupId" : { + "type" : "string", + "description" : "The id of the group that the connectable component resides in" + }, + "name" : { + "type" : "string", + "description" : "The name of the connectable component" + }, + "comments" : { + "type" : "string", + "description" : "The comments for the connectable component." + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + } + } + }, + "ControllerServiceAPI" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "The fully qualified name of the service interface." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this service interface.", + "$ref" : "#/definitions/Bundle" + } + } + }, + "ControllerServiceDefinition" : { + "type" : "object", + "properties" : { + "className" : { + "type" : "string", + "description" : "The class name of the service API" + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the service API" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the service API" + }, + "version" : { + "type" : "string", + "description" : "The version of the service API" + } + } + }, + "CurrentUser" : { + "type" : "object", + "properties" : { + "identity" : { + "type" : "string", + "description" : "The identity of the current user", + "readOnly" : true + }, + "anonymous" : { + "type" : "boolean", + "description" : "Indicates if the current user is anonymous", + "readOnly" : true + }, + "loginSupported" : { + "type" : "boolean", + "description" : "Indicates if the NiFi Registry instance supports logging in" + }, + "resourcePermissions" : { + "description" : "The access that the current user has to top level resources", + "readOnly" : true, + "$ref" : "#/definitions/ResourcePermissions" + }, + "oidcloginSupported" : { + "type" : "boolean", + "description" : "Indicates if the NiFi Registry instance supports logging in with an OIDC provider" + } + } + }, + "DefaultSchedule" : { + "type" : "object", + "properties" : { + "strategy" : { + "type" : "string", + "description" : "The default scheduling strategy" + }, + "period" : { + "type" : "string", + "description" : "The default scheduling period" + }, + "concurrentTasks" : { + "type" : "string", + "description" : "The default concurrent tasks" + } + } + }, + "DefaultSettings" : { + "type" : "object", + "properties" : { + "yieldDuration" : { + "type" : "string", + "description" : "The default yield duration" + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The default penalty duration" + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The default bulletin level" + } + } + }, + "Dependency" : { + "type" : "object", + "properties" : { + "propertyName" : { + "type" : "string", + "description" : "The name of the dependent property" + }, + "propertyDisplayName" : { + "type" : "string", + "description" : "The display name of the dependent property" + }, + "dependentValues" : { + "description" : "The values of the dependent property that enable the depending property", + "$ref" : "#/definitions/DependentValues" + } + } + }, + "DependentValues" : { + "type" : "object", + "properties" : { + "values" : { + "type" : "array", + "xml" : { + "name" : "dependentValue" + }, + "description" : "The dependent values", + "items" : { + "type" : "string", + "xml" : { + "name" : "dependentValue" + } + } + } + } + }, + "DeprecationNotice" : { + "type" : "object", + "properties" : { + "reason" : { + "type" : "string", + "description" : "The reason for the deprecation" + }, + "alternatives" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The alternatives to use", + "items" : { + "type" : "string", + "xml" : { + "name" : "alternative" + } + } + } + } + }, + "DynamicProperty" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The description of the dynamic property name" + }, + "value" : { + "type" : "string", + "description" : "The description of the dynamic property value" + }, + "description" : { + "type" : "string", + "description" : "The description of the dynamic property" + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "The scope of the expression language support", + "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] + }, + "expressionLanguageSupported" : { + "type" : "boolean", + "description" : "Whether or not expression language is supported" + } + } + }, + "DynamicRelationship" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The description of the dynamic relationship name" + }, + "description" : { + "type" : "string", + "description" : "The description of the dynamic relationship" + } + } + }, + "Extension" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the extension" + }, + "type" : { + "type" : "string", + "description" : "The type of the extension", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] + }, + "deprecationNotice" : { + "description" : "The deprecation notice of the extension", + "$ref" : "#/definitions/DeprecationNotice" + }, + "description" : { + "type" : "string", + "description" : "The description of the extension" + }, + "tags" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The tags of the extension", + "items" : { + "type" : "string", + "xml" : { + "name" : "tag" + } + } + }, + "properties" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The properties of the extension", + "items" : { + "xml" : { + "name" : "property" + }, + "$ref" : "#/definitions/Property" + } + }, + "supportsSensitiveDynamicProperties" : { + "type" : "boolean" + }, + "dynamicProperties" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The dynamic properties of the extension", + "items" : { + "xml" : { + "name" : "dynamicProperty" + }, + "$ref" : "#/definitions/DynamicProperty" + } + }, + "relationships" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The relationships of the extension", + "items" : { + "xml" : { + "name" : "relationship" + }, + "$ref" : "#/definitions/Relationship" + } + }, + "dynamicRelationship" : { + "description" : "The dynamic relationships of the extension", + "$ref" : "#/definitions/DynamicRelationship" + }, + "readsAttributes" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The attributes read from flow files by the extension", + "items" : { + "xml" : { + "name" : "readsAttribute" + }, + "$ref" : "#/definitions/Attribute" + } + }, + "writesAttributes" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The attributes written to flow files by the extension", + "items" : { + "xml" : { + "name" : "writesAttribute" + }, + "$ref" : "#/definitions/Attribute" + } + }, + "stateful" : { + "description" : "The information about how the extension stores state", + "$ref" : "#/definitions/Stateful" + }, + "restricted" : { + "description" : "The restrictions of the extension", + "$ref" : "#/definitions/Restricted" + }, + "inputRequirement" : { + "type" : "string", + "description" : "The input requirement of the extension", + "enum" : [ "INPUT_REQUIRED", "INPUT_ALLOWED", "INPUT_FORBIDDEN" ] + }, + "systemResourceConsiderations" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The resource considerations of the extension", + "items" : { + "xml" : { + "name" : "systemResourceConsideration" + }, + "$ref" : "#/definitions/SystemResourceConsideration" + } + }, + "seeAlso" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The names of other extensions to see", + "items" : { + "type" : "string", + "xml" : { + "name" : "see" + } + } + }, + "providedServiceAPIs" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The service APIs provided by this extension", + "items" : { + "xml" : { + "name" : "providedServiceAPI" + }, + "$ref" : "#/definitions/ProvidedServiceAPI" + } + }, + "defaultSettings" : { + "description" : "The default settings for a processor", + "$ref" : "#/definitions/DefaultSettings" + }, + "defaultSchedule" : { + "description" : "The default schedule for a processor reporting task", + "$ref" : "#/definitions/DefaultSchedule" + }, + "triggerSerially" : { + "type" : "boolean", + "description" : "Indicates that a processor should be triggered serially" + }, + "triggerWhenEmpty" : { + "type" : "boolean", + "description" : "Indicates that a processor should be triggered when the incoming queues are empty" + }, + "triggerWhenAnyDestinationAvailable" : { + "type" : "boolean", + "description" : "Indicates that a processor should be triggered when any destinations have space for flow files" + }, + "supportsBatching" : { + "type" : "boolean", + "description" : "Indicates that a processor supports batching" + }, + "eventDriven" : { + "type" : "boolean", + "description" : "Indicates that a processor supports event driven scheduling" + }, + "primaryNodeOnly" : { + "type" : "boolean", + "description" : "Indicates that a processor should be scheduled only on the primary node" + }, + "sideEffectFree" : { + "type" : "boolean", + "description" : "Indicates that a processor is side effect free" + } + } + }, + "ExtensionBundle" : { + "type" : "object", + "required" : [ "bucketIdentifier", "bundleType", "name", "type" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the item." + }, + "description" : { + "type" : "string", + "description" : "A description of the item." + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket this items belongs to.", + "readOnly" : true + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was created, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "modifiedTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "type" : { + "type" : "string", + "description" : "The type of item.", + "enum" : [ "Flow", "Bundle" ] + }, + "permissions" : { + "description" : "The access that the current user has to the bucket containing this item.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "bundleType" : { + "type" : "string", + "description" : "The type of the extension bundle", + "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the extension bundle" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the extension bundle" + }, + "versionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of versions of this extension bundle.", + "readOnly" : true, + "minimum" : 0 + } + } + }, + "ExtensionFilterParams" : { + "type" : "object", + "properties" : { + "bundleType" : { + "type" : "string", + "description" : "The type of bundle", + "enum" : [ "NIFI_NAR", "MINIFI_CPP" ] + }, + "extensionType" : { + "type" : "string", + "description" : "The type of extension", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] + }, + "tags" : { + "type" : "array", + "description" : "The tags", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "ExtensionMetadata" : { + "type" : "object", + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "name" : { + "type" : "string", + "description" : "The name of the extension" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the extension" + }, + "type" : { + "type" : "string", + "description" : "The type of the extension", + "enum" : [ "PROCESSOR", "CONTROLLER_SERVICE", "REPORTING_TASK" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the extension" + }, + "deprecationNotice" : { + "description" : "The deprecation notice of the extension", + "$ref" : "#/definitions/DeprecationNotice" + }, + "tags" : { + "type" : "array", + "description" : "The tags of the extension", + "items" : { + "type" : "string" + } + }, + "restricted" : { + "description" : "The restrictions of the extension", + "$ref" : "#/definitions/Restricted" + }, + "providedServiceAPIs" : { + "type" : "array", + "description" : "The service APIs provided by the extension", + "items" : { + "$ref" : "#/definitions/ProvidedServiceAPI" + } + }, + "bundleInfo" : { + "description" : "The information for the bundle where this extension is located", + "$ref" : "#/definitions/BundleInfo" + }, + "hasAdditionalDetails" : { + "type" : "boolean", + "description" : "Whether or not the extension has additional detail documentation" + }, + "linkDocs" : { + "description" : "A WebLink to the documentation for this extension.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + } + } + }, + "ExtensionMetadataContainer" : { + "type" : "object", + "properties" : { + "numResults" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extensions in the response" + }, + "filterParams" : { + "description" : "The filter parameters submitted for the request", + "$ref" : "#/definitions/ExtensionFilterParams" + }, + "extensions" : { + "type" : "array", + "description" : "The metadata for the extensions", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ExtensionMetadata" + } + } + } + }, + "ExtensionRepoArtifact" : { + "type" : "object", + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketName" : { + "type" : "string", + "description" : "The bucket name" + }, + "groupId" : { + "type" : "string", + "description" : "The group id" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id" + } + } + }, + "ExtensionRepoBucket" : { + "type" : "object", + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket" + } + } + }, + "ExtensionRepoGroup" : { + "type" : "object", + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketName" : { + "type" : "string", + "description" : "The bucket name" + }, + "groupId" : { + "type" : "string", + "description" : "The group id" + } + } + }, + "ExtensionRepoVersion" : { + "type" : "object", + "properties" : { + "extensionsLink" : { + "description" : "The WebLink to view the metadata about the extensions contained in the extension bundle.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "downloadLink" : { + "description" : "The WebLink to download this version of the extension bundle.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "sha256Link" : { + "description" : "The WebLink to retrieve the SHA-256 digest for this version of the extension bundle.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "sha256Supplied" : { + "description" : "Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + } + } + }, + "ExtensionRepoVersionSummary" : { + "type" : "object", + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketName" : { + "type" : "string", + "description" : "The bucket name" + }, + "groupId" : { + "type" : "string", + "description" : "The group id" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id" + }, + "version" : { + "type" : "string", + "description" : "The version" + }, + "author" : { + "type" : "string", + "description" : "The identity of the user that created this version" + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when this version was created" + } + } + }, + "ExternalControllerServiceReference" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the controller service" + }, + "name" : { + "type" : "string", + "description" : "The name of the controller service" + } + } + }, + "Fields" : { + "type" : "object", + "properties" : { + "fields" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + } + } + }, + "JaxbLink" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "format" : "uri", + "xml" : { + "attribute" : true + }, + "description" : "The href for the link" + }, + "params" : { + "type" : "object", + "description" : "The params for the link", + "additionalProperties" : { + "type" : "string" + } + } + } + }, + "ParameterProviderReference" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the parameter provider" + }, + "name" : { + "type" : "string", + "description" : "The name of the parameter provider" + }, + "type" : { + "type" : "string", + "description" : "The fully qualified name of the parameter provider class." + }, + "bundle" : { + "description" : "The details of the artifact that bundled this parameter provider.", + "$ref" : "#/definitions/Bundle" + } + } + }, + "Permissions" : { + "type" : "object", + "properties" : { + "canRead" : { + "type" : "boolean", + "description" : "Indicates whether the user can read a given resource.", + "readOnly" : true + }, + "canWrite" : { + "type" : "boolean", + "description" : "Indicates whether the user can write a given resource.", + "readOnly" : true + }, + "canDelete" : { + "type" : "boolean", + "description" : "Indicates whether the user can delete a given resource.", + "readOnly" : true + } + } + }, + "Position" : { + "type" : "object", + "properties" : { + "x" : { + "type" : "number", + "format" : "double", + "description" : "The x coordinate." + }, + "y" : { + "type" : "number", + "format" : "double", + "description" : "The y coordinate." + } + }, + "description" : "The position of a component on the graph" + }, + "Property" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "displayName" : { + "type" : "string", + "description" : "The display name" + }, + "description" : { + "type" : "string", + "description" : "The description" + }, + "defaultValue" : { + "type" : "string", + "description" : "The default value" + }, + "controllerServiceDefinition" : { + "description" : "The controller service required by this property, or null if none is required", + "$ref" : "#/definitions/ControllerServiceDefinition" + }, + "allowableValues" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The allowable values for this property", + "items" : { + "xml" : { + "name" : "allowableValue" + }, + "$ref" : "#/definitions/AllowableValue" + } + }, + "required" : { + "type" : "boolean", + "description" : "Whether or not the property is required" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the property is sensitive" + }, + "expressionLanguageSupported" : { + "type" : "boolean", + "description" : "Whether or not expression language is supported" + }, + "expressionLanguageScope" : { + "type" : "string", + "description" : "The scope of expression language support", + "enum" : [ "NONE", "VARIABLE_REGISTRY", "FLOWFILE_ATTRIBUTES" ] + }, + "dynamicallyModifiesClasspath" : { + "type" : "boolean", + "description" : "Whether or not the processor dynamically modifies the classpath" + }, + "dynamic" : { + "type" : "boolean", + "description" : "Whether or not the processor is dynamic" + }, + "dependencies" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The properties that this property depends on", + "items" : { + "xml" : { + "name" : "dependency" + }, + "$ref" : "#/definitions/Dependency" + } + }, + "resourceDefinition" : { + "description" : "The optional resource definition", + "$ref" : "#/definitions/ResourceDefinition" + } + } + }, + "ProvidedServiceAPI" : { + "type" : "object", + "properties" : { + "className" : { + "type" : "string", + "description" : "The class name of the service API being provided" + }, + "groupId" : { + "type" : "string", + "description" : "The group id of the service API being provided" + }, + "artifactId" : { + "type" : "string", + "description" : "The artifact id of the service API being provided" + }, + "version" : { + "type" : "string", + "description" : "The version of the service API being provided" + } + } + }, + "RegistryAbout" : { + "type" : "object", + "properties" : { + "registryAboutVersion" : { + "type" : "string", + "description" : "The version string for this Nifi Registry", + "readOnly" : true + } + } + }, + "RegistryConfiguration" : { + "type" : "object", + "properties" : { + "supportsManagedAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.", + "readOnly" : true + }, + "supportsConfigurableAuthorizer" : { + "type" : "boolean", + "description" : "Whether this NiFi Registry supports a configurable authorizer.", + "readOnly" : true + }, + "supportsConfigurableUsersAndGroups" : { + "type" : "boolean", + "description" : "Whether this NiFi Registry supports configurable users and groups.", + "readOnly" : true + } + } + }, + "Relationship" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the relationship" + }, + "description" : { + "type" : "string", + "description" : "The description of the relationship" + }, + "autoTerminated" : { + "type" : "boolean", + "description" : "Whether or not the relationship is auto-terminated by default" + } + } + }, + "Resource" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The identifier of the resource.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the resource.", + "readOnly" : true + } + } + }, + "ResourceDefinition" : { + "type" : "object", + "properties" : { + "cardinality" : { + "type" : "string", + "description" : "The cardinality of the resource definition", + "enum" : [ "SINGLE", "MULTIPLE" ] + }, + "resourceTypes" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The types of resources", + "items" : { + "type" : "string", + "xml" : { + "name" : "resourceType" + }, + "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] + } + } + } + }, + "ResourcePermissions" : { + "type" : "object", + "properties" : { + "buckets" : { + "description" : "The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "tenants" : { + "description" : "The access that the current user has to the top level /tenants resource of this NiFi Registry", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "policies" : { + "description" : "The access that the current user has to the top level /policies resource of this NiFi Registry", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "proxy" : { + "description" : "The access that the current user has to the top level /proxy resource of this NiFi Registry", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "anyTopLevelResource" : { + "description" : "The access that the current user has to any top level resources (a logical 'OR' of all other values)", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + } + } + }, + "Restricted" : { + "type" : "object", + "properties" : { + "generalRestrictionExplanation" : { + "type" : "string", + "description" : "The general restriction for the extension, or null if only specific restrictions exist" + }, + "restrictions" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The specific restrictions", + "items" : { + "xml" : { + "name" : "restriction" + }, + "$ref" : "#/definitions/Restriction" + } + } + } + }, + "Restriction" : { + "type" : "object", + "properties" : { + "requiredPermission" : { + "type" : "string", + "description" : "The permission required for this restriction" + }, + "explanation" : { + "type" : "string", + "description" : "The explanation of this restriction" + } + } + }, + "RevisionInfo" : { + "type" : "object", + "properties" : { + "clientId" : { + "type" : "string", + "description" : "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version." + }, + "lastModifier" : { + "type" : "string", + "description" : "The user that last modified the entity.", + "readOnly" : true + } + }, + "description" : "The revision information for an entity managed through the REST API." + }, + "Stateful" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description for how the extension stores state" + }, + "scopes" : { + "type" : "array", + "xml" : { + "wrapped" : true + }, + "description" : "The scopes used to store state", + "items" : { + "type" : "string", + "xml" : { + "name" : "scope" + }, + "enum" : [ "CLUSTER", "LOCAL" ] + } + } + } + }, + "SystemResourceConsideration" : { + "type" : "object", + "properties" : { + "resource" : { + "type" : "string", + "description" : "The resource to consider" + }, + "description" : { + "type" : "string", + "description" : "The description of how the resource is affected" + } + } + }, + "TagCount" : { + "type" : "object", + "properties" : { + "tag" : { + "type" : "string", + "description" : "The tag label" + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of occurrences of the given tag" + } + } + }, + "Tenant" : { + "type" : "object", + "required" : [ "identity" ], + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The computer-generated identifier of the tenant.", + "readOnly" : true + }, + "identity" : { + "type" : "string", + "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", + "readOnly" : true + }, + "resourcePermissions" : { + "description" : "A summary top-level resource access policies granted to this tenant.", + "readOnly" : true, + "$ref" : "#/definitions/ResourcePermissions" + }, + "accessPolicies" : { + "type" : "array", + "description" : "The access policies granted to this tenant.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicySummary" + } + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + } + } + }, + "User" : { + "type" : "object", + "required" : [ "identity" ], + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The computer-generated identifier of the tenant.", + "readOnly" : true + }, + "identity" : { + "type" : "string", + "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", + "readOnly" : true + }, + "resourcePermissions" : { + "description" : "A summary top-level resource access policies granted to this tenant.", + "readOnly" : true, + "$ref" : "#/definitions/ResourcePermissions" + }, + "accessPolicies" : { + "type" : "array", + "description" : "The access policies granted to this tenant.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicySummary" + } + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + }, + "userGroups" : { + "type" : "array", + "description" : "The groups to which the user belongs.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/Tenant" + } + } + } + }, + "UserGroup" : { + "type" : "object", + "required" : [ "identity" ], + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The computer-generated identifier of the tenant.", + "readOnly" : true + }, + "identity" : { + "type" : "string", + "description" : "The human-facing identity of the tenant. This can only be changed if the tenant is configurable." + }, + "configurable" : { + "type" : "boolean", + "description" : "Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.", + "readOnly" : true + }, + "resourcePermissions" : { + "description" : "A summary top-level resource access policies granted to this tenant.", + "readOnly" : true, + "$ref" : "#/definitions/ResourcePermissions" + }, + "accessPolicies" : { + "type" : "array", + "description" : "The access policies granted to this tenant.", + "readOnly" : true, + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/AccessPolicySummary" + } + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + }, + "users" : { + "type" : "array", + "description" : "The users that belong to this user group. This can only be changed if this group is configurable.", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/Tenant" + } + } + } + }, + "VersionedConnection" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "source" : { + "description" : "The source of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "destination" : { + "description" : "The destination of the connection.", + "$ref" : "#/definitions/ConnectableComponent" + }, + "labelIndex" : { + "type" : "integer", + "format" : "int32", + "description" : "The index of the bend point where to place the connection label." + }, + "zIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "selectedRelationships" : { + "type" : "array", + "description" : "The selected relationship that comprise the connection.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." + }, + "backPressureDataSizeThreshold" : { + "type" : "string", + "description" : "The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue." + }, + "flowFileExpiration" : { + "type" : "string", + "description" : "The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it." + }, + "prioritizers" : { + "type" : "array", + "description" : "The comparators used to prioritize the queue.", + "items" : { + "type" : "string" + } + }, + "bends" : { + "type" : "array", + "description" : "The bend points on the connection.", + "items" : { + "$ref" : "#/definitions/Position" + } + }, + "loadBalanceStrategy" : { + "type" : "string", + "description" : "The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.", + "enum" : [ "DO_NOT_LOAD_BALANCE", "PARTITION_BY_ATTRIBUTE", "ROUND_ROBIN", "SINGLE_NODE" ] + }, + "partitioningAttribute" : { + "type" : "string", + "description" : "The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect." + }, + "loadBalanceCompression" : { + "type" : "string", + "description" : "Whether or not compression should be used when transferring FlowFiles between nodes", + "enum" : [ "DO_NOT_COMPRESS", "COMPRESS_ATTRIBUTES_ONLY", "COMPRESS_ATTRIBUTES_AND_CONTENT" ] + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedControllerService" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of the extension component" + }, + "bundle" : { + "description" : "Information about the bundle from which the component came", + "$ref" : "#/definitions/Bundle" + }, + "properties" : { + "type" : "object", + "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the component.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "controllerServiceApis" : { + "type" : "array", + "description" : "Lists the APIs this Controller Service implements.", + "items" : { + "$ref" : "#/definitions/ControllerServiceAPI" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation for the controller service. This is how the custom UI relays configuration to the controller service." + }, + "scheduledState" : { + "type" : "string", + "description" : "The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the controller service will report bulletins." + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedFlow" : { + "type" : "object", + "required" : [ "bucketIdentifier", "name", "type" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "identifier" : { + "type" : "string", + "description" : "An ID to uniquely identify this object.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "The name of the item." + }, + "description" : { + "type" : "string", + "description" : "A description of the item." + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this items belongs to. This cannot be changed after the item is created." + }, + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket this items belongs to.", + "readOnly" : true + }, + "createdTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was created, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "modifiedTimestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp of when the item was last modified, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "type" : { + "type" : "string", + "description" : "The type of item.", + "enum" : [ "Flow", "Bundle" ] + }, + "permissions" : { + "description" : "The access that the current user has to the bucket containing this item.", + "readOnly" : true, + "$ref" : "#/definitions/Permissions" + }, + "versionCount" : { + "type" : "integer", + "format" : "int64", + "description" : "The number of versions of this flow.", + "readOnly" : true, + "minimum" : 0 + }, + "revision" : { + "description" : "The revision of this entity used for optimistic-locking during updates.", + "readOnly" : true, + "$ref" : "#/definitions/RevisionInfo" + } + } + }, + "VersionedFlowCoordinates" : { + "type" : "object", + "properties" : { + "registryId" : { + "type" : "string", + "description" : "The identifier of the Flow Registry that contains the flow" + }, + "storageLocation" : { + "type" : "string", + "description" : "The location of the Flow Registry that stores the flow" + }, + "registryUrl" : { + "type" : "string", + "description" : "The URL of the Flow Registry that contains the flow" + }, + "bucketId" : { + "type" : "string", + "description" : "The UUID of the bucket that the flow resides in" + }, + "flowId" : { + "type" : "string", + "description" : "The UUID of the flow" + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of the flow" + }, + "latest" : { + "type" : "boolean", + "description" : "Whether or not these coordinates point to the latest version of the flow" + } + } + }, + "VersionedFlowDifference" : { + "type" : "object", + "properties" : { + "bucketId" : { + "type" : "string", + "description" : "The id of the bucket that the flow is stored in." + }, + "flowId" : { + "type" : "string", + "description" : "The id of the flow that is being examined." + }, + "versionA" : { + "type" : "integer", + "format" : "int32", + "description" : "The earlier version from the diff operation." + }, + "versionB" : { + "type" : "integer", + "format" : "int32", + "description" : "The latter version from the diff operation." + }, + "componentDifferenceGroups" : { + "type" : "array", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/ComponentDifferenceGroup" + } + } + } + }, + "VersionedFlowSnapshot" : { + "type" : "object", + "required" : [ "flowContents", "snapshotMetadata" ], + "properties" : { + "snapshotMetadata" : { + "description" : "The metadata for this snapshot", + "$ref" : "#/definitions/VersionedFlowSnapshotMetadata" + }, + "flowContents" : { + "description" : "The contents of the versioned flow", + "$ref" : "#/definitions/VersionedProcessGroup" + }, + "externalControllerServices" : { + "type" : "object", + "description" : "The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.", + "additionalProperties" : { + "$ref" : "#/definitions/ExternalControllerServiceReference" + } + }, + "parameterProviders" : { + "type" : "object", + "description" : "Contains basic information about parameter providers referenced in the versioned flow.", + "additionalProperties" : { + "$ref" : "#/definitions/ParameterProviderReference" + } + }, + "parameterContexts" : { + "type" : "object", + "description" : "The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedParameterContext" + } + }, + "flowEncodingVersion" : { + "type" : "string", + "description" : "The optional encoding version of the flow contents." + }, + "flow" : { + "description" : "The flow this snapshot is for", + "readOnly" : true, + "$ref" : "#/definitions/VersionedFlow" + }, + "bucket" : { + "description" : "The bucket where the flow is located", + "readOnly" : true, + "$ref" : "#/definitions/Bucket" + }, + "latest" : { + "type" : "boolean" + } + } + }, + "VersionedFlowSnapshotMetadata" : { + "type" : "object", + "required" : [ "bucketIdentifier", "flowIdentifier", "version" ], + "properties" : { + "link" : { + "description" : "An WebLink to this entity.", + "readOnly" : true, + "$ref" : "#/definitions/JaxbLink" + }, + "bucketIdentifier" : { + "type" : "string", + "description" : "The identifier of the bucket this snapshot belongs to." + }, + "flowIdentifier" : { + "type" : "string", + "description" : "The identifier of the flow this snapshot belongs to." + }, + "version" : { + "type" : "integer", + "format" : "int32", + "description" : "The version of this snapshot of the flow.", + "minimum" : -1 + }, + "timestamp" : { + "type" : "integer", + "format" : "int64", + "description" : "The timestamp when the flow was saved, as milliseconds since epoch.", + "readOnly" : true, + "minimum" : 1 + }, + "author" : { + "type" : "string", + "description" : "The user that created this snapshot of the flow.", + "readOnly" : true + }, + "comments" : { + "type" : "string", + "description" : "The comments provided by the user when creating the snapshot." + } + } + }, + "VersionedFunnel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedLabel" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "label" : { + "type" : "string", + "description" : "The text that appears in the label." + }, + "zIndex" : { + "type" : "integer", + "format" : "int64", + "description" : "The z index of the connection." + }, + "width" : { + "type" : "number", + "format" : "double", + "description" : "The width of the label in pixels when at a 1:1 scale." + }, + "height" : { + "type" : "number", + "format" : "double", + "description" : "The height of the label in pixels when at a 1:1 scale." + }, + "style" : { + "type" : "object", + "description" : "The styles for this label (font-size : 12px, background-color : #eee, etc).", + "additionalProperties" : { + "type" : "string" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedParameter" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the parameter" + }, + "description" : { + "type" : "string", + "description" : "The description of the param" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the parameter value is sensitive" + }, + "provided" : { + "type" : "boolean", + "description" : "Whether or not the parameter value is provided by a ParameterProvider" + }, + "value" : { + "type" : "string", + "description" : "The value of the parameter" + } + } + }, + "VersionedParameterContext" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "parameters" : { + "type" : "array", + "description" : "The parameters in the context", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedParameter" + } + }, + "inheritedParameterContexts" : { + "type" : "array", + "description" : "The names of additional parameter contexts from which to inherit parameters", + "items" : { + "type" : "string" + } + }, + "description" : { + "type" : "string", + "description" : "The description of the parameter context" + }, + "parameterProvider" : { + "type" : "string", + "description" : "The identifier of an optional parameter provider" + }, + "parameterGroupName" : { + "type" : "string", + "description" : "The corresponding parameter group name fetched from the parameter provider, if applicable" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "synchronized" : { + "type" : "boolean", + "description" : "True if the parameter provider is set and the context should receive updates when its parameters are next fetched" + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of port.", + "enum" : [ "INPUT_PORT", "OUTPUT_PORT" ] + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently scheduled for the port." + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "allowRemoteAccess" : { + "type" : "boolean", + "description" : "Whether or not this port allows remote access for site-to-site" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "processGroups" : { + "type" : "array", + "description" : "The child Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessGroup" + } + }, + "remoteProcessGroups" : { + "type" : "array", + "description" : "The Remote Process Groups", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteProcessGroup" + } + }, + "processors" : { + "type" : "array", + "description" : "The Processors", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedProcessor" + } + }, + "inputPorts" : { + "type" : "array", + "description" : "The Input Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "The Output Ports", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedPort" + } + }, + "connections" : { + "type" : "array", + "description" : "The Connections", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedConnection" + } + }, + "labels" : { + "type" : "array", + "description" : "The Labels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedLabel" + } + }, + "funnels" : { + "type" : "array", + "description" : "The Funnels", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedFunnel" + } + }, + "controllerServices" : { + "type" : "array", + "description" : "The Controller Services", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedControllerService" + } + }, + "versionedFlowCoordinates" : { + "description" : "The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control", + "$ref" : "#/definitions/VersionedFlowCoordinates" + }, + "variables" : { + "type" : "object", + "description" : "The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)", + "additionalProperties" : { + "type" : "string" + } + }, + "parameterContextName" : { + "type" : "string", + "description" : "The name of the parameter context used by this process group" + }, + "defaultFlowFileExpiration" : { + "type" : "string", + "description" : "The default FlowFile Expiration for this Process Group." + }, + "defaultBackPressureObjectThreshold" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied." + }, + "defaultBackPressureDataSizeThreshold" : { + "type" : "string", + "description" : "Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied." + }, + "logFileSuffix" : { + "type" : "string", + "description" : "The log file suffix for this Process Group for dedicated logging." + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "flowFileOutboundPolicy" : { + "type" : "string", + "description" : "The FlowFile Outbound Policy for the Process Group" + }, + "flowFileConcurrency" : { + "type" : "string", + "description" : "The configured FlowFile Concurrency for the Process Group" + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedProcessor" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "type" : { + "type" : "string", + "description" : "The type of the extension component" + }, + "bundle" : { + "description" : "Information about the bundle from which the component came", + "$ref" : "#/definitions/Bundle" + }, + "properties" : { + "type" : "object", + "description" : "The properties for the component. Properties whose value is not set will only contain the property name.", + "additionalProperties" : { + "type" : "string" + } + }, + "propertyDescriptors" : { + "type" : "object", + "description" : "The property descriptors for the component.", + "additionalProperties" : { + "$ref" : "#/definitions/VersionedPropertyDescriptor" + } + }, + "style" : { + "type" : "object", + "description" : "Stylistic data for rendering in a UI", + "additionalProperties" : { + "type" : "string" + } + }, + "annotationData" : { + "type" : "string", + "description" : "The annotation data for the processor used to relay configuration between a custom UI and the procesosr." + }, + "schedulingPeriod" : { + "type" : "string", + "description" : "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy." + }, + "schedulingStrategy" : { + "type" : "string", + "description" : "Indicates whether the processor should be scheduled to run in event or timer driven mode." + }, + "executionNode" : { + "type" : "string", + "description" : "Indicates the node where the process will execute." + }, + "penaltyDuration" : { + "type" : "string", + "description" : "The amout of time that is used when the process penalizes a flowfile." + }, + "yieldDuration" : { + "type" : "string", + "description" : "The amount of time that must elapse before this processor is scheduled again after yielding." + }, + "bulletinLevel" : { + "type" : "string", + "description" : "The level at which the processor will report bulletins." + }, + "runDurationMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "The run duration for the processor in milliseconds." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored." + }, + "autoTerminatedRelationships" : { + "type" : "array", + "description" : "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "retryCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Overall number of retries." + }, + "retriedRelationships" : { + "type" : "array", + "description" : "All the relationships should be retried.", + "uniqueItems" : true, + "items" : { + "type" : "string" + } + }, + "backoffMechanism" : { + "type" : "string", + "description" : "Determines whether the FlowFile should be penalized or the processor should be yielded between retries.", + "enum" : [ "PENALIZE_FLOWFILE", "YIELD_PROCESSOR" ] + }, + "maxBackoffPeriod" : { + "type" : "string", + "description" : "Maximum amount of time to be waited during a retry period." + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedPropertyDescriptor" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "The name of the property" + }, + "displayName" : { + "type" : "string", + "description" : "The display name of the property" + }, + "identifiesControllerService" : { + "type" : "boolean", + "description" : "Whether or not the property provides the identifier of a Controller Service" + }, + "sensitive" : { + "type" : "boolean", + "description" : "Whether or not the property is considered sensitive" + }, + "resourceDefinition" : { + "description" : "Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any", + "$ref" : "#/definitions/VersionedResourceDefinition" + } + } + }, + "VersionedRemoteGroupPort" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "remoteGroupId" : { + "type" : "string", + "description" : "The id of the remote process group that the port resides in." + }, + "concurrentlySchedulableTaskCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of task that may transmit flowfiles to the target port concurrently." + }, + "useCompression" : { + "type" : "boolean", + "description" : "Whether the flowfiles are compressed when sent to the target port." + }, + "batchSize" : { + "description" : "The batch settings for data transmission.", + "$ref" : "#/definitions/BatchSize" + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "targetId" : { + "type" : "string", + "description" : "The ID of the port on the target NiFi instance" + }, + "scheduledState" : { + "type" : "string", + "description" : "The scheduled state of the component", + "enum" : [ "ENABLED", "DISABLED", "RUNNING" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedRemoteProcessGroup" : { + "type" : "object", + "properties" : { + "identifier" : { + "type" : "string", + "description" : "The component's unique identifier" + }, + "instanceIdentifier" : { + "type" : "string", + "description" : "The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component" + }, + "name" : { + "type" : "string", + "description" : "The component's name" + }, + "comments" : { + "type" : "string", + "description" : "The user-supplied comments for the component" + }, + "position" : { + "description" : "The component's position on the graph", + "$ref" : "#/definitions/Position" + }, + "targetUri" : { + "type" : "string", + "description" : "[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null." + }, + "targetUris" : { + "type" : "string", + "description" : "The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null." + }, + "communicationsTimeout" : { + "type" : "string", + "description" : "The time period used for the timeout when communicating with the target." + }, + "yieldDuration" : { + "type" : "string", + "description" : "When yielding, this amount of time must elapse before the remote process group is scheduled again." + }, + "transportProtocol" : { + "type" : "string", + "description" : "The Transport Protocol that is used for Site-to-Site communications", + "enum" : [ "RAW", "HTTP" ] + }, + "localNetworkInterface" : { + "type" : "string", + "description" : "The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier." + }, + "proxyHost" : { + "type" : "string" + }, + "proxyPort" : { + "type" : "integer", + "format" : "int32" + }, + "proxyUser" : { + "type" : "string" + }, + "proxyPassword" : { + "type" : "string" + }, + "inputPorts" : { + "type" : "array", + "description" : "A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "outputPorts" : { + "type" : "array", + "description" : "A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance", + "uniqueItems" : true, + "items" : { + "$ref" : "#/definitions/VersionedRemoteGroupPort" + } + }, + "componentType" : { + "type" : "string", + "enum" : [ "CONNECTION", "PROCESSOR", "PROCESS_GROUP", "REMOTE_PROCESS_GROUP", "INPUT_PORT", "OUTPUT_PORT", "REMOTE_INPUT_PORT", "REMOTE_OUTPUT_PORT", "FUNNEL", "LABEL", "CONTROLLER_SERVICE", "REPORTING_TASK", "PARAMETER_CONTEXT", "PARAMETER_PROVIDER", "TEMPLATE", "FLOW_REGISTRY_CLIENT" ] + }, + "groupIdentifier" : { + "type" : "string", + "description" : "The ID of the Process Group that this component belongs to" + } + } + }, + "VersionedResourceDefinition" : { + "type" : "object", + "properties" : { + "cardinality" : { + "type" : "string", + "description" : "The cardinality of the resource", + "enum" : [ "SINGLE", "MULTIPLE" ] + }, + "resourceTypes" : { + "type" : "array", + "description" : "The types of resource that the Property Descriptor is allowed to reference", + "uniqueItems" : true, + "items" : { + "type" : "string", + "enum" : [ "FILE", "DIRECTORY", "TEXT", "URL" ] + } + } + } + } + } +} \ No newline at end of file diff --git a/resources/docker/latest/docker-compose.yml b/resources/docker/latest/docker-compose.yml index 9b780979..4cc99853 100644 --- a/resources/docker/latest/docker-compose.yml +++ b/resources/docker/latest/docker-compose.yml @@ -1,6 +1,6 @@ services: nifi: - image: apache/nifi:1.23.2 + image: apache/nifi:1.27.0 container_name: nifi hostname: nifi ports: @@ -9,7 +9,7 @@ services: - SINGLE_USER_CREDENTIALS_USERNAME=nobel - SINGLE_USER_CREDENTIALS_PASSWORD=supersecret1! registry: - image: apache/nifi-registry:1.23.2 + image: apache/nifi-registry:1.27.0 container_name: registry hostname: registry ports: diff --git a/resources/docker/secure/docker-compose.yml b/resources/docker/secure/docker-compose.yml index 5c13f211..364ad1fe 100644 --- a/resources/docker/secure/docker-compose.yml +++ b/resources/docker/secure/docker-compose.yml @@ -1,6 +1,6 @@ services: secure-nifi: - image: apache/nifi:1.23.2 + image: apache/nifi:1.27.0 container_name: secure-nifi hostname: secure-nifi ports: @@ -25,7 +25,7 @@ services: - LDAP_URL=ldap://ldap.forumsys.com:389 - NIFI_WEB_PROXY_HOST=localhost:9443,localhost:8443 secure-registry: - image: apache/nifi-registry:1.23.2 + image: apache/nifi-registry:1.27.0 container_name: secure-registry hostname: secure-registry ports: diff --git a/resources/docker/tox-full/docker-compose.yml b/resources/docker/tox-full/docker-compose.yml index 0d926486..fbf47de6 100644 --- a/resources/docker/tox-full/docker-compose.yml +++ b/resources/docker/tox-full/docker-compose.yml @@ -24,7 +24,7 @@ services: ports: - "10192:8080" nifi: - image: apache/nifi:1.23.2 + image: apache/nifi:1.27.0 container_name: nifi hostname: nifi ports: @@ -49,7 +49,7 @@ services: environment: - NIFI_REGISTRY_WEB_HTTP_PORT=18030 registry: - image: apache/nifi-registry:1.23.2 + image: apache/nifi-registry:1.27.0 container_name: registry hostname: registry ports: diff --git a/setup.py b/setup.py index 94a87330..3cb14b99 100644 --- a/setup.py +++ b/setup.py @@ -31,6 +31,9 @@ ), include_package_data=True, install_requires=requirements, + extras_require={ + 'demo': ['docker>=2.5.1'] + }, license="Apache Software License 2.0", zip_safe=False, keywords=['nipyapi', 'nifi', 'api', 'wrapper'], diff --git a/tox.ini b/tox.ini index 167fad09..7de5cb3f 100644 --- a/tox.ini +++ b/tox.ini @@ -4,7 +4,7 @@ envlist = python2, python3old, python3new, flake8, lint [travis] python = 3.7: python3old - 3.11: python3new + 3.12: python3new 2.7: python2 [flake8] @@ -48,5 +48,5 @@ deps = -r{toxinidir}/requirements.txt commands = pip install -U pip - coverage run -m py.test --basetemp={envtmpdir} -x --log-cli-level=WARNING + coverage run -m pytest --basetemp={envtmpdir} -x --log-cli-level=WARNING - coveralls From a8adb27365d4aab6a76150d875fef1ff94c35744 Mon Sep 17 00:00:00 2001 From: Dan Chaffelson Date: Sun, 6 Oct 2024 13:14:20 +0000 Subject: [PATCH 06/11] update history for new release --- docs/history.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/history.rst b/docs/history.rst index 978eb5fc..c8c12b38 100644 --- a/docs/history.rst +++ b/docs/history.rst @@ -2,6 +2,27 @@ History ======= +0.21.0 (2024-07-14) +------------------- + +| Updated client for NiFi & Registry 1.27.0 release + +* Fix API model generator by @michaelarnauts in https://github.com/Chaffelson/nipyapi/pull/356 +* issue-360: handle -9 error messages better by @ottobackwards in https://github.com/Chaffelson/nipyapi/pull/361 +* Handle plain text response types so json values are correctly returned by @michaelarnauts in https://github.com/Chaffelson/nipyapi/pull/358 +* update clients to 1.27.0 by @Chaffelson in https://github.com/Chaffelson/nipyapi/pull/365 +* Simplified the use of setattr in recurse_flow, flatten, and list_all_by_kind methods in nipyapi/canvas.py. +* Added support for key_password in the Configuration class and its usage in nipyapi/nifi/rest.py and nipyapi/registry/rest.py. +* Fixed the method to retrieve HTTP headers in nipyapi/nifi/rest.py and nipyapi/registry/rest.py. +* Fixed issue #326 where the latest flow version was not being deployed by default +* Updated pylintrc to match more modern python standards +* Fixes nipyapi.nifi.ProcessGroupsApi.upload_process_group_with_http_info() incomplete #310 +* VersionedReportingTask added with appropriate functions +* Move docker requirement to extras to avoid dependency install during standard usage +* Set latest python3 version to 3.12 +* Deprecate usage of py.test in favour of newer pytest. +* Update readme + 0.20.0 (2024-04-14) ------------------- From ac9898ef37adb2a5af67a3f59a9160e0111fa4d9 Mon Sep 17 00:00:00 2001 From: Dan Chaffelson Date: Sun, 6 Oct 2024 13:15:51 +0000 Subject: [PATCH 07/11] correct version in nipyapi/__init__.py --- nipyapi/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nipyapi/__init__.py b/nipyapi/__init__.py index da791de2..77a0cf8f 100644 --- a/nipyapi/__init__.py +++ b/nipyapi/__init__.py @@ -9,7 +9,7 @@ __author__ = """Daniel Chaffelson""" __email__ = 'chaffelson@gmail.com' -__version__ = '0.19.1' +__version__ = '0.20.0' __all__ = ['canvas', 'system', 'templates', 'config', 'nifi', 'registry', 'versioning', 'demo', 'utils', 'security', 'parameters'] From 0fabcdbf85e109d7cc8742a755eeaa515720e25d Mon Sep 17 00:00:00 2001 From: Dan Chaffelson Date: Sun, 6 Oct 2024 13:15:54 +0000 Subject: [PATCH 08/11] =?UTF-8?q?Bump=20version:=200.20.0=20=E2=86=92=200.?= =?UTF-8?q?21.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- nipyapi/__init__.py | 2 +- setup.cfg | 2 +- setup.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/nipyapi/__init__.py b/nipyapi/__init__.py index 77a0cf8f..a11cdb85 100644 --- a/nipyapi/__init__.py +++ b/nipyapi/__init__.py @@ -9,7 +9,7 @@ __author__ = """Daniel Chaffelson""" __email__ = 'chaffelson@gmail.com' -__version__ = '0.20.0' +__version__ = '0.21.0' __all__ = ['canvas', 'system', 'templates', 'config', 'nifi', 'registry', 'versioning', 'demo', 'utils', 'security', 'parameters'] diff --git a/setup.cfg b/setup.cfg index 2698d2aa..98586a92 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.20.0 +current_version = 0.21.0 commit = True tag = True diff --git a/setup.py b/setup.py index 3cb14b99..9a064d2a 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ with open('docs/history.rst') as history_file: history = history_file.read() -proj_version = '0.20.0' +proj_version = '0.21.0' with open('requirements.txt') as reqs_file: requirements = reqs_file.read().splitlines() From 18214fdc8756dec50bd8cf08bbdcf541b3fc7787 Mon Sep 17 00:00:00 2001 From: Dan Chaffelson Date: Sun, 6 Oct 2024 19:13:32 +0000 Subject: [PATCH 09/11] remove 0917 from lint checks simplify yaml dump to remove duplicate round trip via json fix py2/3 compatibility on use of yield statements. remove automated py2 testing from tox due to compatibility issues move pytest version picker to setup.py to allow additional logic. remove extraneous settings from setup.cfg set different yaml parser rules for py2/3 to better handle compatibility remove py2 limitation on development versions, greatly simplifying setup update pylintrc for new standards retire travisCI and coveralls from automated testing. Set simple coverage report, exclude from commits. --- .gitignore | 6 ++++ nipyapi/canvas.py | 3 +- nipyapi/security.py | 2 +- nipyapi/utils.py | 24 +++++++-------- nipyapi/versioning.py | 4 +-- pylintrc | 7 ----- requirements.txt | 6 ++-- requirements_dev.txt | 10 +++--- setup.cfg | 6 ---- setup.py | 14 +++++++-- tox.ini | 72 ++++++++++++++++++++----------------------- 11 files changed, 74 insertions(+), 80 deletions(-) diff --git a/.gitignore b/.gitignore index fc306a5c..a08bc8af 100644 --- a/.gitignore +++ b/.gitignore @@ -157,3 +157,9 @@ fabric.properties # Stupid OSX exclusions /.vscode + +.DS_Store +# Coverage reports +coverage* +.coverage +htmlcov/ diff --git a/nipyapi/canvas.py b/nipyapi/canvas.py index ee4086b1..03282297 100644 --- a/nipyapi/canvas.py +++ b/nipyapi/canvas.py @@ -179,7 +179,8 @@ def flatten(parent_pg): Generator for all ProcessGroupEntities, eventually """ for child_pg in parent_pg.process_group_flow.flow.process_groups: - yield from flatten(child_pg.nipyapi_extended) + for item in flatten(child_pg.nipyapi_extended): + yield item yield child_pg # Recurse children diff --git a/nipyapi/security.py b/nipyapi/security.py index 60c7b692..f10598a9 100644 --- a/nipyapi/security.py +++ b/nipyapi/security.py @@ -721,7 +721,7 @@ def create_access_policy(resource, action, r_id=None, service="nifi"): ) -# pylint: disable=R0913,R0917 +# pylint: disable=R0913 def set_service_ssl_context( service="nifi", ca_file=None, diff --git a/nipyapi/utils.py b/nipyapi/utils.py index fcf145e5..6313f7a1 100644 --- a/nipyapi/utils.py +++ b/nipyapi/utils.py @@ -18,6 +18,7 @@ from packaging import version import six from ruamel.yaml import YAML +from ruamel.yaml.compat import StringIO import requests from requests.models import Response from future.utils import raise_from as _raise @@ -57,23 +58,22 @@ def dump(obj, mode='json'): assert mode in ['json', 'yaml'] api_client = nipyapi.nifi.ApiClient() prepared_obj = api_client.sanitize_for_serialization(obj) - try: - out = json.dumps( - obj=prepared_obj, - sort_keys=True, - indent=4 - ) - except TypeError as e: - raise e if mode == 'json': - return out + try: + return json.dumps( + obj=prepared_obj, + sort_keys=True, + indent=4 + ) + except TypeError as e: + raise e if mode == 'yaml': # Use 'safe' loading to prevent arbitrary code execution yaml = YAML(typ='safe', pure=True) # Create a StringIO object to act as the stream - stream = io.StringIO() + stream = StringIO() # Dump to the StringIO stream - yaml.dump(json.loads(out), stream) + yaml.dump(prepared_obj, stream) # Return the contents of the stream as a string return stream.getvalue() raise ValueError("Invalid dump Mode specified {0}".format(mode)) @@ -350,7 +350,7 @@ def set_endpoint(endpoint_url, ssl=False, login=False, return True -# pylint: disable=R0913,R0902,R0917 +# pylint: disable=R0913,R0902 class DockerContainer(): """ Helper class for Docker container automation without using Ansible diff --git a/nipyapi/versioning.py b/nipyapi/versioning.py index 2b40721e..39de1fb0 100644 --- a/nipyapi/versioning.py +++ b/nipyapi/versioning.py @@ -217,7 +217,7 @@ def get_flow_in_bucket(bucket_id, identifier, identifier_type='name', obj, identifier, identifier_type, greedy=greedy) -# pylint: disable=R0913,R0917 +# pylint: disable=R0913 def save_flow_ver(process_group, registry_client, bucket, flow_name=None, flow_id=None, comment='', desc='', refresh=True, force=False): @@ -696,7 +696,7 @@ def import_flow_version(bucket_id, encoded_flow=None, file_path=None, ) -# pylint: disable=R0913,R0917 +# pylint: disable=R0913 def deploy_flow_version(parent_id, location, bucket_id, flow_id, reg_client_id, version=None): """ diff --git a/pylintrc b/pylintrc index e8e0ca4c..c71c138a 100644 --- a/pylintrc +++ b/pylintrc @@ -429,8 +429,6 @@ disable=raw-checker-failed, useless-suppression, deprecated-pragma, use-symbolic-message-instead, - use-implicit-booleaness-not-comparison-to-string, - use-implicit-booleaness-not-comparison-to-zero, bare-except, invalid-name, C0103, E1101, R1710, E0401, C0209 @@ -471,11 +469,6 @@ max-nested-blocks=5 # printed. never-returning-functions=sys.exit,argparse.parse_error -# Let 'consider-using-join' be raised when the separator to join on would be -# non-empty (resulting in expected fixes of the type: ``"- " + " - -# ".join(items)``) -suggest-join-with-non-empty-separator=yes - [REPORTS] diff --git a/requirements.txt b/requirements.txt index 5ef01d5b..e0e77120 100644 --- a/requirements.txt +++ b/requirements.txt @@ -19,10 +19,8 @@ requests[security]>=2.18 pysocks>=1.7.1 # Import Export and Utils implementation -ruamel.yaml<0.18 - -# Demo deployment automation -docker>=2.5.1; extra == "demo" +ruamel.yaml<0.18; python_version < '3' +ruamel.yaml; python_version >= '3' # xml to json parsing xmltodict>=0.12.0 diff --git a/requirements_dev.txt b/requirements_dev.txt index 44d0f5e6..9e2533ad 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -4,21 +4,21 @@ pip>=9.0.1 # Project management and Deployment bumpversion>=0.5.3 -watchdog>=0.8.3,<1.0.0 # pyup: ignore -twine>=1.9.1,<2.0.0 # pyup: ignore +watchdog>=0.8.3 +twine>=1.9.1 virtualenvwrapper>=4.8 virtualenv>=16.0.0 # required for tox 3.14.2 but not forced # Testing -tox>=2.9.1 +tox>=3.28.0 flake8>=3.6.0 coverage>=4.4.1 coveralls>=1.2.0 -pytest>=7.2.0 +pytest # handled in setup.py nose>=1.3.7 pluggy>=0.3.1 pylint>=1.7.4 -deepdiff>=3.3.0,<4.0 # pyup: ignore +deepdiff>=3.3.0 # Docs Sphinx>=1.6.3 diff --git a/setup.cfg b/setup.cfg index 98586a92..0287e4b9 100644 --- a/setup.cfg +++ b/setup.cfg @@ -13,9 +13,3 @@ replace = __version__ = '{new_version}' [bdist_wheel] universal = 1 - -[flake8] -exclude = docs - -[aliases] -test = pytest diff --git a/setup.py b/setup.py index 9a064d2a..1c6f923f 100644 --- a/setup.py +++ b/setup.py @@ -16,6 +16,15 @@ with open('requirements.txt') as reqs_file: requirements = reqs_file.read().splitlines() +tests_require=[ + 'pytest>=7.2.0;python_version>="3"', + 'pytest>=6,<4;python_version<"3"', +] + +extras_require={ + 'demo': ['docker>=2.5.1'] +} + setup( name='nipyapi', version=proj_version, @@ -31,9 +40,8 @@ ), include_package_data=True, install_requires=requirements, - extras_require={ - 'demo': ['docker>=2.5.1'] - }, + tests_require=tests_require, + extras_require=extras_require, license="Apache Software License 2.0", zip_safe=False, keywords=['nipyapi', 'nifi', 'api', 'wrapper'], diff --git a/tox.ini b/tox.ini index 7de5cb3f..4e41ce04 100644 --- a/tox.ini +++ b/tox.ini @@ -1,52 +1,46 @@ [tox] -envlist = python2, python3old, python3new, flake8, lint +envlist = py37, py312, flake8, lint -[travis] -python = - 3.7: python3old - 3.12: python3new - 2.7: python2 +[testenv] +deps = + -r{toxinidir}/requirements_dev.txt + -r{toxinidir}/requirements.txt + pytest + coverage +commands = + pip install -U pip + coverage run -m pytest + coverage report -m + coverage xml -o coverage-{envname}.xml -[flake8] -exclude = - nipyapi/registry - nipyapi/nifi - tests +[testenv:flake8] +deps = flake8 +commands = flake8 nipyapi --config={toxinidir}/tox.ini -v [testenv:lint] -basepython=python3 -deps= +deps = pylint pyflakes +commands = pylint nipyapi --rcfile={toxinidir}/pylintrc -commands= - pylint nipyapi --rcfile=pylintrc - -[testenv:flake8] -basepython=python3 -deps=flake8>=3 -commands= - flake8 --ignore=R0801,R0912,R0902,R0903,R1718,R0913,C0302 --exclude=nipyapi/registry,nipyapi/nifi,tests nipyapi +[flake8] +exclude = nipyapi/registry,nipyapi/nifi,tests,docs +max-line-length = 100 [coverage:run] -include = - # Include the NiPyApi code - nipyapi/* -omit = - # Do not include procedurally generated swagger clients, docs or demos - nipyapi/nifi/* +source = nipyapi +omit = nipyapi/registry/* + nipyapi/nifi/* nipyapi/demo/* - nipyapi/docs/* + tests/* -[testenv] -setenv = - PYTHONPATH = {toxinidir} -passenv = * -deps = - -r{toxinidir}/requirements_dev.txt - -r{toxinidir}/requirements.txt -commands = - pip install -U pip - coverage run -m pytest --basetemp={envtmpdir} -x --log-cli-level=WARNING - - coveralls +[coverage:report] +exclude_lines = + pragma: no cover + def __repr__ + if self.debug: + if __name__ == .__main__.: + raise NotImplementedError + pass + except ImportError: \ No newline at end of file From f2ccf64cb2ea7803961f137cc8aea0f51aa1cf28 Mon Sep 17 00:00:00 2001 From: Dan Chaffelson Date: Sun, 6 Oct 2024 19:57:49 +0000 Subject: [PATCH 10/11] set min version for ruamel.yaml for safety update devnotes with py2 manual testing deprecate removed models from nifi client docs --- docs/devnotes.rst | 11 +++- docs/nipyapi-docs/nipyapi.nifi.models.rst | 79 ----------------------- requirements.txt | 4 +- 3 files changed, 10 insertions(+), 84 deletions(-) diff --git a/docs/devnotes.rst b/docs/devnotes.rst index 139d6ce4..89c24944 100644 --- a/docs/devnotes.rst +++ b/docs/devnotes.rst @@ -48,10 +48,16 @@ Instructions:: I recommend you install PyEnv to manage Python versions `sudo curl https://pyenv.run | bash` Follow the instructions to set up your .bashrc To build various versions of Python for testing you may also need `sudo dnf install bzip2-devel openssl-devel libffi-devel zlib-devel readline-devel sqlite-devel -y` - Install the latest supported version of Python for your main dev environment `pyenv install 3.9 2.7` - Set these versions as global in pyenv so tox can see them. Use the actual versions with the command `pyenv global 3.9.16 2.7.62` + Install the latest supported version of Python for your main dev environment `pyenv install 3.9 2.7 3.12` + Set these versions as global in pyenv so tox can see them. Use the actual versions with the command `pyenv global 3.9.16 2.7.18 3.12.2` You'll want to stand up the two sets of NiFi containers for testing. resources/docker/tox-full for default and regression tests, and resources/docker/secure for tests under auth. You can switch between the tests by changing flags in tests/conftest.py around line 17. + Python3 can be tested automatically using Tox. + Python2 can be tested using the following steps within a Python2 virtualenv: + 1. Install requirements: pip install -r requirements.txt + 2. Install dev requirements: `pip install -r requirements_dev.txt` + 3. Install package in editable mode with test support: `pip install -e .[test]` + 4. Run tests: `pytest -v -s tests --tb=long -W ignore::urllib3.exceptions.InsecureRequestWarning` Setup Code Signing ------------------ @@ -194,7 +200,6 @@ This assumes you have virtualenvwrapper, git, and appropriate python versions in # Run appropriate tests, such as usage tests etc. deactivate Push changes to Github - Check build on TravisCI Check dockerhub automated build # You may have to reactivate your original virtualenv twine upload dist/* diff --git a/docs/nipyapi-docs/nipyapi.nifi.models.rst b/docs/nipyapi-docs/nipyapi.nifi.models.rst index 123ae321..f9a9c175 100644 --- a/docs/nipyapi-docs/nipyapi.nifi.models.rst +++ b/docs/nipyapi-docs/nipyapi.nifi.models.rst @@ -188,38 +188,6 @@ nipyapi.nifi.models.batch\_size module :undoc-members: :show-inheritance: -nipyapi.nifi.models.bucket module ---------------------------------- - -.. automodule:: nipyapi.nifi.models.bucket - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.bucket\_dto module --------------------------------------- - -.. automodule:: nipyapi.nifi.models.bucket_dto - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.bucket\_entity module ------------------------------------------ - -.. automodule:: nipyapi.nifi.models.bucket_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.buckets\_entity module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.buckets_entity - :members: - :undoc-members: - :show-inheritance: - nipyapi.nifi.models.bulletin\_board\_dto module ----------------------------------------------- @@ -1036,14 +1004,6 @@ nipyapi.nifi.models.peers\_entity module :undoc-members: :show-inheritance: -nipyapi.nifi.models.permissions module --------------------------------------- - -.. automodule:: nipyapi.nifi.models.permissions - :members: - :undoc-members: - :show-inheritance: - nipyapi.nifi.models.permissions\_dto module ------------------------------------------- @@ -1388,30 +1348,6 @@ nipyapi.nifi.models.queue\_size\_dto module :undoc-members: :show-inheritance: -nipyapi.nifi.models.registry\_client\_entity module ---------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.registry_client_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.registry\_clients\_entity module ----------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.registry_clients_entity - :members: - :undoc-members: - :show-inheritance: - -nipyapi.nifi.models.registry\_dto module ----------------------------------------- - -.. automodule:: nipyapi.nifi.models.registry_dto - :members: - :undoc-members: - :show-inheritance: - nipyapi.nifi.models.relationship\_dto module -------------------------------------------- @@ -1916,14 +1852,6 @@ nipyapi.nifi.models.versioned\_controller\_service module :undoc-members: :show-inheritance: -nipyapi.nifi.models.versioned\_flow module ------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_flow - :members: - :undoc-members: - :show-inheritance: - nipyapi.nifi.models.versioned\_flow\_coordinates module ------------------------------------------------------- @@ -1948,13 +1876,6 @@ nipyapi.nifi.models.versioned\_flow\_entity module :undoc-members: :show-inheritance: -nipyapi.nifi.models.versioned\_flow\_snapshot module ----------------------------------------------------- - -.. automodule:: nipyapi.nifi.models.versioned_flow_snapshot - :members: - :undoc-members: - :show-inheritance: nipyapi.nifi.models.versioned\_flow\_snapshot\_entity module ------------------------------------------------------------ diff --git a/requirements.txt b/requirements.txt index e0e77120..dd982363 100644 --- a/requirements.txt +++ b/requirements.txt @@ -19,8 +19,8 @@ requests[security]>=2.18 pysocks>=1.7.1 # Import Export and Utils implementation -ruamel.yaml<0.18; python_version < '3' -ruamel.yaml; python_version >= '3' +ruamel.yaml>=0.16.3,<0.18; python_version < '3' +ruamel.yaml>=0.16.3; python_version >= '3' # xml to json parsing xmltodict>=0.12.0 From 3010452669d7094e34a87b8bb55a86a961558750 Mon Sep 17 00:00:00 2001 From: Dan Chaffelson Date: Tue, 8 Oct 2024 14:02:46 +0100 Subject: [PATCH 11/11] Update NiPyAPI to be roughly forward compatible with NiFi-2.x line. (#368) * Instruct pyup to ignore pytest in requirements txt * instruct pytest to not report insecure http requests to localhost for docker testing * Templates are deprecated in nifi-2x, remove from tests for newer versions * add function to check registry version using newer aboutapi() call * update utils.check_version to ignore any non-semver elements of a version string and use newer registry version api call if available * Update registry client creation to handle nifi-2x structure * Update Testing to treat NiFI-2.x as regression target * Deprecate very old nifi-1x versions from regression testing * Fix get processor test to use a processor available in all nifi versions, GenerateFlowfile * Update readme about NiFi2.x support. * Switch 'latest' dockerfile to use 'latest' nifi tags. --- README.rst | 7 ++- nipyapi/canvas.py | 9 +-- nipyapi/system.py | 10 ++++ nipyapi/utils.py | 59 +++++++++----------- nipyapi/versioning.py | 26 +++++++-- requirements_dev.txt | 2 +- resources/docker/latest/docker-compose.yml | 4 +- resources/docker/secure/docker-compose.yml | 4 +- resources/docker/tox-full/docker-compose.yml | 48 +++++++--------- resources/docker/tox-full/readme.md | 8 +-- tests/conftest.py | 16 +++--- tests/test_canvas.py | 8 ++- tests/test_templates.py | 5 ++ tests/test_utils.py | 8 ++- tox.ini | 2 +- 15 files changed, 121 insertions(+), 95 deletions(-) diff --git a/README.rst b/README.rst index bf426770..154ab17e 100644 --- a/README.rst +++ b/README.rst @@ -96,7 +96,12 @@ Background and Documentation NiFi Version Support -------------------- -| Currently we are testing against NiFi versions 1.1.2 - 1.27.0, and NiFi-Registry versions 0.1.0 - 1.27.0. +| Currently we are testing against NiFi versions 1.9.2 - 1.27.0, and NiFi-Registry versions 0.3.0 - 1.27.0. + +| We have also tested against the latest 2.0.0-M4 release candidates using the 1.x SDK and have found that basic functionality works as expected. +| Apache NiFi offers no compatibility guarantees between major versions, and while many functions may work the same, you should test carefully for your specific use case. +| In future we will create a specific branch of NiPyAPI for NiFi 2.x SDKs, and maintain separate NiFi 1.x and NiFi 2.x clients. + | If you find a version compatibility problem please raise an `issue `_ Python Support diff --git a/nipyapi/canvas.py b/nipyapi/canvas.py index 03282297..67543fca 100644 --- a/nipyapi/canvas.py +++ b/nipyapi/canvas.py @@ -402,10 +402,11 @@ def delete_process_group(process_group, force=False, refresh=True): delete_controller(x, True) removed_controllers_id.append(x.component.id) - # Remove templates - for template in nipyapi.templates.list_all_templates(native=False): - if target.id == template.template.group_id: - nipyapi.templates.delete_template(template.id) + # Templates are not supported in NiFi 2.x + if nipyapi.utils.check_version('2', service='nifi') < 0: + for template in nipyapi.templates.list_all_templates(native=False): + if target.id == template.template.group_id: + nipyapi.templates.delete_template(template.id) # have to refresh revision after changes target = nipyapi.nifi.ProcessGroupsApi().get_process_group(pg_id) return nipyapi.nifi.ProcessGroupsApi().remove_process_group( diff --git a/nipyapi/system.py b/nipyapi/system.py index 2eba118f..53500d6c 100644 --- a/nipyapi/system.py +++ b/nipyapi/system.py @@ -58,3 +58,13 @@ def get_nifi_version_info(): """ diags = get_system_diagnostics() return diags.system_diagnostics.aggregate_snapshot.version_info + + +def get_registry_version_info(): + """ + Returns the version information of the connected NiFi Registry instance + + Returns (VersionInfoDTO): + """ + details = nipyapi.registry.AboutApi().get_version() + return details.registry_about_version diff --git a/nipyapi/utils.py b/nipyapi/utils.py index 6313f7a1..1f25f32b 100644 --- a/nipyapi/utils.py +++ b/nipyapi/utils.py @@ -8,7 +8,6 @@ from __future__ import absolute_import, unicode_literals import logging import json -import re import io import time from copy import copy @@ -479,17 +478,6 @@ def start_docker_containers(docker_containers, network_name='demo'): )) -def strip_snapshot(java_version): - """ - Strips the -SNAPSHOT suffix from a version string - - Args: - java_version (str): the version string - """ - assert isinstance(java_version, six.string_types) - return re.sub("-SNAPSHOT", "", java_version) - - def check_version(base, comparator=None, service='nifi', default_version='0.2.0'): """ @@ -511,36 +499,43 @@ def check_version(base, comparator=None, service='nifi', Returns (int): -1/0/1 if base is lower/equal/newer than comparator """ + + def strip_version_string(version_string): + # Reduces the string to only the major.minor.patch version + return '.'.join(version_string.split('-')[0].split('.')[:3]) + assert isinstance(base, six.string_types) assert comparator is None or isinstance(comparator, six.string_types) assert service in ['nifi', 'registry'] - ver_a = version.parse(base) + ver_a = version.parse(strip_version_string(base)) if comparator: - # if b is set, we compare the passed versions - comparator = strip_snapshot(comparator) - ver_b = version.parse(comparator) + ver_b = version.parse(strip_version_string(comparator)) elif service == 'registry': try: - config = nipyapi.config.registry_config - if config.api_client is None: - config.api_client = nipyapi.registry.ApiClient() - reg_swagger_def = config.api_client.call_api( - resource_path='/swagger/swagger.json', - method='GET', _preload_content=False, - auth_settings=['tokenAuth', 'Authorization'] - ) - reg_json = load(reg_swagger_def[0].data) - ver_b = version.parse(reg_json['info']['version']) + reg_ver = nipyapi.system.get_registry_version_info() + ver_b = version.parse(strip_version_string(reg_ver)) except nipyapi.registry.rest.ApiException: log.warning( - "Unable to get registry swagger.json, assuming version %s", - default_version) - ver_b = version.parse(default_version) + "Unable to get registry version, trying swagger.json") + try: + config = nipyapi.config.registry_config + if config.api_client is None: + config.api_client = nipyapi.registry.ApiClient() + reg_swagger_def = config.api_client.call_api( + resource_path='/swagger/swagger.json', + method='GET', _preload_content=False, + auth_settings=['tokenAuth', 'Authorization'] + ) + reg_json = load(reg_swagger_def[0].data) + ver_b = version.parse(reg_json['info']['version']) + except nipyapi.registry.rest.ApiException: + log.warning( + "Can't get registry swagger.json, assuming version %s", + default_version) + ver_b = version.parse(default_version) else: - # Working with NiFi ver_b = version.parse( - strip_snapshot( - # This call currently only supports NiFi + strip_version_string( nipyapi.system.get_nifi_version_info().ni_fi_version ) ) diff --git a/nipyapi/versioning.py b/nipyapi/versioning.py index 39de1fb0..3e3acc1f 100644 --- a/nipyapi/versioning.py +++ b/nipyapi/versioning.py @@ -27,7 +27,7 @@ log = logging.getLogger(__name__) -def create_registry_client(name, uri, description): +def create_registry_client(name, uri, description, reg_type=None): """ Creates a Registry Client in the NiFi Controller Services @@ -42,14 +42,28 @@ def create_registry_client(name, uri, description): assert isinstance(uri, six.string_types) and uri is not False assert isinstance(name, six.string_types) and name is not False assert isinstance(description, six.string_types) + if nipyapi.utils.check_version('2', service='nifi') > 0: + component = { + 'uri': uri, + 'name': name, + 'description': description + } + else: + component = { + 'name': name, + 'description': description, + 'type': ( + reg_type or + 'org.apache.nifi.registry.flow.NifiRegistryFlowRegistryClient'), + 'properties': { + 'url': uri + } + } + with nipyapi.utils.rest_exceptions(): return nipyapi.nifi.ControllerApi().create_flow_registry_client( body={ - 'component': { - 'uri': uri, - 'name': name, - 'description': description - }, + 'component': component, 'revision': { 'version': 0 } diff --git a/requirements_dev.txt b/requirements_dev.txt index 9e2533ad..c5e7e6a2 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -14,7 +14,7 @@ tox>=3.28.0 flake8>=3.6.0 coverage>=4.4.1 coveralls>=1.2.0 -pytest # handled in setup.py +pytest # pyup: ignore nose>=1.3.7 pluggy>=0.3.1 pylint>=1.7.4 diff --git a/resources/docker/latest/docker-compose.yml b/resources/docker/latest/docker-compose.yml index 4cc99853..bf8a0547 100644 --- a/resources/docker/latest/docker-compose.yml +++ b/resources/docker/latest/docker-compose.yml @@ -1,6 +1,6 @@ services: nifi: - image: apache/nifi:1.27.0 + image: apache/nifi:latest container_name: nifi hostname: nifi ports: @@ -9,7 +9,7 @@ services: - SINGLE_USER_CREDENTIALS_USERNAME=nobel - SINGLE_USER_CREDENTIALS_PASSWORD=supersecret1! registry: - image: apache/nifi-registry:1.27.0 + image: apache/nifi-registry:latest container_name: registry hostname: registry ports: diff --git a/resources/docker/secure/docker-compose.yml b/resources/docker/secure/docker-compose.yml index 364ad1fe..582faf21 100644 --- a/resources/docker/secure/docker-compose.yml +++ b/resources/docker/secure/docker-compose.yml @@ -1,6 +1,6 @@ services: secure-nifi: - image: apache/nifi:1.27.0 + image: apache/nifi:latest container_name: secure-nifi hostname: secure-nifi ports: @@ -25,7 +25,7 @@ services: - LDAP_URL=ldap://ldap.forumsys.com:389 - NIFI_WEB_PROXY_HOST=localhost:9443,localhost:8443 secure-registry: - image: apache/nifi-registry:1.27.0 + image: apache/nifi-registry:latest container_name: secure-registry hostname: secure-registry ports: diff --git a/resources/docker/tox-full/docker-compose.yml b/resources/docker/tox-full/docker-compose.yml index fbf47de6..b38a7182 100644 --- a/resources/docker/tox-full/docker-compose.yml +++ b/resources/docker/tox-full/docker-compose.yml @@ -1,30 +1,22 @@ services: - nifi-112: - image: chaffelson/nifi:1.1.2 - container_name: nifi-112 - hostname: nifi-112 - ports: - - "10112:8080" - nifi-120: - image: apache/nifi:1.2.0 - container_name: nifi-120 - hostname: nifi-120 - ports: - - "10120:8080" - nifi-180: - image: apache/nifi:1.8.0 - container_name: nifi-180 - hostname: nifi-180 - ports: - - "10180:8080" nifi-192: image: apache/nifi:1.9.2 container_name: nifi-192 hostname: nifi-192 ports: - "10192:8080" - nifi: + nifi-127: image: apache/nifi:1.27.0 + container_name: nifi-127 + hostname: nifi-127 + ports: + - "10127:10127" + environment: + - SINGLE_USER_CREDENTIALS_USERNAME=nobel + - SINGLE_USER_CREDENTIALS_PASSWORD=supersecret1! + - NIFI_WEB_HTTPS_PORT=10127 + nifi: + image: apache/nifi:2.0.0-M4 container_name: nifi hostname: nifi ports: @@ -32,14 +24,6 @@ services: environment: - SINGLE_USER_CREDENTIALS_USERNAME=nobel - SINGLE_USER_CREDENTIALS_PASSWORD=supersecret1! - registry-010: - image: apache/nifi-registry:0.1.0 - container_name: registry-010 - hostname: registry-010 - ports: - - "18010:18010" - environment: - - NIFI_REGISTRY_WEB_HTTP_PORT=18010 registry-030: image: apache/nifi-registry:0.3.0 container_name: registry-030 @@ -48,8 +32,16 @@ services: - "18030:18030" environment: - NIFI_REGISTRY_WEB_HTTP_PORT=18030 - registry: + registry-127: image: apache/nifi-registry:1.27.0 + container_name: registry-127 + hostname: registry-127 + ports: + - "18127:18127" + environment: + - NIFI_REGISTRY_WEB_HTTP_PORT=18127 + registry: + image: apache/nifi-registry:2.0.0-M4 container_name: registry hostname: registry ports: diff --git a/resources/docker/tox-full/readme.md b/resources/docker/tox-full/readme.md index 0e637607..8b029d3a 100644 --- a/resources/docker/tox-full/readme.md +++ b/resources/docker/tox-full/readme.md @@ -14,12 +14,6 @@ Stop a cluster: - ```docker-compose stop``` -## Environment Details - -- Apache NiFi 1.2.0 available on port 10120 -- Apache NiFi 1.4.0 available on port 10140 -- Apache NiFi 1.5.0 available on port 8080 -- Apache NiFi-Registry 0.1.0 available on port 18080 ### Notes -Where possible the latest version will be available on the defaul port, with older versions on identifiable ports for back testing +Where possible the latest version will be available on the default port, with older versions on identifiable ports for back testing diff --git a/tests/conftest.py b/tests/conftest.py index cf3e8ee7..e4f5730e 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -56,10 +56,8 @@ default_nifi_endpoints = [('https://' + test_host + ':8443/nifi-api', True, True, 'nobel', 'supersecret1!')] regress_nifi_endpoints = [ - ('http://' + test_host + ':10112/nifi-api', True, True, None, None), - ('http://' + test_host + ':10120/nifi-api', True, True, None, None), - ('http://' + test_host + ':10180/nifi-api', True, True, None, None), ('http://' + test_host + ':10192/nifi-api', True, True, None, None), + ('https://' + test_host + ':10127/nifi-api', True, True, 'nobel', 'supersecret1!'), ] secure_nifi_endpoints = [('https://' + test_host + ':9443/nifi-api', True, True, 'nobel', 'password')] default_registry_endpoints = [ @@ -69,13 +67,13 @@ ) ] regress_registry_endpoints = [ - (('http://' + test_host + ':18010/nifi-registry-api', True, True, None, None), - 'http://registry-010:18010', - ('https://' + test_host + ':8443/nifi-api', True, True, 'nobel', 'supersecret1!') - ), (('http://' + test_host + ':18030/nifi-registry-api', True, True, None, None), 'http://registry-030:18030', ('http://' + test_host + ':10192/nifi-api', True, True, None, None) + ), + (('http://' + test_host + ':18127/nifi-registry-api', True, True, None, None), + 'http://registry-127:18127', + ('https://' + test_host + ':10127/nifi-api', True, True, 'nobel', 'supersecret1!') ) ] secure_registry_endpoints = [ @@ -334,7 +332,9 @@ def cleanup_nifi(): # per test, so we rely on individual fixture cleanup log.info("Bulk cleanup called on host %s", nipyapi.config.nifi_config.host) - remove_test_templates() + # Check if NiFi version is 2 or newer + if nipyapi.utils.check_version('2', service='nifi') < 0: + remove_test_templates() remove_test_pgs() remove_test_connections() remove_test_controllers() diff --git a/tests/test_canvas.py b/tests/test_canvas.py index 970f0bfa..f606630a 100644 --- a/tests/test_canvas.py +++ b/tests/test_canvas.py @@ -178,8 +178,8 @@ def test_list_all_processor_types(regress_nifi): def test_get_processor_type(regress_nifi): - r1 = canvas.get_processor_type('GetTwitter') - assert r1.type == 'org.apache.nifi.processors.twitter.GetTwitter' + r1 = canvas.get_processor_type('GenerateFlowFile') + assert r1.type == 'org.apache.nifi.processors.standard.GenerateFlowFile' assert isinstance(r1, DocumentedTypeDTO) r2 = canvas.get_processor_type("syslog", 'tag') assert isinstance(r2, list) @@ -301,6 +301,8 @@ def test_update_processor(regress_nifi, fix_proc): def test_get_variable_registry(fix_pg): + if utils.check_version('2', service='nifi') <= 0: + pytest.skip("Not supported in NiFi 2.x") test_pg = fix_pg.generate() r1 = canvas.get_variable_registry(test_pg) assert isinstance(r1, nifi.VariableRegistryEntity) @@ -310,6 +312,8 @@ def test_get_variable_registry(fix_pg): def test_update_variable_registry(fix_pg): + if utils.check_version('2', service='nifi') <= 0: + pytest.skip("Not supported in NiFi 2.x") test_pg = fix_pg.generate() r1 = canvas.update_variable_registry( test_pg, diff --git a/tests/test_templates.py b/tests/test_templates.py index caec4504..760cf64d 100644 --- a/tests/test_templates.py +++ b/tests/test_templates.py @@ -15,6 +15,11 @@ elif six.PY2: pass +@pytest.fixture(scope="module", autouse=True) +def skip_if_nifi_version_2(): + if nipyapi.utils.check_version('2', service='nifi') >= 0: + pytest.skip("Skipping tests for NiFi version 2 and above") + def test_upload_template(regress_nifi, fix_templates): pg = fix_templates.pg.generate() diff --git a/tests/test_utils.py b/tests/test_utils.py index 755a86f8..043d7d7a 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -149,7 +149,7 @@ def test_check_version(regress_nifi): # base is newer than comp assert utils.check_version('1.2.3', '0.2.3') == 1 # Check RC - assert utils.check_version('1.0.0-rc1', '1.0.0') == -1 + assert utils.check_version('1.0.0-rc1', '1.0.0') == 0 # Check that snapshots are disregarded assert utils.check_version('1.11.0', '1.13.0-SNAPSHOT') == -1 assert utils.check_version('1.11.0', "1.11.0-SNAPSHOT") == 0 @@ -158,3 +158,9 @@ def test_check_version(regress_nifi): assert utils.check_version( system.get_nifi_version_info().ni_fi_version ) == 0 + # Check 2.0.0-M4 + assert utils.check_version('2.0.0-M4', '2', service='nifi') == 0 + assert utils.check_version('2', '2.0.0-M4') == 0 + # Check 2.x vs 1.x + assert utils.check_version('2.0.0-M4', '1.13.0') == 1 + assert utils.check_version('1.13.0', '2.0.0-M4') == -1 diff --git a/tox.ini b/tox.ini index 4e41ce04..ddc8435b 100644 --- a/tox.ini +++ b/tox.ini @@ -9,7 +9,7 @@ deps = coverage commands = pip install -U pip - coverage run -m pytest + coverage run -m pytest -W ignore -W ignore::urllib3.exceptions.InsecureRequestWarning coverage report -m coverage xml -o coverage-{envname}.xml