julee.api.routers.assembly_specifications
=========================================

.. py:module:: julee.api.routers.assembly_specifications

.. autoapi-nested-parse::

   Assembly Specifications API router for the julee CEAP system.

   This module provides the API endpoints for assembly specifications,
   which define how to assemble documents of specific types including
   JSON schemas and knowledge service query configurations.

   Routes defined at root level:
   - GET / - List assembly specifications (paginated)
   - GET /{id} - Get a specific assembly specification by ID

   These routes are mounted at /assembly_specifications in the main app.



Attributes
----------

.. autoapisummary::

   julee.api.routers.assembly_specifications.logger
   julee.api.routers.assembly_specifications.router


Functions
---------

.. autoapisummary::

   julee.api.routers.assembly_specifications.create_assembly_specification
   julee.api.routers.assembly_specifications.get_assembly_specification
   julee.api.routers.assembly_specifications.get_assembly_specifications


Module Contents
---------------

.. py:function:: create_assembly_specification(request, repository = Depends(get_assembly_specification_repository))
   :async:


   Create a new assembly specification.

   This endpoint creates a new assembly specification that defines how to
   assemble documents of specific types, including JSON schemas and
   knowledge service query configurations.

   :param request: The assembly specification creation request
   :param repository: Injected repository for persistence

   :returns:

             The created specification with generated ID and
                 timestamps
   :rtype: AssemblySpecification


.. py:function:: get_assembly_specification(assembly_specification_id = Path(description='The ID of the assembly specification to retrieve'), repository = Depends(get_assembly_specification_repository))
   :async:


   Get a specific assembly specification by ID.

   This endpoint retrieves a single assembly specification by its unique
   identifier. The specification contains the JSON schema and knowledge
   service query configurations needed for document assembly.

   :param assembly_specification_id: The unique ID of the specification

   :returns: The requested specification
   :rtype: AssemblySpecification

   :raises HTTPException: 404 if specification not found, 500 for other errors


.. py:function:: get_assembly_specifications(repository = Depends(get_assembly_specification_repository))
   :async:


   Get a paginated list of assembly specifications.

   This endpoint returns all assembly specifications in the system
   with pagination support. Each specification contains the configuration
   needed to define how to assemble documents of specific types.

   :returns: Paginated list of specifications
   :rtype: Page[AssemblySpecification]


.. py:data:: logger

.. py:data:: router