API Documentation
=================

This is the Camayoc API documentation. It is mostly auto generated from the
source code. This section of the documentation should be treated as a handy
reference for developers, not a gospel.

.. toctree::

    api/camayoc
    api/camayoc.api
    api/camayoc.command
    api/camayoc.config
    api/camayoc.constants
    api/camayoc.data_provider
    api/camayoc.exceptions
    api/camayoc.qpc_models
    api/camayoc.tests
    api/camayoc.tests.conftest
    api/camayoc.tests.qpc
    api/camayoc.tests.qpc.api
    api/camayoc.tests.qpc.api.v1
    api/camayoc.tests.qpc.api.v1.authentication
    api/camayoc.tests.qpc.api.v1.authentication.test_login
    api/camayoc.tests.qpc.api.v1.conftest
    api/camayoc.tests.qpc.api.v1.credentials
    api/camayoc.tests.qpc.api.v1.credentials.test_creds_common
    api/camayoc.tests.qpc.api.v1.credentials.test_manager_creds
    api/camayoc.tests.qpc.api.v1.credentials.test_network_creds
    api/camayoc.tests.qpc.api.v1.reports
    api/camayoc.tests.qpc.api.v1.reports.test_reports
    api/camayoc.tests.qpc.api.v1.scanjobs
    api/camayoc.tests.qpc.api.v1.scanjobs.test_pause_cancel_restart
    api/camayoc.tests.qpc.api.v1.scanjobs.test_run_scanjobs
    api/camayoc.tests.qpc.api.v1.scans
    api/camayoc.tests.qpc.api.v1.scans.test_scans_common
    api/camayoc.tests.qpc.api.v1.sources
    api/camayoc.tests.qpc.api.v1.sources.test_manager_sources
    api/camayoc.tests.qpc.api.v1.sources.test_network_sources
    api/camayoc.tests.qpc.api.v1.sources.test_sources_common
    api/camayoc.tests.qpc.api.v1.utils
    api/camayoc.tests.qpc.cli
    api/camayoc.tests.qpc.cli.conftest
    api/camayoc.tests.qpc.cli.csv_report_parsing
    api/camayoc.tests.qpc.cli.test_credentials
    api/camayoc.tests.qpc.cli.test_openshift
    api/camayoc.tests.qpc.cli.test_reports
    api/camayoc.tests.qpc.cli.test_scanjobs
    api/camayoc.tests.qpc.cli.test_scans
    api/camayoc.tests.qpc.cli.test_sources
    api/camayoc.tests.qpc.cli.utils
    api/camayoc.tests.qpc.conftest
    api/camayoc.tests.qpc.ui
    api/camayoc.tests.qpc.ui.conftest
    api/camayoc.tests.qpc.ui.test_credentials
    api/camayoc.tests.qpc.ui.test_login
    api/camayoc.tests.qpc.ui.test_long_running
    api/camayoc.tests.qpc.ui.test_sources
    api/camayoc.tests.qpc.ui.utils
    api/camayoc.tests.qpc.ui.views
    api/camayoc.tests.qpc.utils
    api/camayoc.tests.utils
    api/camayoc.types
    api/camayoc.types.settings
    api/camayoc.ui
    api/camayoc.ui.client
    api/camayoc.ui.decorators
    api/camayoc.ui.enums
    api/camayoc.ui.models
    api/camayoc.ui.models.fields
    api/camayoc.ui.models.mixins
    api/camayoc.ui.models.pages
    api/camayoc.ui.models.pages.abstract_page
    api/camayoc.ui.models.pages.credentials
    api/camayoc.ui.models.pages.login
    api/camayoc.ui.models.pages.scans
    api/camayoc.ui.models.pages.sources
    api/camayoc.ui.session
    api/camayoc.ui.types
    api/camayoc.utils
    api/tests
    api/tests.test_api
    api/tests.test_command
    api/tests.test_data_provider
    api/tests.test_settings
    api/tests.test_utils