API Package
===========

This document contains all the documentation for the package ``topchef.api``.
The purpose of this package is to implement all the HTTP endpoints, and map
all the HTTP requests to the business logic needed to fulfill them.

Abstract Endpoints
------------------

Abstract Endpoint
~~~~~~~~~~~~~~~~~

.. automodule:: topchef.api.abstract_endpoints.abstract_endpoint
    :members:
    :private-members:
    :special-members:
    :exclude-members: __dict__, __weakref__, __module__

Endpoint for Service
~~~~~~~~~~~~~~~~~~~~

.. automodule:: topchef.api.abstract_endpoints.endpoint_for_service
    :members:
    :private-members:
    :special-members:
    :exclude-members: __dict__, __weakref__, __module__

API Metadata
------------

.. automodule:: topchef.api.api_metadata
    :members:
    :private-members:
    :special-members:
    :exclude-members: __dict__, __weakref__, __module__

Service List
------------

.. automodule:: topchef.api.services_list
    :members:
    :private-members:
    :special-members:
    :exclude-members: __dict__, __weakref__, __module__

Service Details
---------------

.. automodule:: topchef.api.service_detail
    :members:
    :private-members:
    :special-members:
    :exclude-members: __dict__, __weakref__, __module__

Service Queue
-------------

.. automodule:: topchef.api.job_queue
    :members:
    :private-members:
    :special-members:
    :exclude-members: __dict__, __weakref__, __module__

Jobs For Service
----------------

.. automodule:: topchef.api.jobs_for_service
    :members:
    :private-members:
    :special-members:
    :exclude-members: __dict__, __weakref__, __module__

Job List
--------

.. automodule:: topchef.api.jobs_list
    :members:
    :private-members:
    :special-members:
    :exclude-members: __dict__, __weakref__, __module__