Latest commit

History

History

README.md

geoengine-openapi-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.8.0
  • Package version: 0.0.10
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

importgeoengine_openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgeoengine_openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

importtimeimportgeoengine_openapi_clientfromgeoengine_openapi_client.restimportApiExceptionfrompprintimportpprint# Defining the host is optional and defaults to http://127.0.0.1:3030/api# See configuration.py for a list of all supported configuration parameters.configuration=geoengine_openapi_client.Configuration(
host="http://127.0.0.1:3030/api"
)
# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure Bearer authorization (UUID): session_tokenconfiguration=geoengine_openapi_client.Configuration(
access_token=os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API clientwithgeoengine_openapi_client.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_instance=geoengine_openapi_client.DatasetsApi(api_client)
auto_create_dataset=geoengine_openapi_client.AutoCreateDataset() # AutoCreateDataset | try:
# Creates a new dataset using previously uploaded files.api_response=api_instance.auto_create_dataset_handler(auto_create_dataset)
print("The response of DatasetsApi->auto_create_dataset_handler:\n")
pprint(api_response)
exceptApiExceptionase:
print("Exception when calling DatasetsApi->auto_create_dataset_handler: %s\n"%e)

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:3030/api

ClassMethodHTTP requestDescription
DatasetsApiauto_create_dataset_handlerPOST /dataset/autoCreates a new dataset using previously uploaded files.
DatasetsApicreate_dataset_handlerPOST /datasetCreates a new dataset referencing files. Users can reference previously uploaded files. Admins can reference files from a volume.
DatasetsApidelete_dataset_handlerDELETE /dataset/{dataset}Delete a dataset
DatasetsApiget_dataset_handlerGET /dataset/{dataset}Retrieves details about a dataset using the internal name.
DatasetsApiget_loading_info_handlerGET /dataset/{dataset}/loadingInfoRetrieves the loading information of a dataset
DatasetsApilist_datasets_handlerGET /datasetsLists available datasets.
DatasetsApilist_volumes_handlerGET /dataset/volumesLists available volumes.
DatasetsApisuggest_meta_data_handlerPOST /dataset/suggestInspects an upload and suggests metadata that can be used when creating a new dataset based on it.
DatasetsApiupdate_dataset_handlerPOST /dataset/{dataset}Update details about a dataset using the internal name.
DatasetsApiupdate_dataset_provenance_handlerPUT /dataset/{dataset}/provenance
DatasetsApiupdate_dataset_symbology_handlerPUT /dataset/{dataset}/symbologyUpdates the dataset's symbology
DatasetsApiupdate_loading_info_handlerPUT /dataset/{dataset}/loadingInfoUpdates the dataset's loading info
GeneralApiavailable_handlerGET /availableServer availablity check.
GeneralApiserver_info_handlerGET /infoShows information about the server software version.
LayersApiadd_collectionPOST /layerDb/collections/{collection}/collectionsAdd a new collection to an existing collection
LayersApiadd_existing_collection_to_collectionPOST /layerDb/collections/{parent}/collections/{collection}Add an existing collection to a collection
LayersApiadd_existing_layer_to_collectionPOST /layerDb/collections/{collection}/layers/{layer}Add an existing layer to a collection
LayersApiadd_layerPOST /layerDb/collections/{collection}/layersAdd a new layer to a collection
LayersApiautocomplete_handlerGET /layers/collections/search/autocomplete/{provider}/{collection}Autocompletes the search on the contents of the collection of the given provider
LayersApilayer_handlerGET /layers/{provider}/{layer}Retrieves the layer of the given provider
LayersApilayer_to_datasetPOST /layers/{provider}/{layer}/datasetPersist a raster layer from a provider as a dataset.
LayersApilayer_to_workflow_id_handlerPOST /layers/{provider}/{layer}/workflowIdRegisters a layer from a provider as a workflow and returns the workflow id
LayersApilist_collection_handlerGET /layers/collections/{provider}/{collection}List the contents of the collection of the given provider
LayersApilist_root_collections_handlerGET /layers/collectionsList all layer collections
LayersApiprovider_capabilities_handlerGET /layers/{provider}/capabilities
LayersApiremove_collectionDELETE /layerDb/collections/{collection}Remove a collection
LayersApiremove_collection_from_collectionDELETE /layerDb/collections/{parent}/collections/{collection}Delete a collection from a collection
LayersApiremove_layer_from_collectionDELETE /layerDb/collections/{collection}/layers/{layer}Remove a layer from a collection
LayersApisearch_handlerGET /layers/collections/search/{provider}/{collection}Searches the contents of the collection of the given provider
OGCWCSApiwcs_capabilities_handlerGET /wcs/{workflow}?request=GetCapabilitiesGet WCS Capabilities
OGCWCSApiwcs_describe_coverage_handlerGET /wcs/{workflow}?request=DescribeCoverageGet WCS Coverage Description
OGCWCSApiwcs_get_coverage_handlerGET /wcs/{workflow}?request=GetCoverageGet WCS Coverage
OGCWFSApiwfs_capabilities_handlerGET /wfs/{workflow}?request=GetCapabilitiesGet WFS Capabilities
OGCWFSApiwfs_feature_handlerGET /wfs/{workflow}?request=GetFeatureGet WCS Features
OGCWMSApiwms_capabilities_handlerGET /wms/{workflow}?request=GetCapabilitiesGet WMS Capabilities
OGCWMSApiwms_legend_graphic_handlerGET /wms/{workflow}?request=GetLegendGraphicGet WMS Legend Graphic
OGCWMSApiwms_map_handlerGET /wms/{workflow}?request=GetMapGet WMS Map
PermissionsApiadd_permission_handlerPUT /permissionsAdds a new permission.
PermissionsApiget_resource_permissions_handlerGET /permissions/resources/{resource_type}/{resource_id}Lists permission for a given resource.
PermissionsApiremove_permission_handlerDELETE /permissionsRemoves an existing permission.
PlotsApiget_plot_handlerGET /plot/{id}Generates a plot.
ProjectsApicreate_project_handlerPOST /projectCreate a new project for the user.
ProjectsApidelete_project_handlerDELETE /project/{project}Deletes a project.
ProjectsApilist_projects_handlerGET /projectsList all projects accessible to the user that match the selected criteria.
ProjectsApiload_project_latest_handlerGET /project/{project}Retrieves details about the latest version of a project.
ProjectsApiload_project_version_handlerGET /project/{project}/{version}Retrieves details about the given version of a project.
ProjectsApiproject_versions_handlerGET /project/{project}/versionsLists all available versions of a project.
ProjectsApiupdate_project_handlerPATCH /project/{project}Updates a project.
SessionApianonymous_handlerPOST /anonymousCreates session for anonymous user. The session's id serves as a Bearer token for requests.
SessionApilogin_handlerPOST /loginCreates a session by providing user credentials. The session's id serves as a Bearer token for requests.
SessionApilogout_handlerPOST /logoutEnds a session.
SessionApioidc_initPOST /oidcInitInitializes the Open Id Connect login procedure by requesting a parametrized url to the configured Id Provider.
SessionApioidc_loginPOST /oidcLoginCreates a session for a user via a login with Open Id Connect.
SessionApiregister_user_handlerPOST /userRegisters a user.
SessionApisession_handlerGET /sessionRetrieves details about the current session.
SpatialReferencesApiget_spatial_reference_specification_handlerGET /spatialReferenceSpecification/{srsString}
TasksApiabort_handlerDELETE /tasks/{id}Abort a running task.
TasksApilist_handlerGET /tasks/listRetrieve the status of all tasks.
TasksApistatus_handlerGET /tasks/{id}/statusRetrieve the status of a task.
UploadsApilist_upload_file_layers_handlerGET /uploads/{upload_id}/files/{file_name}/layersList the layers of on uploaded file.
UploadsApilist_upload_files_handlerGET /uploads/{upload_id}/filesList the files of on upload.
UploadsApiupload_handlerPOST /uploadUploads files.
UserApiadd_role_handlerPUT /rolesAdd a new role. Requires admin privilige.
UserApiassign_role_handlerPOST /users/{user}/roles/{role}Assign a role to a user. Requires admin privilige.
UserApiget_role_by_name_handlerGET /roles/byName/{name}Get role by name
UserApiget_role_descriptionsGET /user/roles/descriptionsQuery roles for the current user.
UserApiget_user_quota_handlerGET /quotas/{user}Retrieves the available and used quota of a specific user.
UserApiquota_handlerGET /quotaRetrieves the available and used quota of the current user.
UserApiremove_role_handlerDELETE /roles/{role}Remove a role. Requires admin privilige.
UserApirevoke_role_handlerDELETE /users/{user}/roles/{role}Revoke a role from a user. Requires admin privilige.
UserApiupdate_user_quota_handlerPOST /quotas/{user}Update the available quota of a specific user.
WorkflowsApidataset_from_workflow_handlerPOST /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.
WorkflowsApiget_workflow_all_metadata_zip_handlerGET /workflow/{id}/allMetadata/zipGets a ZIP archive of the worklow, its provenance and the output metadata.
WorkflowsApiget_workflow_metadata_handlerGET /workflow/{id}/metadataGets the metadata of a workflow
WorkflowsApiget_workflow_provenance_handlerGET /workflow/{id}/provenanceGets the provenance of all datasets used in a workflow.
WorkflowsApiload_workflow_handlerGET /workflow/{id}Retrieves an existing Workflow.
WorkflowsApiraster_stream_websocketGET /workflow/{id}/rasterStreamQuery a workflow raster result as a stream of tiles via a websocket connection.
WorkflowsApiregister_workflow_handlerPOST /workflowRegisters a new Workflow.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

session_token

  • Type: Bearer authentication (UUID)

Author

dev@geoengine.de

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Latest commit

