@knora/api
Version:
JavaScript library that handles API requests to Knora
22 lines (21 loc) • 886 B
TypeScript
import { Observable } from "rxjs";
import { ApiResponseError } from "../../../models/api-response-error";
import { OntologiesMetadata } from "../../../models/v2/ontologies/ontology-metadata";
import { ReadOntology } from "../../../models/v2/ontologies/read-ontology";
import { Endpoint } from "../../endpoint";
/**
* Handles requests to the ontologies route of the Knora API.
*/
export declare class OntologiesEndpoint extends Endpoint {
/**
* Requests metadata about all ontologies from Knora.
*/
getOntologiesMetadata(): Observable<OntologiesMetadata | ApiResponseError>;
/**
* Requests an ontology from Knora and converts it to a `ReadOntology`.
*
* @param ontologyIri the IRI of the ontology to be requested.
* @return the ontology or an error.
*/
getOntology(ontologyIri: string): Observable<ReadOntology | ApiResponseError>;
}