@geoengine/openapi-client

v0.0.29

Published

21 days ago

OpenAPI client for @geoengine/openapi-client

Downloads

685

0High
0Medium
0Low

christianbeilschmidt

@geoengine/[email protected]

A TypeScript SDK client for the geoengine.io API.

Usage

First, install the SDK from npm.

npm install @geoengine/openapi-client --save

Next, try it out.

import {
  Configuration,
  DatasetsApi,
} from '@geoengine/openapi-client';
import type { AutoCreateDatasetHandlerRequest } from '@geoengine/openapi-client';

async function example() {
  console.log("🚀 Testing @geoengine/openapi-client SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: session_token
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new DatasetsApi(config);

  const body = {
    // AutoCreateDataset
    autoCreateDataset: ...,
  } satisfies AutoCreateDatasetHandlerRequest;

  try {
    const data = await api.autoCreateDatasetHandler(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://geoengine.io/api

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- DatasetsApi | autoCreateDatasetHandler | POST /dataset/auto | Creates a new dataset using previously uploaded files. The format of the files will be automatically detected when possible. DatasetsApi | createDatasetHandler | POST /dataset | Creates a new dataset referencing files. Users can reference previously uploaded files. Admins can reference files from a volume. DatasetsApi | deleteDatasetHandler | DELETE /dataset/{dataset} | Delete a dataset DatasetsApi | getDatasetHandler | GET /dataset/{dataset} | Retrieves details about a dataset using the internal name. DatasetsApi | getLoadingInfoHandler | GET /dataset/{dataset}/loadingInfo | Retrieves the loading information of a dataset DatasetsApi | listDatasetsHandler | GET /datasets | Lists available datasets. DatasetsApi | listVolumeFileLayersHandler | GET /dataset/volumes/{volume_name}/files/{file_name}/layers | List the layers of a file in a volume. DatasetsApi | listVolumesHandler | GET /dataset/volumes | Lists available volumes. DatasetsApi | suggestMetaDataHandler | POST /dataset/suggest | Inspects an upload and suggests metadata that can be used when creating a new dataset based on it. Tries to automatically detect the main file and layer name if not specified. DatasetsApi | updateDatasetHandler | POST /dataset/{dataset} | Update details about a dataset using the internal name. DatasetsApi | updateDatasetProvenanceHandler | PUT /dataset/{dataset}/provenance | DatasetsApi | updateDatasetSymbologyHandler | PUT /dataset/{dataset}/symbology | Updates the dataset's symbology DatasetsApi | updateLoadingInfoHandler | PUT /dataset/{dataset}/loadingInfo | Updates the dataset's loading info GeneralApi | availableHandler | GET /available | Server availablity check. GeneralApi | serverInfoHandler | GET /info | Shows information about the server software version. LayersApi | addCollection | POST /layerDb/collections/{collection}/collections | Add a new collection to an existing collection LayersApi | addExistingCollectionToCollection | POST /layerDb/collections/{parent}/collections/{collection} | Add an existing collection to a collection LayersApi | addExistingLayerToCollection | POST /layerDb/collections/{collection}/layers/{layer} | Add an existing layer to a collection LayersApi | addLayer | POST /layerDb/collections/{collection}/layers | Add a new layer to a collection LayersApi | addProvider | POST /layerDb/providers | Add a new provider LayersApi | autocompleteHandler | GET /layers/collections/search/autocomplete/{provider}/{collection} | Autocompletes the search on the contents of the collection of the given provider LayersApi | deleteProvider | DELETE /layerDb/providers/{provider} | Delete an existing provider LayersApi | getProviderDefinition | GET /layerDb/providers/{provider} | Get an existing provider's definition LayersApi | layerHandler | GET /layers/{provider}/{layer} | Retrieves the layer of the given provider LayersApi | layerToDataset | POST /layers/{provider}/{layer}/dataset | Persist a raster layer from a provider as a dataset. LayersApi | layerToWorkflowIdHandler | POST /layers/{provider}/{layer}/workflowId | Registers a layer from a provider as a workflow and returns the workflow id LayersApi | listCollectionHandler | GET /layers/collections/{provider}/{collection} | List the contents of the collection of the given provider LayersApi | listProviders | GET /layerDb/providers | List all providers LayersApi | listRootCollectionsHandler | GET /layers/collections | List all layer collections LayersApi | providerCapabilitiesHandler | GET /layers/{provider}/capabilities | LayersApi | removeCollection | DELETE /layerDb/collections/{collection} | Remove a collection LayersApi | removeCollectionFromCollection | DELETE /layerDb/collections/{parent}/collections/{collection} | Delete a collection from a collection LayersApi | removeLayer | DELETE /layerDb/layers/{layer} | Remove a collection LayersApi | removeLayerFromCollection | DELETE /layerDb/collections/{collection}/layers/{layer} | Remove a layer from a collection LayersApi | searchHandler | GET /layers/collections/search/{provider}/{collection} | Searches the contents of the collection of the given provider LayersApi | updateCollection | PUT /layerDb/collections/{collection} | Update a collection LayersApi | updateLayer | PUT /layerDb/layers/{layer} | Update a layer LayersApi | updateProviderDefinition | PUT /layerDb/providers/{provider} | Update an existing provider's definition MLApi | addMlModel | POST /ml/models | Create a new ml model. MLApi | getMlModel | GET /ml/models/{model_name} | Get ml model by name. MLApi | listMlModels | GET /ml/models | List ml models. OGCWCSApi | wcsCapabilitiesHandler | GET /wcs/{workflow}?request=GetCapabilities | Get WCS Capabilities OGCWCSApi | wcsDescribeCoverageHandler | GET /wcs/{workflow}?request=DescribeCoverage | Get WCS Coverage Description OGCWCSApi | wcsGetCoverageHandler | GET /wcs/{workflow}?request=GetCoverage | Get WCS Coverage OGCWFSApi | wfsCapabilitiesHandler | GET /wfs/{workflow}?request=GetCapabilities | Get WFS Capabilities OGCWFSApi | wfsFeatureHandler | GET /wfs/{workflow}?request=GetFeature | Get WCS Features OGCWMSApi | wmsCapabilitiesHandler | GET /wms/{workflow}?request=GetCapabilities | Get WMS Capabilities OGCWMSApi | wmsLegendGraphicHandler | GET /wms/{workflow}?request=GetLegendGraphic | Get WMS Legend Graphic OGCWMSApi | wmsMapHandler | GET /wms/{workflow}?request=GetMap | Get WMS Map PermissionsApi | addPermissionHandler | PUT /permissions | Adds a new permission. PermissionsApi | getResourcePermissionsHandler | GET /permissions/resources/{resource_type}/{resource_id} | Lists permission for a given resource. PermissionsApi | removePermissionHandler | DELETE /permissions | Removes an existing permission. PlotsApi | getPlotHandler | GET /plot/{id} | Generates a plot. ProjectsApi | createProjectHandler | POST /project | Create a new project for the user. ProjectsApi | deleteProjectHandler | DELETE /project/{project} | Deletes a project. ProjectsApi | listProjectsHandler | GET /projects | List all projects accessible to the user that match the selected criteria. ProjectsApi | loadProjectLatestHandler | GET /project/{project} | Retrieves details about the latest version of a project. ProjectsApi | loadProjectVersionHandler | GET /project/{project}/{version} | Retrieves details about the given version of a project. ProjectsApi | projectVersionsHandler | GET /project/{project}/versions | Lists all available versions of a project. ProjectsApi | updateProjectHandler | PATCH /project/{project} | Updates a project. This will create a new version. SessionApi | anonymousHandler | POST /anonymous | Creates session for anonymous user. The session's id serves as a Bearer token for requests. SessionApi | loginHandler | POST /login | Creates a session by providing user credentials. The session's id serves as a Bearer token for requests. SessionApi | logoutHandler | POST /logout | Ends a session. SessionApi | oidcInit | POST /oidcInit | Initializes the Open Id Connect login procedure by requesting a parametrized url to the configured Id Provider. SessionApi | oidcLogin | POST /oidcLogin | Creates a session for a user via a login with Open Id Connect. This call must be preceded by a call to oidcInit and match the parameters of that call. SessionApi | registerUserHandler | POST /user | Registers a user. SessionApi | sessionHandler | GET /session | Retrieves details about the current session. SessionApi | sessionProjectHandler | POST /session/project/{project} | Sets the active project of the session. SessionApi | sessionViewHandler | POST /session/view | SpatialReferencesApi | getSpatialReferenceSpecificationHandler | GET /spatialReferenceSpecification/{srsString} | TasksApi | abortHandler | DELETE /tasks/{id} | Abort a running task. TasksApi | listHandler | GET /tasks/list | Retrieve the status of all tasks. TasksApi | statusHandler | GET /tasks/{id}/status | Retrieve the status of a task. UploadsApi | listUploadFileLayersHandler | GET /uploads/{upload_id}/files/{file_name}/layers | List the layers of on uploaded file. UploadsApi | listUploadFilesHandler | GET /uploads/{upload_id}/files | List the files of on upload. UploadsApi | uploadHandler | POST /upload | Uploads files. UserApi | addRoleHandler | PUT /roles | Add a new role. Requires admin privilige. UserApi | assignRoleHandler | POST /users/{user}/roles/{role} | Assign a role to a user. Requires admin privilige. UserApi | computationQuotaHandler | GET /quota/computations/{computation} | Retrieves the quota used by computation with the given computation id UserApi | computationsQuotaHandler | GET /quota/computations | Retrieves the quota used by computations UserApi | dataUsageHandler | GET /quota/dataUsage | Retrieves the data usage UserApi | dataUsageSummaryHandler | GET /quota/dataUsage/summary | Retrieves the data usage summary UserApi | getRoleByNameHandler | GET /roles/byName/{name} | Get role by name UserApi | getRoleDescriptions | GET /user/roles/descriptions | Query roles for the current user. UserApi | getUserQuotaHandler | GET /quotas/{user} | Retrieves the available and used quota of a specific user. UserApi | quotaHandler | GET /quota | Retrieves the available and used quota of the current user. UserApi | removeRoleHandler | DELETE /roles/{role} | Remove a role. Requires admin privilige. UserApi | revokeRoleHandler | DELETE /users/{user}/roles/{role} | Revoke a role from a user. Requires admin privilige. UserApi | updateUserQuotaHandler | POST /quotas/{user} | Update the available quota of a specific user. WorkflowsApi | datasetFromWorkflowHandler | POST /datasetFromWorkflow/{id} | Create a task for creating a new dataset from the result of the workflow given by its `id` and the dataset parameters in the request body. Returns the id of the created task WorkflowsApi | getWorkflowAllMetadataZipHandler | GET /workflow/{id}/allMetadata/zip | Gets a ZIP archive of the worklow, its provenance and the output metadata. WorkflowsApi | getWorkflowMetadataHandler | GET /workflow/{id}/metadata | Gets the metadata of a workflow WorkflowsApi | getWorkflowProvenanceHandler | GET /workflow/{id}/provenance | Gets the provenance of all datasets used in a workflow. WorkflowsApi | loadWorkflowHandler | GET /workflow/{id} | Retrieves an existing Workflow. WorkflowsApi | rasterStreamWebsocket | GET /workflow/{id}/rasterStream | Query a workflow raster result as a stream of tiles via a websocket connection. WorkflowsApi | registerWorkflowHandler | POST /workflow | Registers a new Workflow.

Models

Authorization

Authentication schemes defined for the API:

session_token

Type: HTTP Bearer Token authentication (UUID)

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

API version: 0.8.0
Package version: 0.0.29
Generator version: 7.17.0
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

Apache-2.0