History

History

README.md

geoengine-openapi-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.8.0
  • Package version: 0.0.10
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

importgeoengine_openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgeoengine_openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

importtimeimportgeoengine_openapi_clientfromgeoengine_openapi_client.restimportApiExceptionfrompprintimportpprint# Defining the host is optional and defaults to http://127.0.0.1:3030/api# See configuration.py for a list of all supported configuration parameters.configuration=geoengine_openapi_client.Configuration(
host="http://127.0.0.1:3030/api"
)
# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure Bearer authorization (UUID): session_tokenconfiguration=geoengine_openapi_client.Configuration(
access_token=os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API clientwithgeoengine_openapi_client.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_instance=geoengine_openapi_client.DatasetsApi(api_client)
auto_create_dataset=geoengine_openapi_client.AutoCreateDataset() # AutoCreateDataset | try:
# Creates a new dataset using previously uploaded files.api_response=api_instance.auto_create_dataset_handler(auto_create_dataset)
print("The response of DatasetsApi->auto_create_dataset_handler:\n")
pprint(api_response)
exceptApiExceptionase:
print("Exception when calling DatasetsApi->auto_create_dataset_handler: %s\n"%e)

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:3030/api

ClassMethodHTTP requestDescription
DatasetsApiauto_create_dataset_handlerPOST /dataset/autoCreates a new dataset using previously uploaded files.
DatasetsApicreate_dataset_handlerPOST /datasetCreates a new dataset referencing files. Users can reference previously uploaded files. Admins can reference files from a volume.
DatasetsApidelete_dataset_handlerDELETE /dataset/{dataset}Delete a dataset
DatasetsApiget_dataset_handlerGET /dataset/{dataset}Retrieves details about a dataset using the internal name.
DatasetsApiget_loading_info_handlerGET /dataset/{dataset}/loadingInfoRetrieves the loading information of a dataset
DatasetsApilist_datasets_handlerGET /datasetsLists available datasets.
DatasetsApilist_volumes_handlerGET /dataset/volumesLists available volumes.
DatasetsApisuggest_meta_data_handlerPOST /dataset/suggestInspects an upload and suggests metadata that can be used when creating a new dataset based on it.
DatasetsApiupdate_dataset_handlerPOST /dataset/{dataset}Update details about a dataset using the internal name.
DatasetsApiupdate_dataset_provenance_handlerPUT /dataset/{dataset}/provenance
DatasetsApiupdate_dataset_symbology_handlerPUT /dataset/{dataset}/symbologyUpdates the dataset's symbology
DatasetsApiupdate_loading_info_handlerPUT /dataset/{dataset}/loadingInfoUpdates the dataset's loading info
GeneralApiavailable_handlerGET /availableServer availablity check.
GeneralApiserver_info_handlerGET /infoShows information about the server software version.
LayersApiadd_collectionPOST /layerDb/collections/{collection}/collectionsAdd a new collection to an existing collection
LayersApiadd_existing_collection_to_collectionPOST /layerDb/collections/{parent}/collections/{collection}Add an existing collection to a collection
LayersApiadd_existing_layer_to_collectionPOST /layerDb/collections/{collection}/layers/{layer}Add an existing layer to a collection
LayersApiadd_layerPOST /layerDb/collections/{collection}/layersAdd a new layer to a collection
LayersApiautocomplete_handlerGET /layers/collections/search/autocomplete/{provider}/{collection}Autocompletes the search on the contents of the collection of the given provider
LayersApilayer_handlerGET /layers/{provider}/{layer}Retrieves the layer of the given provider
LayersApilayer_to_datasetPOST /layers/{provider}/{layer}/datasetPersist a raster layer from a provider as a dataset.
LayersApilayer_to_workflow_id_handlerPOST /layers/{provider}/{layer}/workflowIdRegisters a layer from a provider as a workflow and returns the workflow id
LayersApilist_collection_handlerGET /layers/collections/{provider}/{collection}List the contents of the collection of the given provider
LayersApilist_root_collections_handlerGET /layers/collectionsList all layer collections
LayersApiprovider_capabilities_handlerGET /layers/{provider}/capabilities
LayersApiremove_collectionDELETE /layerDb/collections/{collection}Remove a collection
LayersApiremove_collection_from_collectionDELETE /layerDb/collections/{parent}/collections/{collection}Delete a collection from a collection
LayersApiremove_layer_from_collectionDELETE /layerDb/collections/{collection}/layers/{layer}Remove a layer from a collection
LayersApisearch_handlerGET /layers/collections/search/{provider}/{collection}Searches the contents of the collection of the given provider
OGCWCSApiwcs_capabilities_handlerGET /wcs/{workflow}?request=GetCapabilitiesGet WCS Capabilities
OGCWCSApiwcs_describe_coverage_handlerGET /wcs/{workflow}?request=DescribeCoverageGet WCS Coverage Description
OGCWCSApiwcs_get_coverage_handlerGET /wcs/{workflow}?request=GetCoverageGet WCS Coverage
OGCWFSApiwfs_capabilities_handlerGET /wfs/{workflow}?request=GetCapabilitiesGet WFS Capabilities
OGCWFSApiwfs_feature_handlerGET /wfs/{workflow}?request=GetFeatureGet WCS Features
OGCWMSApiwms_capabilities_handlerGET /wms/{workflow}?request=GetCapabilitiesGet WMS Capabilities
OGCWMSApiwms_legend_graphic_handlerGET /wms/{workflow}?request=GetLegendGraphicGet WMS Legend Graphic
OGCWMSApiwms_map_handlerGET /wms/{workflow}?request=GetMapGet WMS Map
PermissionsApiadd_permission_handlerPUT /permissionsAdds a new permission.
PermissionsApiget_resource_permissions_handlerGET /permissions/resources/{resource_type}/{resource_id}Lists permission for a given resource.
PermissionsApiremove_permission_handlerDELETE /permissionsRemoves an existing permission.
PlotsApiget_plot_handlerGET /plot/{id}Generates a plot.
ProjectsApicreate_project_handlerPOST /projectCreate a new project for the user.
ProjectsApidelete_project_handlerDELETE /project/{project}Deletes a project.
ProjectsApilist_projects_handlerGET /projectsList all projects accessible to the user that match the selected criteria.
ProjectsApiload_project_latest_handlerGET /project/{project}Retrieves details about the latest version of a project.
ProjectsApiload_project_version_handlerGET /project/{project}/{version}Retrieves details about the given version of a project.
ProjectsApiproject_versions_handlerGET /project/{project}/versionsLists all available versions of a project.
ProjectsApiupdate_project_handlerPATCH /project/{project}Updates a project.
SessionApianonymous_handlerPOST /anonymousCreates session for anonymous user. The session's id serves as a Bearer token for requests.
SessionApilogin_handlerPOST /loginCreates a session by providing user credentials. The session's id serves as a Bearer token for requests.
SessionApilogout_handlerPOST /logoutEnds a session.
SessionApioidc_initPOST /oidcInitInitializes the Open Id Connect login procedure by requesting a parametrized url to the configured Id Provider.
SessionApioidc_loginPOST /oidcLoginCreates a session for a user via a login with Open Id Connect.
SessionApiregister_user_handlerPOST /userRegisters a user.
SessionApisession_handlerGET /sessionRetrieves details about the current session.
SpatialReferencesApiget_spatial_reference_specification_handlerGET /spatialReferenceSpecification/{srsString}
TasksApiabort_handlerDELETE /tasks/{id}Abort a running task.
TasksApilist_handlerGET /tasks/listRetrieve the status of all tasks.
TasksApistatus_handlerGET /tasks/{id}/statusRetrieve the status of a task.
UploadsApilist_upload_file_layers_handlerGET /uploads/{upload_id}/files/{file_name}/layersList the layers of on uploaded file.
UploadsApilist_upload_files_handlerGET /uploads/{upload_id}/filesList the files of on upload.
UploadsApiupload_handlerPOST /uploadUploads files.
UserApiadd_role_handlerPUT /rolesAdd a new role. Requires admin privilige.
UserApiassign_role_handlerPOST /users/{user}/roles/{role}Assign a role to a user. Requires admin privilige.
UserApiget_role_by_name_handlerGET /roles/byName/{name}Get role by name
UserApiget_role_descriptionsGET /user/roles/descriptionsQuery roles for the current user.
UserApiget_user_quota_handlerGET /quotas/{user}Retrieves the available and used quota of a specific user.
UserApiquota_handlerGET /quotaRetrieves the available and used quota of the current user.
UserApiremove_role_handlerDELETE /roles/{role}Remove a role. Requires admin privilige.
UserApirevoke_role_handlerDELETE /users/{user}/roles/{role}Revoke a role from a user. Requires admin privilige.
UserApiupdate_user_quota_handlerPOST /quotas/{user}Update the available quota of a specific user.
WorkflowsApidataset_from_workflow_handlerPOST /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.
WorkflowsApiget_workflow_all_metadata_zip_handlerGET /workflow/{id}/allMetadata/zipGets a ZIP archive of the worklow, its provenance and the output metadata.
WorkflowsApiget_workflow_metadata_handlerGET /workflow/{id}/metadataGets the metadata of a workflow
WorkflowsApiget_workflow_provenance_handlerGET /workflow/{id}/provenanceGets the provenance of all datasets used in a workflow.
WorkflowsApiload_workflow_handlerGET /workflow/{id}Retrieves an existing Workflow.
WorkflowsApiraster_stream_websocketGET /workflow/{id}/rasterStreamQuery a workflow raster result as a stream of tiles via a websocket connection.
WorkflowsApiregister_workflow_handlerPOST /workflowRegisters a new Workflow.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

session_token

  • Type: Bearer authentication (UUID)

Author

dev@geoengine.de

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Latest commit

