diff --git a/doc/sphinx/_doclib/database.rst b/doc/sphinx/_doclib/database.rst index 6117dabf7cb430112a1619f36cdac180e544088b..7d02105b6606fe6c777585b51a09ebe90341539f 100644 --- a/doc/sphinx/_doclib/database.rst +++ b/doc/sphinx/_doclib/database.rst @@ -61,9 +61,7 @@ Following options were changed in the main configuration file ``/etc/postgresql/ # Original default value 'localtime' timezone = 'UTC' -* Timezone must be set to UTC to enable proper time based searching. All timestamps -are converted to UTC prior to storing to database and stored without the timezone -information according to PostgreSQL best practices. +* Timezone must be set to UTC to enable proper time based searching. All timestamps are converted to UTC prior to storing to database and stored without the timezone information according to PostgreSQL best practices. .. code-block:: shell diff --git a/doc/sphinx/_doclib/development.rst b/doc/sphinx/_doclib/development.rst index 8c35c4c2b811087e928d5e4a3b2ee6b6c29f687a..d41b0a7e242989ff12748d9916178de0202ae791 100644 --- a/doc/sphinx/_doclib/development.rst +++ b/doc/sphinx/_doclib/development.rst @@ -526,12 +526,12 @@ Important resources: * `Alembic <https://alembic.sqlalchemy.org/en/latest/index.html>`__ * `Flask-Migrate <https://flask-migrate.readthedocs.io/en/latest/>`__ -Creating new database migration:: +Creating new database migration: -1. Perform requested changes in ``lib/mentat/datatype/sqldb.py`` and ``lib/mentat/datatype/test_sqldb.py`` -2. Execute ``hawat-cli db migrate`` to autogenerate migration script -3. Review and update autogenerated migration script in ``lib/hawat/migrations/versions`` directory -4. Execute ``hawat-cli db upgrade`` aply locally your migration +#. Perform requested changes in ``lib/mentat/datatype/sqldb.py`` and ``lib/mentat/datatype/test_sqldb.py`` +#. Execute ``hawat-cli db migrate`` to autogenerate migration script +#. Review and update autogenerated migration script in ``lib/hawat/migrations/versions`` directory +#. Execute ``hawat-cli db upgrade`` aply locally your migration Versioning diff --git a/doc/sphinx/_doclib/hawat.rst b/doc/sphinx/_doclib/hawat.rst index 6f1ebc52eb03a29ebd3a3bf306ad55b489ab453c..d85aacc732a58c0aeecbb57cfec8008ecb70b472 100644 --- a/doc/sphinx/_doclib/hawat.rst +++ b/doc/sphinx/_doclib/hawat.rst @@ -73,7 +73,7 @@ configuration options: ENABLED_BLUEPRINTS = [ 'hawat.blueprints.auth_api', 'hawat.blueprints.auth_env', - 'hawat.blueprints.design', + 'hawat.blueprints.design_bs3', 'hawat.blueprints.home', 'hawat.blueprints.reports', 'hawat.blueprints.events', diff --git a/doc/sphinx/_doclib/hawat_plugin_design.rst b/doc/sphinx/_doclib/hawat_plugin_design.rst index 3a5e247f61bd8fa3661701e9dc20920c38c7d8de..9b9b09cbe8f9beda45af75e47c264b10fd31df8e 100644 --- a/doc/sphinx/_doclib/hawat_plugin_design.rst +++ b/doc/sphinx/_doclib/hawat_plugin_design.rst @@ -1,7 +1,7 @@ .. _section-hawat-plugin-design: -design +design_bs3 ================================================================================ -.. automodule:: hawat.blueprints.design +.. automodule:: hawat.blueprints.design_bs3 :noindex: diff --git a/doc/sphinx/_doclib/hawat_plugin_help.rst b/doc/sphinx/_doclib/hawat_plugin_help.rst deleted file mode 100644 index 1350e45c635ac9f1000419295536cdbd204b6e40..0000000000000000000000000000000000000000 --- a/doc/sphinx/_doclib/hawat_plugin_help.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _section-hawat-plugin-help: - -help -================================================================================ - -.. automodule:: hawat.blueprints.help - :noindex: diff --git a/doc/sphinx/_doclib/hawat_plugin_pdnsr.rst b/doc/sphinx/_doclib/hawat_plugin_pdnsr.rst index 9bb5b098357726ae2456f22391562f7493250599..106ebd8c3fdbeed6bb4c4d4f1d68b84033bda79c 100644 --- a/doc/sphinx/_doclib/hawat_plugin_pdnsr.rst +++ b/doc/sphinx/_doclib/hawat_plugin_pdnsr.rst @@ -1,7 +1,7 @@ -.. _section-hawat-plugin-networks: +.. _section-hawat-plugin-pdnsr: -networks +pdnsr ================================================================================ -.. automodule:: hawat.blueprints.networks +.. automodule:: hawat.blueprints.pdnsr :noindex: diff --git a/doc/sphinx/_doclib/hawat_plugin_reports.rst b/doc/sphinx/_doclib/hawat_plugin_reports.rst index c0bfcf65986c934f1c5218ee0ff65cb8c8a367fb..2932194f96f0ed15dc91cee752671bb141794abc 100644 --- a/doc/sphinx/_doclib/hawat_plugin_reports.rst +++ b/doc/sphinx/_doclib/hawat_plugin_reports.rst @@ -161,9 +161,3 @@ following keys: .. code-block:: shell $ curl -X POST -d "api_key=your%AP1_k3y" "https://.../api/reports/dashboard?submit=Search" - -.. note:: - - Please be aware, that this endpoint provides raw statistical dataset. The :ref:`section-hawat-plugin-reports-features-dashboard` - endpoint performs some additional client-side processing with JavaScript to transform - datasets provided by this endpoint into format appropriate for chart and table rendering. diff --git a/doc/sphinx/_doclib/hawat_plugin_timeline.rst b/doc/sphinx/_doclib/hawat_plugin_timeline.rst index c53015e417642fff11e0ec7c7d334d27e6a12f8f..bada095e8ba1682c4be4d5c594a68733752e2891 100644 --- a/doc/sphinx/_doclib/hawat_plugin_timeline.rst +++ b/doc/sphinx/_doclib/hawat_plugin_timeline.rst @@ -317,7 +317,7 @@ following keys: * *Description:* This subkey is present in case search was successfull. It contains list of all aggregations that were actually performed. * *Datatype:* ``list`` - * *Default: ``["categories", "ips", "source_ports", "target_ports", "source_types", "target_types", "protocols", "detectors", "detector_types", "abuses", "classes", "severities"]`` + * *Default*: ``["categories", "ips", "source_ports", "target_ports", "source_types", "target_types", "protocols", "detectors", "detector_types", "abuses", "classes", "severities"]`` ``form_data`` * *Description:* This subkey is present in case search operation was triggered. diff --git a/lib/hawat/base.py b/lib/hawat/base.py index a6e1b164322f2f3d394e4d44964ca46c1b750195..e5183050ae2e6c8b576ebe8fa15f673f525335a7 100644 --- a/lib/hawat/base.py +++ b/lib/hawat/base.py @@ -340,7 +340,7 @@ class HawatApp(flask.Flask): Send emails through all registered infomailer handles. :param str name: Name of the informailer. - :param **kwargs: Additional mailer arguments. + :param kwargs: Additional mailer arguments. """ for mailer in self.infomailers[name]: mailer(**kwargs) diff --git a/lib/hawat/blueprints/timeline/__init__.py b/lib/hawat/blueprints/timeline/__init__.py index 2034151c9fd939d4383c25eafe6fea20cfd59c43..98cb7e0b7bf8ebeb23e5191694f73b5997770c1f 100644 --- a/lib/hawat/blueprints/timeline/__init__.py +++ b/lib/hawat/blueprints/timeline/__init__.py @@ -419,7 +419,7 @@ class APILegacySearchView(AJAXMixin, AbstractSearchView): # pylint: disable=loc View responsible for querying `IDEA <https://idea.cesnet.cz/en/index>`__ event database and presenting the results in the form of JSON document. - *Deprecated legacy implementation, kept only for the purposes of comparison. + *Deprecated legacy implementation, kept only for the purposes of comparison.* """ methods = ['GET', 'POST'] diff --git a/lib/mentat/idea/internal.py b/lib/mentat/idea/internal.py index 733c0b38e36d0a57c6482343cc62372aae403f78..e2d8836ba2cd4a81dab8d4adbad3382bfb6fb833 100644 --- a/lib/mentat/idea/internal.py +++ b/lib/mentat/idea/internal.py @@ -210,7 +210,7 @@ class Idea(idea.lite.Idea): # pylint: disable=locally-disabled,too-many-ancesto """ Convenience method for returning the correct custom key. - :return: The value of _Mentat if present, otherwise the value of _CESNET if present. + :return: The value of _Mentat if present, otherwise the value of _CESNET if present. \ If neither of those keys exist then empty dictionary is returned. :rtype: mentat_dict """ diff --git a/lib/mentat/services/whois.py b/lib/mentat/services/whois.py index 41712e4aadb6802acb357231255cd9473b7031ba..3ec2549e73efc19dda65ceff9203ec273de7f367 100644 --- a/lib/mentat/services/whois.py +++ b/lib/mentat/services/whois.py @@ -272,7 +272,7 @@ class SqldbWhoisModule(WhoisModule): class WhoisService: """ Implementation of more complex whois service capable of encapsulating multiple - :py:class:`mentat.services.whois.WhoisModule`s. + instances of :py:class:`mentat.services.whois.WhoisModule`. """ def __init__(self, modules = None):