Skip to content

namespaces

FastAPI endpoint functions for managing namespace resources.

Attributes

RESOURCE_NAMESPACES module-attribute 

RESOURCE_NAMESPACES = 'Namespaces'

namespaces_router module-attribute 

namespaces_router = APIRouter(
    prefix=format_path(RESOURCE_NAMESPACES),
    tags=[RESOURCE_NAMESPACES],
    responses=DEFAULT_HTTP_ERROR_RESPONSES,
)

Classes

Functions

create_namespace async 

create_namespace(
    fastapi_request: Request,
    request: NamespaceCreateRequestV1,
    job_pool: ThreadPoolExecutor = Depends(
        job_pool_dependency
    ),
)

Create a new namespace resource

get_namespace async 

get_namespace(
    fastapi_request: Request,
    namespace: str = namespace_path_param,
    job_pool: ThreadPoolExecutor = Depends(
        job_pool_dependency
    ),
)

Get a namespace resource

list_namespaces async 

list_namespaces(
    fastapi_request: Request,
    include_deleted: bool = Query(
        False,
        description="Include deleted namespaces in the response",
    ),
    job_pool: ThreadPoolExecutor = Depends(
        job_pool_dependency
    ),
)

List all namespace resources

soft_delete_namespace async 

soft_delete_namespace(
    fastapi_request: Request,
    namespace: str = namespace_path_param,
    job_pool: ThreadPoolExecutor = Depends(
        job_pool_dependency
    ),
)

Soft delete a namespace resource

undelete_namespace async 

undelete_namespace(
    fastapi_request: Request,
    namespace: str = namespace_path_param,
    job_pool: ThreadPoolExecutor = Depends(
        job_pool_dependency
    ),
)

Undeletes a namespace resource

update_namespace async 

update_namespace(
    fastapi_request: Request,
    request: NamespaceUpdateRequestV1,
    namespace: str = namespace_path_param,
    job_pool: ThreadPoolExecutor = Depends(
        job_pool_dependency
    ),
)

Update a namespace resource