History

History

README.md

geoengine-openapi-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.8.0
  • Package version: 0.0.10
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

importgeoengine_openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgeoengine_openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

importtimeimportgeoengine_openapi_clientfromgeoengine_openapi_client.restimportApiExceptionfrompprintimportpprint# Defining the host is optional and defaults to http://127.0.0.1:3030/api# See configuration.py for a list of all supported configuration parameters.configuration=geoengine_openapi_client.Configuration(
host="http://127.0.0.1:3030/api"
)
# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure Bearer authorization (UUID): session_tokenconfiguration=geoengine_openapi_client.Configuration(
access_token=os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API clientwithgeoengine_openapi_client.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_instance=geoengine_openapi_client.DatasetsApi(api_client)
auto_create_dataset=geoengine_openapi_client.AutoCreateDataset() # AutoCreateDataset | try:
# Creates a new dataset using previously uploaded files.api_response=api_instance.auto_create_dataset_handler(auto_create_dataset)
print("The response of DatasetsApi->auto_create_dataset_handler:\n")
pprint(api_response)
exceptApiExceptionase:
print("Exception when calling DatasetsApi->auto_create_dataset_handler: %s\n"%e)

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:3030/api

ClassMethodHTTP requestDescription
DatasetsApiauto_create_dataset_handlerPOST /dataset/autoCreates a new dataset using previously uploaded files.
DatasetsApicreate_dataset_handlerPOST /datasetCreates a new dataset referencing files. Users can reference previously uploaded files. Admins can reference files from a volume.
DatasetsApidelete_dataset_handlerDELETE /dataset/{dataset}Delete a dataset
DatasetsApiget_dataset_handlerGET /dataset/{dataset}Retrieves details about a dataset using the internal name.
DatasetsApiget_loading_info_handlerGET /dataset/{dataset}/loadingInfoRetrieves the loading information of a dataset
DatasetsApilist_datasets_handlerGET /datasetsLists available datasets.
DatasetsApilist_volumes_handlerGET /dataset/volumesLists available volumes.
DatasetsApisuggest_meta_data_handlerPOST /dataset/suggestInspects an upload and suggests metadata that can be used when creating a new dataset based on it.
DatasetsApiupdate_dataset_handlerPOST /dataset/{dataset}Update details about a dataset using the internal name.
DatasetsApiupdate_dataset_provenance_handlerPUT /dataset/{dataset}/provenance
DatasetsApiupdate_dataset_symbology_handlerPUT /dataset/{dataset}/symbologyUpdates the dataset's symbology
DatasetsApiupdate_loading_info_handlerPUT /dataset/{dataset}/loadingInfoUpdates the dataset's loading info
GeneralApiavailable_handlerGET /availableServer availablity check.
GeneralApiserver_info_handlerGET /infoShows information about the server software version.
LayersApiadd_collectionPOST /layerDb/collections/{collection}/collectionsAdd a new collection to an existing collection
LayersApiadd_existing_collection_to_collectionPOST /layerDb/collections/{parent}/collections/{collection}Add an existing collection to a collection
LayersApiadd_existing_layer_to_collectionPOST /layerDb/collections/{collection}/layers/{layer}Add an existing layer to a collection
LayersApiadd_layerPOST /layerDb/collections/{collection}/layersAdd a new layer to a collection
LayersApiautocomplete_handlerGET /layers/collections/search/autocomplete/{provider}/{collection}Autocompletes the search on the contents of the collection of the given provider
LayersApilayer_handlerGET /layers/{provider}/{layer}Retrieves the layer of the given provider
LayersApilayer_to_datasetPOST /layers/{provider}/{layer}/datasetPersist a raster layer from a provider as a dataset.
LayersApilayer_to_workflow_id_handlerPOST /layers/{provider}/{layer}/workflowIdRegisters a layer from a provider as a workflow and returns the workflow id
LayersApilist_collection_handlerGET /layers/collections/{provider}/{collection}List the contents of the collection of the given provider
LayersApilist_root_collections_handlerGET /layers/collectionsList all layer collections
LayersApiprovider_capabilities_handlerGET /layers/{provider}/capabilities
LayersApiremove_collectionDELETE /layerDb/collections/{collection}Remove a collection
LayersApiremove_collection_from_collectionDELETE /layerDb/collections/{parent}/collections/{collection}Delete a collection from a collection
LayersApiremove_layer_from_collectionDELETE /layerDb/collections/{collection}/layers/{layer}Remove a layer from a collection
LayersApisearch_handlerGET /layers/collections/search/{provider}/{collection}Searches the contents of the collection of the given provider
OGCWCSApiwcs_capabilities_handlerGET /wcs/{workflow}?request=GetCapabilitiesGet WCS Capabilities
OGCWCSApiwcs_describe_coverage_handlerGET /wcs/{workflow}?request=DescribeCoverageGet WCS Coverage Description
OGCWCSApiwcs_get_coverage_handlerGET /wcs/{workflow}?request=GetCoverageGet WCS Coverage
OGCWFSApiwfs_capabilities_handlerGET /wfs/{workflow}?request=GetCapabilitiesGet WFS Capabilities
OGCWFSApiwfs_feature_handlerGET /wfs/{workflow}?request=GetFeatureGet WCS Features
OGCWMSApiwms_capabilities_handlerGET /wms/{workflow}?request=GetCapabilitiesGet WMS Capabilities
OGCWMSApiwms_legend_graphic_handlerGET /wms/{workflow}?request=GetLegendGraphicGet WMS Legend Graphic
OGCWMSApiwms_map_handlerGET /wms/{workflow}?request=GetMapGet WMS Map
PermissionsApiadd_permission_handlerPUT /permissionsAdds a new permission.
PermissionsApiget_resource_permissions_handlerGET /permissions/resources/{resource_type}/{resource_id}Lists permission for a given resource.
PermissionsApiremove_permission_handlerDELETE /permissionsRemoves an existing permission.
PlotsApiget_plot_handlerGET /plot/{id}Generates a plot.
ProjectsApicreate_project_handlerPOST /projectCreate a new project for the user.
ProjectsApidelete_project_handlerDELETE /project/{project}Deletes a project.
ProjectsApilist_projects_handlerGET /projectsList all projects accessible to the user that match the selected criteria.
ProjectsApiload_project_latest_handlerGET /project/{project}Retrieves details about the latest version of a project.
ProjectsApiload_project_version_handlerGET /project/{project}/{version}Retrieves details about the given version of a project.
ProjectsApiproject_versions_handlerGET /project/{project}/versionsLists all available versions of a project.
ProjectsApiupdate_project_handlerPATCH /project/{project}Updates a project.
SessionApianonymous_handlerPOST /anonymousCreates session for anonymous user. The session's id serves as a Bearer token for requests.
SessionApilogin_handlerPOST /loginCreates a session by providing user credentials. The session's id serves as a Bearer token for requests.
SessionApilogout_handlerPOST /logoutEnds a session.
SessionApioidc_initPOST /oidcInitInitializes the Open Id Connect login procedure by requesting a parametrized url to the configured Id Provider.
SessionApioidc_loginPOST /oidcLoginCreates a session for a user via a login with Open Id Connect.
SessionApiregister_user_handlerPOST /userRegisters a user.
SessionApisession_handlerGET /sessionRetrieves details about the current session.
SpatialReferencesApiget_spatial_reference_specification_handlerGET /spatialReferenceSpecification/{srsString}
TasksApiabort_handlerDELETE /tasks/{id}Abort a running task.
TasksApilist_handlerGET /tasks/listRetrieve the status of all tasks.
TasksApistatus_handlerGET /tasks/{id}/statusRetrieve the status of a task.
UploadsApilist_upload_file_layers_handlerGET /uploads/{upload_id}/files/{file_name}/layersList the layers of on uploaded file.
UploadsApilist_upload_files_handlerGET /uploads/{upload_id}/filesList the files of on upload.
UploadsApiupload_handlerPOST /uploadUploads files.
UserApiadd_role_handlerPUT /rolesAdd a new role. Requires admin privilige.
UserApiassign_role_handlerPOST /users/{user}/roles/{role}Assign a role to a user. Requires admin privilige.
UserApiget_role_by_name_handlerGET /roles/byName/{name}Get role by name
UserApiget_role_descriptionsGET /user/roles/descriptionsQuery roles for the current user.
UserApiget_user_quota_handlerGET /quotas/{user}Retrieves the available and used quota of a specific user.
UserApiquota_handlerGET /quotaRetrieves the available and used quota of the current user.
UserApiremove_role_handlerDELETE /roles/{role}Remove a role. Requires admin privilige.
UserApirevoke_role_handlerDELETE /users/{user}/roles/{role}Revoke a role from a user. Requires admin privilige.
UserApiupdate_user_quota_handlerPOST /quotas/{user}Update the available quota of a specific user.
WorkflowsApidataset_from_workflow_handlerPOST /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.
WorkflowsApiget_workflow_all_metadata_zip_handlerGET /workflow/{id}/allMetadata/zipGets a ZIP archive of the worklow, its provenance and the output metadata.
WorkflowsApiget_workflow_metadata_handlerGET /workflow/{id}/metadataGets the metadata of a workflow
WorkflowsApiget_workflow_provenance_handlerGET /workflow/{id}/provenanceGets the provenance of all datasets used in a workflow.
WorkflowsApiload_workflow_handlerGET /workflow/{id}Retrieves an existing Workflow.
WorkflowsApiraster_stream_websocketGET /workflow/{id}/rasterStreamQuery a workflow raster result as a stream of tiles via a websocket connection.
WorkflowsApiregister_workflow_handlerPOST /workflowRegisters a new Workflow.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

session_token

  • Type: Bearer authentication (UUID)

Author

dev@geoengine.de

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Latest commit

