.. _api_index:

=============
API Reference
=============

The API Reference page provides detailed information about each API
interface, including its purpose, required parameters, optional parameters,
and expected response format.


Interface
---------

.. autofunction:: pysast.is_rule_file

.. autofunction:: pysast.get_mime_type

.. autofunction:: pysast.extract_filter_keys

.. autofunction:: pysast.load_sast_rules

.. autofunction:: pysast.run


Classes
-------

.. autoclass:: pysast.FileFilter
    :members:

.. autoclass:: pysast.SupportsFilter
    :members:

.. autoclass:: pysast.SastPattern
    :members:

.. autoclass:: pysast.SastRule
    :members:

.. autoclass:: pysast.SastContext
    :members:

.. autoclass:: pysast.SastScanner
    :members: