julee.api.routers.assembly_specifications

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

Functions

create_assembly_specification(request[, repository])

Create a new assembly specification.

get_assembly_specification([...])

Get a specific assembly specification by ID.

get_assembly_specifications([repository])

Get a paginated list of assembly specifications.

Module Contents

async julee.api.routers.assembly_specifications.create_assembly_specification(request, repository=Depends(get_assembly_specification_repository))[source]

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.

Parameters:
Returns:

The created specification with generated ID and

timestamps

Return type:

AssemblySpecification

async julee.api.routers.assembly_specifications.get_assembly_specification(assembly_specification_id=Path(description='The ID of the assembly specification to retrieve'), repository=Depends(get_assembly_specification_repository))[source]

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.

Parameters:

assembly_specification_id (str) – The unique ID of the specification

Returns:

The requested specification

Return type:

AssemblySpecification

Raises:

HTTPException – 404 if specification not found, 500 for other errors

async julee.api.routers.assembly_specifications.get_assembly_specifications(repository=Depends(get_assembly_specification_repository))[source]

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

Return type:

Page[AssemblySpecification]

julee.api.routers.assembly_specifications.logger[source]
julee.api.routers.assembly_specifications.router[source]