History

History

README.md

geoengine-openapi-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.8.0
  • Package version: 0.0.10
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

importgeoengine_openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgeoengine_openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

importtimeimportgeoengine_openapi_clientfromgeoengine_openapi_client.restimportApiExceptionfrompprintimportpprint# Defining the host is optional and defaults to http://127.0.0.1:3030/api# See configuration.py for a list of all supported configuration parameters.configuration=geoengine_openapi_client.Configuration(
host="http://127.0.0.1:3030/api"
)
# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure Bearer authorization (UUID): session_tokenconfiguration=geoengine_openapi_client.Configuration(
access_token=os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API clientwithgeoengine_openapi_client.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_instance=geoengine_openapi_client.DatasetsApi(api_client)
auto_create_dataset=geoengine_openapi_client.AutoCreateDataset() # AutoCreateDataset | try:
# Creates a new dataset using previously uploaded files.api_response=api_instance.auto_create_dataset_handler(auto_create_dataset)
print("The response of DatasetsApi->auto_create_dataset_handler:\n")
pprint(api_response)
exceptApiExceptionase:
print("Exception when calling DatasetsApi->auto_create_dataset_handler: %s\n"%e)

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:3030/api

ClassMethodHTTP requestDescription
DatasetsApiauto_create_dataset_handlerPOST /dataset/autoCreates a new dataset using previously uploaded files.
DatasetsApicreate_dataset_handlerPOST /datasetCreates a new dataset referencing files. Users can reference previously uploaded files. Admins can reference files from a volume.
DatasetsApidelete_dataset_handlerDELETE /dataset/{dataset}Delete a dataset
DatasetsApiget_dataset_handlerGET /dataset/{dataset}Retrieves details about a dataset using the internal name.
DatasetsApiget_loading_info_handlerGET /dataset/{dataset}/loadingInfoRetrieves the loading information of a dataset
DatasetsApilist_datasets_handlerGET /datasetsLists available datasets.
DatasetsApilist_volumes_handlerGET /dataset/volumesLists available volumes.
DatasetsApisuggest_meta_data_handlerPOST /dataset/suggestInspects an upload and suggests metadata that can be used when creating a new dataset based on it.
DatasetsApiupdate_dataset_handlerPOST /dataset/{dataset}Update details about a dataset using the internal name.
DatasetsApiupdate_dataset_provenance_handlerPUT /dataset/{dataset}/provenance
DatasetsApiupdate_dataset_symbology_handlerPUT /dataset/{dataset}/symbologyUpdates the dataset's symbology
DatasetsApiupdate_loading_info_handlerPUT /dataset/{dataset}/loadingInfoUpdates the dataset's loading info
GeneralApiavailable_handlerGET /availableServer availablity check.
GeneralApiserver_info_handlerGET /infoShows information about the server software version.
LayersApiadd_collectionPOST /layerDb/collections/{collection}/collectionsAdd a new collection to an existing collection
LayersApiadd_existing_collection_to_collectionPOST /layerDb/collections/{parent}/collections/{collection}Add an existing collection to a collection
LayersApiadd_existing_layer_to_collectionPOST /layerDb/collections/{collection}/layers/{layer}Add an existing layer to a collection
LayersApiadd_layerPOST /layerDb/collections/{collection}/layersAdd a new layer to a collection
LayersApiautocomplete_handlerGET /layers/collections/search/autocomplete/{provider}/{collection}Autocompletes the search on the contents of the collection of the given provider
LayersApilayer_handlerGET /layers/{provider}/{layer}Retrieves the layer of the given provider
LayersApilayer_to_datasetPOST /layers/{provider}/{layer}/datasetPersist a raster layer from a provider as a dataset.
LayersApilayer_to_workflow_id_handlerPOST /layers/{provider}/{layer}/workflowIdRegisters a layer from a provider as a workflow and returns the workflow id
LayersApilist_collection_handlerGET /layers/collections/{provider}/{collection}List the contents of the collection of the given provider
LayersApilist_root_collections_handlerGET /layers/collectionsList all layer collections
LayersApiprovider_capabilities_handlerGET /layers/{provider}/capabilities
LayersApiremove_collectionDELETE /layerDb/collections/{collection}Remove a collection
LayersApiremove_collection_from_collectionDELETE /layerDb/collections/{parent}/collections/{collection}Delete a collection from a collection
LayersApiremove_layer_from_collectionDELETE /layerDb/collections/{collection}/layers/{layer}Remove a layer from a collection
LayersApisearch_handlerGET /layers/collections/search/{provider}/{collection}Searches the contents of the collection of the given provider
OGCWCSApiwcs_capabilities_handlerGET /wcs/{workflow}?request=GetCapabilitiesGet WCS Capabilities
OGCWCSApiwcs_describe_coverage_handlerGET /wcs/{workflow}?request=DescribeCoverageGet WCS Coverage Description
OGCWCSApiwcs_get_coverage_handlerGET /wcs/{workflow}?request=GetCoverageGet WCS Coverage
OGCWFSApiwfs_capabilities_handlerGET /wfs/{workflow}?request=GetCapabilitiesGet WFS Capabilities
OGCWFSApiwfs_feature_handlerGET /wfs/{workflow}?request=GetFeatureGet WCS Features
OGCWMSApiwms_capabilities_handlerGET /wms/{workflow}?request=GetCapabilitiesGet WMS Capabilities
OGCWMSApiwms_legend_graphic_handlerGET /wms/{workflow}?request=GetLegendGraphicGet WMS Legend Graphic
OGCWMSApiwms_map_handlerGET /wms/{workflow}?request=GetMapGet WMS Map
PermissionsApiadd_permission_handlerPUT /permissionsAdds a new permission.
PermissionsApiget_resource_permissions_handlerGET /permissions/resources/{resource_type}/{resource_id}Lists permission for a given resource.
PermissionsApiremove_permission_handlerDELETE /permissionsRemoves an existing permission.
PlotsApiget_plot_handlerGET /plot/{id}Generates a plot.
ProjectsApicreate_project_handlerPOST /projectCreate a new project for the user.
ProjectsApidelete_project_handlerDELETE /project/{project}Deletes a project.
ProjectsApilist_projects_handlerGET /projectsList all projects accessible to the user that match the selected criteria.
ProjectsApiload_project_latest_handlerGET /project/{project}Retrieves details about the latest version of a project.
ProjectsApiload_project_version_handlerGET /project/{project}/{version}Retrieves details about the given version of a project.
ProjectsApiproject_versions_handlerGET /project/{project}/versionsLists all available versions of a project.
ProjectsApiupdate_project_handlerPATCH /project/{project}Updates a project.
SessionApianonymous_handlerPOST /anonymousCreates session for anonymous user. The session's id serves as a Bearer token for requests.
SessionApilogin_handlerPOST /loginCreates a session by providing user credentials. The session's id serves as a Bearer token for requests.
SessionApilogout_handlerPOST /logoutEnds a session.
SessionApioidc_initPOST /oidcInitInitializes the Open Id Connect login procedure by requesting a parametrized url to the configured Id Provider.
SessionApioidc_loginPOST /oidcLoginCreates a session for a user via a login with Open Id Connect.
SessionApiregister_user_handlerPOST /userRegisters a user.
SessionApisession_handlerGET /sessionRetrieves details about the current session.
SpatialReferencesApiget_spatial_reference_specification_handlerGET /spatialReferenceSpecification/{srsString}
TasksApiabort_handlerDELETE /tasks/{id}Abort a running task.
TasksApilist_handlerGET /tasks/listRetrieve the status of all tasks.
TasksApistatus_handlerGET /tasks/{id}/statusRetrieve the status of a task.
UploadsApilist_upload_file_layers_handlerGET /uploads/{upload_id}/files/{file_name}/layersList the layers of on uploaded file.
UploadsApilist_upload_files_handlerGET /uploads/{upload_id}/filesList the files of on upload.
UploadsApiupload_handlerPOST /uploadUploads files.
UserApiadd_role_handlerPUT /rolesAdd a new role. Requires admin privilige.
UserApiassign_role_handlerPOST /users/{user}/roles/{role}Assign a role to a user. Requires admin privilige.
UserApiget_role_by_name_handlerGET /roles/byName/{name}Get role by name
UserApiget_role_descriptionsGET /user/roles/descriptionsQuery roles for the current user.
UserApiget_user_quota_handlerGET /quotas/{user}Retrieves the available and used quota of a specific user.
UserApiquota_handlerGET /quotaRetrieves the available and used quota of the current user.
UserApiremove_role_handlerDELETE /roles/{role}Remove a role. Requires admin privilige.
UserApirevoke_role_handlerDELETE /users/{user}/roles/{role}Revoke a role from a user. Requires admin privilige.
UserApiupdate_user_quota_handlerPOST /quotas/{user}Update the available quota of a specific user.
WorkflowsApidataset_from_workflow_handlerPOST /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.
WorkflowsApiget_workflow_all_metadata_zip_handlerGET /workflow/{id}/allMetadata/zipGets a ZIP archive of the worklow, its provenance and the output metadata.
WorkflowsApiget_workflow_metadata_handlerGET /workflow/{id}/metadataGets the metadata of a workflow
WorkflowsApiget_workflow_provenance_handlerGET /workflow/{id}/provenanceGets the provenance of all datasets used in a workflow.
WorkflowsApiload_workflow_handlerGET /workflow/{id}Retrieves an existing Workflow.
WorkflowsApiraster_stream_websocketGET /workflow/{id}/rasterStreamQuery a workflow raster result as a stream of tiles via a websocket connection.
WorkflowsApiregister_workflow_handlerPOST /workflowRegisters a new Workflow.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

session_token

  • Type: Bearer authentication (UUID)

Author

dev@geoengine.de

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Latest commit

