Skip to content

ontocast.api.ontologies

Ontology list, upload, replace, and delete routes.

Classes

Functions:

build_ontology_router(tools, *, active_tenant, active_project, server_config)

Source code in ontocast/api/ontologies.py 
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
def build_ontology_router(
    tools: ToolBox,
    *,
    active_tenant: str,
    active_project: str,
    server_config: ServerConfig,
) -> APIRouter:
    router = APIRouter(prefix="/ontologies", tags=["ontologies"])

    apply_ontology_tenancy = make_scoped_toolbox_resolver(
        tools,
        active_tenant=active_tenant,
        active_project=active_project,
        server_config=server_config,
    )

    @router.get(
        "",
        response_model=OntologyListResponse,
        summary="List the current version of every catalog ontology",
    )
    async def list_ontologies(request: Request) -> OntologyListResponse:
        scoped = await apply_ontology_tenancy(request)
        headers = dedupe_terminal_ontologies(
            await scoped.ontology_manager.aget_catalog_headers()
        )
        return OntologyListResponse(
            ontologies=[
                OntologySummary(
                    iri=header.iri,
                    ontology_id=header.ontology_id,
                    title=header.title,
                    description=header.description,
                    version=header.version,
                    hash=header.hash,
                )
                for header in sorted(headers, key=lambda header: header.iri)
            ]
        )

    @router.post(
        "",
        response_model=OntologyMutationResponse,
        summary="Upload an ontology (Turtle)",
    )
    async def upload_ontology(
        request: Request,
        file: UploadFile = File(...),
    ) -> OntologyMutationResponse:
        scoped = await apply_ontology_tenancy(request)
        ttl = await file.read()
        try:
            o = await scoped.ingest_ontology_ttl(ttl, filename=file.filename)
        except ValueError as e:
            raise HTTPException(status_code=400, detail=str(e)) from e
        return OntologyMutationResponse(
            iri=o.iri,
            ontology_id=o.ontology_id,
            version=o.version,
            hash=o.hash,
        )

    @router.put(
        "/{ontology_iri:path}",
        response_model=OntologyMutationResponse,
        summary="Replace an ontology by IRI (path segment, URL-encoded)",
    )
    async def replace_ontology(
        request: Request,
        ontology_iri: str,
        file: UploadFile = File(...),
    ) -> OntologyMutationResponse:
        scoped = await apply_ontology_tenancy(request)
        expected = unquote(ontology_iri)
        ttl = await file.read()
        try:
            graph = RDFGraph()
            graph.parse(BytesIO(ttl), format="turtle")
            parsed = Ontology(graph=graph)
        except Exception as e:
            raise HTTPException(status_code=400, detail=f"Invalid Turtle: {e}") from e
        if not parsed.iri or parsed.iri != expected:
            raise HTTPException(
                status_code=400,
                detail=(
                    f"Ontology IRI {parsed.iri!r} does not match path {expected!r}"
                ),
            )
        try:
            await scoped.delete_ontology_by_iri(expected)
        except ValueError as e:
            raise HTTPException(status_code=400, detail=str(e)) from e
        try:
            o = await scoped.ingest_ontology_ttl(ttl, filename=file.filename)
        except ValueError as e:
            raise HTTPException(status_code=400, detail=str(e)) from e
        return OntologyMutationResponse(
            iri=o.iri,
            ontology_id=o.ontology_id,
            version=o.version,
            hash=o.hash,
        )

    @router.delete(
        "/{ontology_iri:path}",
        response_model=OntologyDeleteResponse,
        summary="Remove an ontology by IRI",
    )
    async def delete_ontology_route(
        request: Request,
        ontology_iri: str,
    ) -> OntologyDeleteResponse:
        scoped = await apply_ontology_tenancy(request)
        iri = unquote(ontology_iri)
        try:
            await scoped.delete_ontology_by_iri(iri)
        except ValueError as e:
            raise HTTPException(status_code=400, detail=str(e)) from e
        return OntologyDeleteResponse(iri=iri)

    return router