History

History

README.md

geoengine-openapi-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.8.0
  • Package version: 0.0.10
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

importgeoengine_openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgeoengine_openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

importtimeimportgeoengine_openapi_clientfromgeoengine_openapi_client.restimportApiExceptionfrompprintimportpprint# Defining the host is optional and defaults to http://127.0.0.1:3030/api# See configuration.py for a list of all supported configuration parameters.configuration=geoengine_openapi_client.Configuration(
host="http://127.0.0.1:3030/api"
)
# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure Bearer authorization (UUID): session_tokenconfiguration=geoengine_openapi_client.Configuration(
access_token=os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API clientwithgeoengine_openapi_client.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_instance=geoengine_openapi_client.DatasetsApi(api_client)
auto_create_dataset=geoengine_openapi_client.AutoCreateDataset() # AutoCreateDataset | try:
# Creates a new dataset using previously uploaded files.api_response=api_instance.auto_create_dataset_handler(auto_create_dataset)
print("The response of DatasetsApi->auto_create_dataset_handler:\n")
pprint(api_response)
exceptApiExceptionase:
print("Exception when calling DatasetsApi->auto_create_dataset_handler: %s\n"%e)

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:3030/api

ClassMethodHTTP requestDescription
DatasetsApiauto_create_dataset_handlerPOST /dataset/autoCreates a new dataset using previously uploaded files.
DatasetsApicreate_dataset_handlerPOST /datasetCreates a new dataset referencing files. Users can reference previously uploaded files. Admins can reference files from a volume.
DatasetsApidelete_dataset_handlerDELETE /dataset/{dataset}Delete a dataset
DatasetsApiget_dataset_handlerGET /dataset/{dataset}Retrieves details about a dataset using the internal name.
DatasetsApiget_loading_info_handlerGET /dataset/{dataset}/loadingInfoRetrieves the loading information of a dataset
DatasetsApilist_datasets_handlerGET /datasetsLists available datasets.
DatasetsApilist_volumes_handlerGET /dataset/volumesLists available volumes.
DatasetsApisuggest_meta_data_handlerPOST /dataset/suggestInspects an upload and suggests metadata that can be used when creating a new dataset based on it.
DatasetsApiupdate_dataset_handlerPOST /dataset/{dataset}Update details about a dataset using the internal name.
DatasetsApiupdate_dataset_provenance_handlerPUT /dataset/{dataset}/provenance
DatasetsApiupdate_dataset_symbology_handlerPUT /dataset/{dataset}/symbologyUpdates the dataset's symbology
DatasetsApiupdate_loading_info_handlerPUT /dataset/{dataset}/loadingInfoUpdates the dataset's loading info
GeneralApiavailable_handlerGET /availableServer availablity check.
GeneralApiserver_info_handlerGET /infoShows information about the server software version.
LayersApiadd_collectionPOST /layerDb/collections/{collection}/collectionsAdd a new collection to an existing collection
LayersApiadd_existing_collection_to_collectionPOST /layerDb/collections/{parent}/collections/{collection}Add an existing collection to a collection
LayersApiadd_existing_layer_to_collectionPOST /layerDb/collections/{collection}/layers/{layer}Add an existing layer to a collection
LayersApiadd_layerPOST /layerDb/collections/{collection}/layersAdd a new layer to a collection
LayersApiautocomplete_handlerGET /layers/collections/search/autocomplete/{provider}/{collection}Autocompletes the search on the contents of the collection of the given provider
LayersApilayer_handlerGET /layers/{provider}/{layer}Retrieves the layer of the given provider
LayersApilayer_to_datasetPOST /layers/{provider}/{layer}/datasetPersist a raster layer from a provider as a dataset.
LayersApilayer_to_workflow_id_handlerPOST /layers/{provider}/{layer}/workflowIdRegisters a layer from a provider as a workflow and returns the workflow id
LayersApilist_collection_handlerGET /layers/collections/{provider}/{collection}List the contents of the collection of the given provider
LayersApilist_root_collections_handlerGET /layers/collectionsList all layer collections
LayersApiprovider_capabilities_handlerGET /layers/{provider}/capabilities
LayersApiremove_collectionDELETE /layerDb/collections/{collection}Remove a collection
LayersApiremove_collection_from_collectionDELETE /layerDb/collections/{parent}/collections/{collection}Delete a collection from a collection
LayersApiremove_layer_from_collectionDELETE /layerDb/collections/{collection}/layers/{layer}Remove a layer from a collection
LayersApisearch_handlerGET /layers/collections/search/{provider}/{collection}Searches the contents of the collection of the given provider
OGCWCSApiwcs_capabilities_handlerGET /wcs/{workflow}?request=GetCapabilitiesGet WCS Capabilities
OGCWCSApiwcs_describe_coverage_handlerGET /wcs/{workflow}?request=DescribeCoverageGet WCS Coverage Description
OGCWCSApiwcs_get_coverage_handlerGET /wcs/{workflow}?request=GetCoverageGet WCS Coverage
OGCWFSApiwfs_capabilities_handlerGET /wfs/{workflow}?request=GetCapabilitiesGet WFS Capabilities
OGCWFSApiwfs_feature_handlerGET /wfs/{workflow}?request=GetFeatureGet WCS Features
OGCWMSApiwms_capabilities_handlerGET /wms/{workflow}?request=GetCapabilitiesGet WMS Capabilities
OGCWMSApiwms_legend_graphic_handlerGET /wms/{workflow}?request=GetLegendGraphicGet WMS Legend Graphic
OGCWMSApiwms_map_handlerGET /wms/{workflow}?request=GetMapGet WMS Map
PermissionsApiadd_permission_handlerPUT /permissionsAdds a new permission.
PermissionsApiget_resource_permissions_handlerGET /permissions/resources/{resource_type}/{resource_id}Lists permission for a given resource.
PermissionsApiremove_permission_handlerDELETE /permissionsRemoves an existing permission.
PlotsApiget_plot_handlerGET /plot/{id}Generates a plot.
ProjectsApicreate_project_handlerPOST /projectCreate a new project for the user.
ProjectsApidelete_project_handlerDELETE /project/{project}Deletes a project.
ProjectsApilist_projects_handlerGET /projectsList all projects accessible to the user that match the selected criteria.
ProjectsApiload_project_latest_handlerGET /project/{project}Retrieves details about the latest version of a project.
ProjectsApiload_project_version_handlerGET /project/{project}/{version}Retrieves details about the given version of a project.
ProjectsApiproject_versions_handlerGET /project/{project}/versionsLists all available versions of a project.
ProjectsApiupdate_project_handlerPATCH /project/{project}Updates a project.
SessionApianonymous_handlerPOST /anonymousCreates session for anonymous user. The session's id serves as a Bearer token for requests.
SessionApilogin_handlerPOST /loginCreates a session by providing user credentials. The session's id serves as a Bearer token for requests.
SessionApilogout_handlerPOST /logoutEnds a session.
SessionApioidc_initPOST /oidcInitInitializes the Open Id Connect login procedure by requesting a parametrized url to the configured Id Provider.
SessionApioidc_loginPOST /oidcLoginCreates a session for a user via a login with Open Id Connect.
SessionApiregister_user_handlerPOST /userRegisters a user.
SessionApisession_handlerGET /sessionRetrieves details about the current session.
SpatialReferencesApiget_spatial_reference_specification_handlerGET /spatialReferenceSpecification/{srsString}
TasksApiabort_handlerDELETE /tasks/{id}Abort a running task.
TasksApilist_handlerGET /tasks/listRetrieve the status of all tasks.
TasksApistatus_handlerGET /tasks/{id}/statusRetrieve the status of a task.
UploadsApilist_upload_file_layers_handlerGET /uploads/{upload_id}/files/{file_name}/layersList the layers of on uploaded file.
UploadsApilist_upload_files_handlerGET /uploads/{upload_id}/filesList the files of on upload.
UploadsApiupload_handlerPOST /uploadUploads files.
UserApiadd_role_handlerPUT /rolesAdd a new role. Requires admin privilige.
UserApiassign_role_handlerPOST /users/{user}/roles/{role}Assign a role to a user. Requires admin privilige.
UserApiget_role_by_name_handlerGET /roles/byName/{name}Get role by name
UserApiget_role_descriptionsGET /user/roles/descriptionsQuery roles for the current user.
UserApiget_user_quota_handlerGET /quotas/{user}Retrieves the available and used quota of a specific user.
UserApiquota_handlerGET /quotaRetrieves the available and used quota of the current user.
UserApiremove_role_handlerDELETE /roles/{role}Remove a role. Requires admin privilige.
UserApirevoke_role_handlerDELETE /users/{user}/roles/{role}Revoke a role from a user. Requires admin privilige.
UserApiupdate_user_quota_handlerPOST /quotas/{user}Update the available quota of a specific user.
WorkflowsApidataset_from_workflow_handlerPOST /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.
WorkflowsApiget_workflow_all_metadata_zip_handlerGET /workflow/{id}/allMetadata/zipGets a ZIP archive of the worklow, its provenance and the output metadata.
WorkflowsApiget_workflow_metadata_handlerGET /workflow/{id}/metadataGets the metadata of a workflow
WorkflowsApiget_workflow_provenance_handlerGET /workflow/{id}/provenanceGets the provenance of all datasets used in a workflow.
WorkflowsApiload_workflow_handlerGET /workflow/{id}Retrieves an existing Workflow.
WorkflowsApiraster_stream_websocketGET /workflow/{id}/rasterStreamQuery a workflow raster result as a stream of tiles via a websocket connection.
WorkflowsApiregister_workflow_handlerPOST /workflowRegisters a new Workflow.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

session_token

  • Type: Bearer authentication (UUID)

Author

dev@geoengine.de

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Latest commit

History

History

README.md

geoengine-openapi-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.8.0
  • Package version: 0.0.10
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

importgeoengine_openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgeoengine_openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

importtimeimportgeoengine_openapi_clientfromgeoengine_openapi_client.restimportApiExceptionfrompprintimportpprint# Defining the host is optional and defaults to http://127.0.0.1:3030/api# See configuration.py for a list of all supported configuration parameters.configuration=geoengine_openapi_client.Configuration(
host="http://127.0.0.1:3030/api"
)
# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure Bearer authorization (UUID): session_tokenconfiguration=geoengine_openapi_client.Configuration(
access_token=os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API clientwithgeoengine_openapi_client.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_instance=geoengine_openapi_client.DatasetsApi(api_client)
auto_create_dataset=geoengine_openapi_client.AutoCreateDataset() # AutoCreateDataset | try:
# Creates a new dataset using previously uploaded files.api_response=api_instance.auto_create_dataset_handler(auto_create_dataset)
print("The response of DatasetsApi->auto_create_dataset_handler:\n")
pprint(api_response)
exceptApiExceptionase:
print("Exception when calling DatasetsApi->auto_create_dataset_handler: %s\n"%e)

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:3030/api

ClassMethodHTTP requestDescription
DatasetsApiauto_create_dataset_handlerPOST /dataset/autoCreates a new dataset using previously uploaded files.
DatasetsApicreate_dataset_handlerPOST /datasetCreates a new dataset referencing files. Users can reference previously uploaded files. Admins can reference files from a volume.
DatasetsApidelete_dataset_handlerDELETE /dataset/{dataset}Delete a dataset
DatasetsApiget_dataset_handlerGET /dataset/{dataset}Retrieves details about a dataset using the internal name.
DatasetsApiget_loading_info_handlerGET /dataset/{dataset}/loadingInfoRetrieves the loading information of a dataset
DatasetsApilist_datasets_handlerGET /datasetsLists available datasets.
DatasetsApilist_volumes_handlerGET /dataset/volumesLists available volumes.
DatasetsApisuggest_meta_data_handlerPOST /dataset/suggestInspects an upload and suggests metadata that can be used when creating a new dataset based on it.
DatasetsApiupdate_dataset_handlerPOST /dataset/{dataset}Update details about a dataset using the internal name.
DatasetsApiupdate_dataset_provenance_handlerPUT /dataset/{dataset}/provenance
DatasetsApiupdate_dataset_symbology_handlerPUT /dataset/{dataset}/symbologyUpdates the dataset's symbology
DatasetsApiupdate_loading_info_handlerPUT /dataset/{dataset}/loadingInfoUpdates the dataset's loading info
GeneralApiavailable_handlerGET /availableServer availablity check.
GeneralApiserver_info_handlerGET /infoShows information about the server software version.
LayersApiadd_collectionPOST /layerDb/collections/{collection}/collectionsAdd a new collection to an existing collection
LayersApiadd_existing_collection_to_collectionPOST /layerDb/collections/{parent}/collections/{collection}Add an existing collection to a collection
LayersApiadd_existing_layer_to_collectionPOST /layerDb/collections/{collection}/layers/{layer}Add an existing layer to a collection
LayersApiadd_layerPOST /layerDb/collections/{collection}/layersAdd a new layer to a collection
LayersApiautocomplete_handlerGET /layers/collections/search/autocomplete/{provider}/{collection}Autocompletes the search on the contents of the collection of the given provider
LayersApilayer_handlerGET /layers/{provider}/{layer}Retrieves the layer of the given provider
LayersApilayer_to_datasetPOST /layers/{provider}/{layer}/datasetPersist a raster layer from a provider as a dataset.
LayersApilayer_to_workflow_id_handlerPOST /layers/{provider}/{layer}/workflowIdRegisters a layer from a provider as a workflow and returns the workflow id
LayersApilist_collection_handlerGET /layers/collections/{provider}/{collection}List the contents of the collection of the given provider
LayersApilist_root_collections_handlerGET /layers/collectionsList all layer collections
LayersApiprovider_capabilities_handlerGET /layers/{provider}/capabilities
LayersApiremove_collectionDELETE /layerDb/collections/{collection}Remove a collection
LayersApiremove_collection_from_collectionDELETE /layerDb/collections/{parent}/collections/{collection}Delete a collection from a collection
LayersApiremove_layer_from_collectionDELETE /layerDb/collections/{collection}/layers/{layer}Remove a layer from a collection
LayersApisearch_handlerGET /layers/collections/search/{provider}/{collection}Searches the contents of the collection of the given provider
OGCWCSApiwcs_capabilities_handlerGET /wcs/{workflow}?request=GetCapabilitiesGet WCS Capabilities
OGCWCSApiwcs_describe_coverage_handlerGET /wcs/{workflow}?request=DescribeCoverageGet WCS Coverage Description
OGCWCSApiwcs_get_coverage_handlerGET /wcs/{workflow}?request=GetCoverageGet WCS Coverage
OGCWFSApiwfs_capabilities_handlerGET /wfs/{workflow}?request=GetCapabilitiesGet WFS Capabilities
OGCWFSApiwfs_feature_handlerGET /wfs/{workflow}?request=GetFeatureGet WCS Features
OGCWMSApiwms_capabilities_handlerGET /wms/{workflow}?request=GetCapabilitiesGet WMS Capabilities
OGCWMSApiwms_legend_graphic_handlerGET /wms/{workflow}?request=GetLegendGraphicGet WMS Legend Graphic
OGCWMSApiwms_map_handlerGET /wms/{workflow}?request=GetMapGet WMS Map
PermissionsApiadd_permission_handlerPUT /permissionsAdds a new permission.
PermissionsApiget_resource_permissions_handlerGET /permissions/resources/{resource_type}/{resource_id}Lists permission for a given resource.
PermissionsApiremove_permission_handlerDELETE /permissionsRemoves an existing permission.
PlotsApiget_plot_handlerGET /plot/{id}Generates a plot.
ProjectsApicreate_project_handlerPOST /projectCreate a new project for the user.
ProjectsApidelete_project_handlerDELETE /project/{project}Deletes a project.
ProjectsApilist_projects_handlerGET /projectsList all projects accessible to the user that match the selected criteria.
ProjectsApiload_project_latest_handlerGET /project/{project}Retrieves details about the latest version of a project.
ProjectsApiload_project_version_handlerGET /project/{project}/{version}Retrieves details about the given version of a project.
ProjectsApiproject_versions_handlerGET /project/{project}/versionsLists all available versions of a project.
ProjectsApiupdate_project_handlerPATCH /project/{project}Updates a project.
SessionApianonymous_handlerPOST /anonymousCreates session for anonymous user. The session's id serves as a Bearer token for requests.
SessionApilogin_handlerPOST /loginCreates a session by providing user credentials. The session's id serves as a Bearer token for requests.
SessionApilogout_handlerPOST /logoutEnds a session.
SessionApioidc_initPOST /oidcInitInitializes the Open Id Connect login procedure by requesting a parametrized url to the configured Id Provider.
SessionApioidc_loginPOST /oidcLoginCreates a session for a user via a login with Open Id Connect.
SessionApiregister_user_handlerPOST /userRegisters a user.
SessionApisession_handlerGET /sessionRetrieves details about the current session.
SpatialReferencesApiget_spatial_reference_specification_handlerGET /spatialReferenceSpecification/{srsString}
TasksApiabort_handlerDELETE /tasks/{id}Abort a running task.
TasksApilist_handlerGET /tasks/listRetrieve the status of all tasks.
TasksApistatus_handlerGET /tasks/{id}/statusRetrieve the status of a task.
UploadsApilist_upload_file_layers_handlerGET /uploads/{upload_id}/files/{file_name}/layersList the layers of on uploaded file.
UploadsApilist_upload_files_handlerGET /uploads/{upload_id}/filesList the files of on upload.
UploadsApiupload_handlerPOST /uploadUploads files.
UserApiadd_role_handlerPUT /rolesAdd a new role. Requires admin privilige.
UserApiassign_role_handlerPOST /users/{user}/roles/{role}Assign a role to a user. Requires admin privilige.
UserApiget_role_by_name_handlerGET /roles/byName/{name}Get role by name
UserApiget_role_descriptionsGET /user/roles/descriptionsQuery roles for the current user.
UserApiget_user_quota_handlerGET /quotas/{user}Retrieves the available and used quota of a specific user.
UserApiquota_handlerGET /quotaRetrieves the available and used quota of the current user.
UserApiremove_role_handlerDELETE /roles/{role}Remove a role. Requires admin privilige.
UserApirevoke_role_handlerDELETE /users/{user}/roles/{role}Revoke a role from a user. Requires admin privilige.
UserApiupdate_user_quota_handlerPOST /quotas/{user}Update the available quota of a specific user.
WorkflowsApidataset_from_workflow_handlerPOST /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.
WorkflowsApiget_workflow_all_metadata_zip_handlerGET /workflow/{id}/allMetadata/zipGets a ZIP archive of the worklow, its provenance and the output metadata.
WorkflowsApiget_workflow_metadata_handlerGET /workflow/{id}/metadataGets the metadata of a workflow
WorkflowsApiget_workflow_provenance_handlerGET /workflow/{id}/provenanceGets the provenance of all datasets used in a workflow.
WorkflowsApiload_workflow_handlerGET /workflow/{id}Retrieves an existing Workflow.
WorkflowsApiraster_stream_websocketGET /workflow/{id}/rasterStreamQuery a workflow raster result as a stream of tiles via a websocket connection.
WorkflowsApiregister_workflow_handlerPOST /workflowRegisters a new Workflow.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

session_token

  • Type: Bearer authentication (UUID)

Author

dev@geoengine.de

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Latest commit

History

History

README.md

geoengine-openapi-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.8.0
  • Package version: 0.0.10
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

importgeoengine_openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgeoengine_openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

importtimeimportgeoengine_openapi_clientfromgeoengine_openapi_client.restimportApiExceptionfrompprintimportpprint# Defining the host is optional and defaults to http://127.0.0.1:3030/api# See configuration.py for a list of all supported configuration parameters.configuration=geoengine_openapi_client.Configuration(
host="http://127.0.0.1:3030/api"
)
# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure Bearer authorization (UUID): session_tokenconfiguration=geoengine_openapi_client.Configuration(
access_token=os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API clientwithgeoengine_openapi_client.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_instance=geoengine_openapi_client.DatasetsApi(api_client)
auto_create_dataset=geoengine_openapi_client.AutoCreateDataset() # AutoCreateDataset | try:
# Creates a new dataset using previously uploaded files.api_response=api_instance.auto_create_dataset_handler(auto_create_dataset)
print("The response of DatasetsApi->auto_create_dataset_handler:\n")
pprint(api_response)
exceptApiExceptionase:
print("Exception when calling DatasetsApi->auto_create_dataset_handler: %s\n"%e)

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:3030/api

ClassMethodHTTP requestDescription
DatasetsApiauto_create_dataset_handlerPOST /dataset/autoCreates a new dataset using previously uploaded files.
DatasetsApicreate_dataset_handlerPOST /datasetCreates a new dataset referencing files. Users can reference previously uploaded files. Admins can reference files from a volume.
DatasetsApidelete_dataset_handlerDELETE /dataset/{dataset}Delete a dataset
DatasetsApiget_dataset_handlerGET /dataset/{dataset}Retrieves details about a dataset using the internal name.
DatasetsApiget_loading_info_handlerGET /dataset/{dataset}/loadingInfoRetrieves the loading information of a dataset
DatasetsApilist_datasets_handlerGET /datasetsLists available datasets.
DatasetsApilist_volumes_handlerGET /dataset/volumesLists available volumes.
DatasetsApisuggest_meta_data_handlerPOST /dataset/suggestInspects an upload and suggests metadata that can be used when creating a new dataset based on it.
DatasetsApiupdate_dataset_handlerPOST /dataset/{dataset}Update details about a dataset using the internal name.
DatasetsApiupdate_dataset_provenance_handlerPUT /dataset/{dataset}/provenance
DatasetsApiupdate_dataset_symbology_handlerPUT /dataset/{dataset}/symbologyUpdates the dataset's symbology
DatasetsApiupdate_loading_info_handlerPUT /dataset/{dataset}/loadingInfoUpdates the dataset's loading info
GeneralApiavailable_handlerGET /availableServer availablity check.
GeneralApiserver_info_handlerGET /infoShows information about the server software version.
LayersApiadd_collectionPOST /layerDb/collections/{collection}/collectionsAdd a new collection to an existing collection
LayersApiadd_existing_collection_to_collectionPOST /layerDb/collections/{parent}/collections/{collection}Add an existing collection to a collection
LayersApiadd_existing_layer_to_collectionPOST /layerDb/collections/{collection}/layers/{layer}Add an existing layer to a collection
LayersApiadd_layerPOST /layerDb/collections/{collection}/layersAdd a new layer to a collection
LayersApiautocomplete_handlerGET /layers/collections/search/autocomplete/{provider}/{collection}Autocompletes the search on the contents of the collection of the given provider
LayersApilayer_handlerGET /layers/{provider}/{layer}Retrieves the layer of the given provider
LayersApilayer_to_datasetPOST /layers/{provider}/{layer}/datasetPersist a raster layer from a provider as a dataset.
LayersApilayer_to_workflow_id_handlerPOST /layers/{provider}/{layer}/workflowIdRegisters a layer from a provider as a workflow and returns the workflow id
LayersApilist_collection_handlerGET /layers/collections/{provider}/{collection}List the contents of the collection of the given provider
LayersApilist_root_collections_handlerGET /layers/collectionsList all layer collections
LayersApiprovider_capabilities_handlerGET /layers/{provider}/capabilities
LayersApiremove_collectionDELETE /layerDb/collections/{collection}Remove a collection
LayersApiremove_collection_from_collectionDELETE /layerDb/collections/{parent}/collections/{collection}Delete a collection from a collection
LayersApiremove_layer_from_collectionDELETE /layerDb/collections/{collection}/layers/{layer}Remove a layer from a collection
LayersApisearch_handlerGET /layers/collections/search/{provider}/{collection}Searches the contents of the collection of the given provider
OGCWCSApiwcs_capabilities_handlerGET /wcs/{workflow}?request=GetCapabilitiesGet WCS Capabilities
OGCWCSApiwcs_describe_coverage_handlerGET /wcs/{workflow}?request=DescribeCoverageGet WCS Coverage Description
OGCWCSApiwcs_get_coverage_handlerGET /wcs/{workflow}?request=GetCoverageGet WCS Coverage
OGCWFSApiwfs_capabilities_handlerGET /wfs/{workflow}?request=GetCapabilitiesGet WFS Capabilities
OGCWFSApiwfs_feature_handlerGET /wfs/{workflow}?request=GetFeatureGet WCS Features
OGCWMSApiwms_capabilities_handlerGET /wms/{workflow}?request=GetCapabilitiesGet WMS Capabilities
OGCWMSApiwms_legend_graphic_handlerGET /wms/{workflow}?request=GetLegendGraphicGet WMS Legend Graphic
OGCWMSApiwms_map_handlerGET /wms/{workflow}?request=GetMapGet WMS Map
PermissionsApiadd_permission_handlerPUT /permissionsAdds a new permission.
PermissionsApiget_resource_permissions_handlerGET /permissions/resources/{resource_type}/{resource_id}Lists permission for a given resource.
PermissionsApiremove_permission_handlerDELETE /permissionsRemoves an existing permission.
PlotsApiget_plot_handlerGET /plot/{id}Generates a plot.
ProjectsApicreate_project_handlerPOST /projectCreate a new project for the user.
ProjectsApidelete_project_handlerDELETE /project/{project}Deletes a project.
ProjectsApilist_projects_handlerGET /projectsList all projects accessible to the user that match the selected criteria.
ProjectsApiload_project_latest_handlerGET /project/{project}Retrieves details about the latest version of a project.
ProjectsApiload_project_version_handlerGET /project/{project}/{version}Retrieves details about the given version of a project.
ProjectsApiproject_versions_handlerGET /project/{project}/versionsLists all available versions of a project.
ProjectsApiupdate_project_handlerPATCH /project/{project}Updates a project.
SessionApianonymous_handlerPOST /anonymousCreates session for anonymous user. The session's id serves as a Bearer token for requests.
SessionApilogin_handlerPOST /loginCreates a session by providing user credentials. The session's id serves as a Bearer token for requests.
SessionApilogout_handlerPOST /logoutEnds a session.
SessionApioidc_initPOST /oidcInitInitializes the Open Id Connect login procedure by requesting a parametrized url to the configured Id Provider.
SessionApioidc_loginPOST /oidcLoginCreates a session for a user via a login with Open Id Connect.
SessionApiregister_user_handlerPOST /userRegisters a user.
SessionApisession_handlerGET /sessionRetrieves details about the current session.
SpatialReferencesApiget_spatial_reference_specification_handlerGET /spatialReferenceSpecification/{srsString}
TasksApiabort_handlerDELETE /tasks/{id}Abort a running task.
TasksApilist_handlerGET /tasks/listRetrieve the status of all tasks.
TasksApistatus_handlerGET /tasks/{id}/statusRetrieve the status of a task.
UploadsApilist_upload_file_layers_handlerGET /uploads/{upload_id}/files/{file_name}/layersList the layers of on uploaded file.
UploadsApilist_upload_files_handlerGET /uploads/{upload_id}/filesList the files of on upload.
UploadsApiupload_handlerPOST /uploadUploads files.
UserApiadd_role_handlerPUT /rolesAdd a new role. Requires admin privilige.
UserApiassign_role_handlerPOST /users/{user}/roles/{role}Assign a role to a user. Requires admin privilige.
UserApiget_role_by_name_handlerGET /roles/byName/{name}Get role by name
UserApiget_role_descriptionsGET /user/roles/descriptionsQuery roles for the current user.
UserApiget_user_quota_handlerGET /quotas/{user}Retrieves the available and used quota of a specific user.
UserApiquota_handlerGET /quotaRetrieves the available and used quota of the current user.
UserApiremove_role_handlerDELETE /roles/{role}Remove a role. Requires admin privilige.
UserApirevoke_role_handlerDELETE /users/{user}/roles/{role}Revoke a role from a user. Requires admin privilige.
UserApiupdate_user_quota_handlerPOST /quotas/{user}Update the available quota of a specific user.
WorkflowsApidataset_from_workflow_handlerPOST /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.
WorkflowsApiget_workflow_all_metadata_zip_handlerGET /workflow/{id}/allMetadata/zipGets a ZIP archive of the worklow, its provenance and the output metadata.
WorkflowsApiget_workflow_metadata_handlerGET /workflow/{id}/metadataGets the metadata of a workflow
WorkflowsApiget_workflow_provenance_handlerGET /workflow/{id}/provenanceGets the provenance of all datasets used in a workflow.
WorkflowsApiload_workflow_handlerGET /workflow/{id}Retrieves an existing Workflow.
WorkflowsApiraster_stream_websocketGET /workflow/{id}/rasterStreamQuery a workflow raster result as a stream of tiles via a websocket connection.
WorkflowsApiregister_workflow_handlerPOST /workflowRegisters a new Workflow.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

session_token

  • Type: Bearer authentication (UUID)

Author

dev@geoengine.de

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Latest commit

History

History

README.md

geoengine-openapi-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.8.0
  • Package version: 0.0.10
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

importgeoengine_openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importgeoengine_openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

importtimeimportgeoengine_openapi_clientfromgeoengine_openapi_client.restimportApiExceptionfrompprintimportpprint# Defining the host is optional and defaults to http://127.0.0.1:3030/api# See configuration.py for a list of all supported configuration parameters.configuration=geoengine_openapi_client.Configuration(
host="http://127.0.0.1:3030/api"
)
# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure Bearer authorization (UUID): session_tokenconfiguration=geoengine_openapi_client.Configuration(
access_token=os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API clientwithgeoengine_openapi_client.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_instance=geoengine_openapi_client.DatasetsApi(api_client)
auto_create_dataset=geoengine_openapi_client.AutoCreateDataset() # AutoCreateDataset | try:
# Creates a new dataset using previously uploaded files.api_response=api_instance.auto_create_dataset_handler(auto_create_dataset)
print("The response of DatasetsApi->auto_create_dataset_handler:\n")
pprint(api_response)
exceptApiExceptionase:
print("Exception when calling DatasetsApi->auto_create_dataset_handler: %s\n"%e)

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:3030/api

ClassMethodHTTP requestDescription
DatasetsApiauto_create_dataset_handlerPOST /dataset/autoCreates a new dataset using previously uploaded files.
DatasetsApicreate_dataset_handlerPOST /datasetCreates a new dataset referencing files. Users can reference previously uploaded files. Admins can reference files from a volume.
DatasetsApidelete_dataset_handlerDELETE /dataset/{dataset}Delete a dataset
DatasetsApiget_dataset_handlerGET /dataset/{dataset}Retrieves details about a dataset using the internal name.
DatasetsApiget_loading_info_handlerGET /dataset/{dataset}/loadingInfoRetrieves the loading information of a dataset
DatasetsApilist_datasets_handlerGET /datasetsLists available datasets.
DatasetsApilist_volumes_handlerGET /dataset/volumesLists available volumes.
DatasetsApisuggest_meta_data_handlerPOST /dataset/suggestInspects an upload and suggests metadata that can be used when creating a new dataset based on it.
DatasetsApiupdate_dataset_handlerPOST /dataset/{dataset}Update details about a dataset using the internal name.
DatasetsApiupdate_dataset_provenance_handlerPUT /dataset/{dataset}/provenance
DatasetsApiupdate_dataset_symbology_handlerPUT /dataset/{dataset}/symbologyUpdates the dataset's symbology
DatasetsApiupdate_loading_info_handlerPUT /dataset/{dataset}/loadingInfoUpdates the dataset's loading info
GeneralApiavailable_handlerGET /availableServer availablity check.
GeneralApiserver_info_handlerGET /infoShows information about the server software version.
LayersApiadd_collectionPOST /layerDb/collections/{collection}/collectionsAdd a new collection to an existing collection
LayersApiadd_existing_collection_to_collectionPOST /layerDb/collections/{parent}/collections/{collection}Add an existing collection to a collection
LayersApiadd_existing_layer_to_collectionPOST /layerDb/collections/{collection}/layers/{layer}Add an existing layer to a collection
LayersApiadd_layerPOST /layerDb/collections/{collection}/layersAdd a new layer to a collection
LayersApiautocomplete_handlerGET /layers/collections/search/autocomplete/{provider}/{collection}Autocompletes the search on the contents of the collection of the given provider
LayersApilayer_handlerGET /layers/{provider}/{layer}Retrieves the layer of the given provider
LayersApilayer_to_datasetPOST /layers/{provider}/{layer}/datasetPersist a raster layer from a provider as a dataset.
LayersApilayer_to_workflow_id_handlerPOST /layers/{provider}/{layer}/workflowIdRegisters a layer from a provider as a workflow and returns the workflow id
LayersApilist_collection_handlerGET /layers/collections/{provider}/{collection}List the contents of the collection of the given provider
LayersApilist_root_collections_handlerGET /layers/collectionsList all layer collections
LayersApiprovider_capabilities_handlerGET /layers/{provider}/capabilities
LayersApiremove_collectionDELETE /layerDb/collections/{collection}Remove a collection
LayersApiremove_collection_from_collectionDELETE /layerDb/collections/{parent}/collections/{collection}Delete a collection from a collection
LayersApiremove_layer_from_collectionDELETE /layerDb/collections/{collection}/layers/{layer}Remove a layer from a collection
LayersApisearch_handlerGET /layers/collections/search/{provider}/{collection}Searches the contents of the collection of the given provider
OGCWCSApiwcs_capabilities_handlerGET /wcs/{workflow}?request=GetCapabilitiesGet WCS Capabilities
OGCWCSApiwcs_describe_coverage_handlerGET /wcs/{workflow}?request=DescribeCoverageGet WCS Coverage Description
OGCWCSApiwcs_get_coverage_handlerGET /wcs/{workflow}?request=GetCoverageGet WCS Coverage
OGCWFSApiwfs_capabilities_handlerGET /wfs/{workflow}?request=GetCapabilitiesGet WFS Capabilities
OGCWFSApiwfs_feature_handlerGET /wfs/{workflow}?request=GetFeatureGet WCS Features
OGCWMSApiwms_capabilities_handlerGET /wms/{workflow}?request=GetCapabilitiesGet WMS Capabilities
OGCWMSApiwms_legend_graphic_handlerGET /wms/{workflow}?request=GetLegendGraphicGet WMS Legend Graphic
OGCWMSApiwms_map_handlerGET /wms/{workflow}?request=GetMapGet WMS Map
PermissionsApiadd_permission_handlerPUT /permissionsAdds a new permission.
PermissionsApiget_resource_permissions_handlerGET /permissions/resources/{resource_type}/{resource_id}Lists permission for a given resource.
PermissionsApiremove_permission_handlerDELETE /permissionsRemoves an existing permission.
PlotsApiget_plot_handlerGET /plot/{id}Generates a plot.
ProjectsApicreate_project_handlerPOST /projectCreate a new project for the user.
ProjectsApidelete_project_handlerDELETE /project/{project}Deletes a project.
ProjectsApilist_projects_handlerGET /projectsList all projects accessible to the user that match the selected criteria.
ProjectsApiload_project_latest_handlerGET /project/{project}Retrieves details about the latest version of a project.
ProjectsApiload_project_version_handlerGET /project/{project}/{version}Retrieves details about the given version of a project.
ProjectsApiproject_versions_handlerGET /project/{project}/versionsLists all available versions of a project.
ProjectsApiupdate_project_handlerPATCH /project/{project}Updates a project.
SessionApianonymous_handlerPOST /anonymousCreates session for anonymous user. The session's id serves as a Bearer token for requests.
SessionApilogin_handlerPOST /loginCreates a session by providing user credentials. The session's id serves as a Bearer token for requests.
SessionApilogout_handlerPOST /logoutEnds a session.
SessionApioidc_initPOST /oidcInitInitializes the Open Id Connect login procedure by requesting a parametrized url to the configured Id Provider.
SessionApioidc_loginPOST /oidcLoginCreates a session for a user via a login with Open Id Connect.
SessionApiregister_user_handlerPOST /userRegisters a user.
SessionApisession_handlerGET /sessionRetrieves details about the current session.
SpatialReferencesApiget_spatial_reference_specification_handlerGET /spatialReferenceSpecification/{srsString}
TasksApiabort_handlerDELETE /tasks/{id}Abort a running task.
TasksApilist_handlerGET /tasks/listRetrieve the status of all tasks.
TasksApistatus_handlerGET /tasks/{id}/statusRetrieve the status of a task.
UploadsApilist_upload_file_layers_handlerGET /uploads/{upload_id}/files/{file_name}/layersList the layers of on uploaded file.
UploadsApilist_upload_files_handlerGET /uploads/{upload_id}/filesList the files of on upload.
UploadsApiupload_handlerPOST /uploadUploads files.
UserApiadd_role_handlerPUT /rolesAdd a new role. Requires admin privilige.
UserApiassign_role_handlerPOST /users/{user}/roles/{role}Assign a role to a user. Requires admin privilige.
UserApiget_role_by_name_handlerGET /roles/byName/{name}Get role by name
UserApiget_role_descriptionsGET /user/roles/descriptionsQuery roles for the current user.
UserApiget_user_quota_handlerGET /quotas/{user}Retrieves the available and used quota of a specific user.
UserApiquota_handlerGET /quotaRetrieves the available and used quota of the current user.
UserApiremove_role_handlerDELETE /roles/{role}Remove a role. Requires admin privilige.
UserApirevoke_role_handlerDELETE /users/{user}/roles/{role}Revoke a role from a user. Requires admin privilige.
UserApiupdate_user_quota_handlerPOST /quotas/{user}Update the available quota of a specific user.
WorkflowsApidataset_from_workflow_handlerPOST /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.
WorkflowsApiget_workflow_all_metadata_zip_handlerGET /workflow/{id}/allMetadata/zipGets a ZIP archive of the worklow, its provenance and the output metadata.
WorkflowsApiget_workflow_metadata_handlerGET /workflow/{id}/metadataGets the metadata of a workflow
WorkflowsApiget_workflow_provenance_handlerGET /workflow/{id}/provenanceGets the provenance of all datasets used in a workflow.
WorkflowsApiload_workflow_handlerGET /workflow/{id}Retrieves an existing Workflow.
WorkflowsApiraster_stream_websocketGET /workflow/{id}/rasterStreamQuery a workflow raster result as a stream of tiles via a websocket connection.
WorkflowsApiregister_workflow_handlerPOST /workflowRegisters a new Workflow.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

session_token

  • Type: Bearer authentication (UUID)

Author

dev@geoengine.de