entryscape 1.6.1__tar.gz → 1.7.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {entryscape-1.6.1 → entryscape-1.7.0}/PKG-INFO +29 -3
- {entryscape-1.6.1 → entryscape-1.7.0}/README.md +28 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/__init__.py +63 -3
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/__init__.py +2 -0
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/app_token_api.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/auth_api.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/catalog_api.py +131 -14
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/contact_api.py +49 -8
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/dataservice_api.py +49 -8
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/dataset_api.py +90 -11
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/distribution_api.py +49 -8
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/document_api.py +46 -5
- entryscape-1.7.0/entryscape/api/entity_type_api.py +381 -0
- entryscape-1.6.1/entryscape/api/model_diagram_api.py → entryscape-1.7.0/entryscape/api/entry_api.py +474 -387
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/idea_api.py +46 -5
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/job_api.py +5 -5
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/model_api.py +32 -32
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/model_class_api.py +20 -20
- entryscape-1.7.0/entryscape/api/model_diagram_api.py +3418 -0
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/model_field_api.py +32 -32
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/model_form_api.py +32 -32
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/model_namespace_api.py +32 -32
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/model_property_api.py +20 -20
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/organization_api.py +49 -8
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/search_api.py +58 -8
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/showcase_api.py +46 -5
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/suggestion_api.py +46 -5
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/terminology_api.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api/upload_api.py +8 -8
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api_client.py +3 -3
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/configuration.py +4 -4
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/exceptions.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/__init__.py +19 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/app_token.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/app_token_create_request.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/app_token_create_response.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/app_token_status.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/app_token_verify_request.py +2 -2
- entryscape-1.7.0/entryscape/models/configuration_provenance.py +120 -0
- entryscape-1.7.0/entryscape/models/configuration_source.py +117 -0
- entryscape-1.7.0/entryscape/models/configured_entity_type.py +184 -0
- entryscape-1.7.0/entryscape/models/configured_entity_type_role.py +36 -0
- entryscape-1.7.0/entryscape/models/configured_entry_list.py +139 -0
- entryscape-1.7.0/entryscape/models/configured_entry_parent.py +124 -0
- entryscape-1.7.0/entryscape/models/configured_entry_reference.py +165 -0
- entryscape-1.7.0/entryscape/models/configured_entry_write.py +131 -0
- entryscape-1.7.0/entryscape/models/configured_entry_write_resource_kind.py +35 -0
- entryscape-1.7.0/entryscape/models/configured_project_type.py +126 -0
- entryscape-1.7.0/entryscape/models/configured_type_relation.py +108 -0
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/entity_list_item.py +11 -3
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/entity_list_response.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/entity_reference.py +10 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/entity_type.py +2 -2
- entryscape-1.7.0/entryscape/models/entity_type_discovery.py +177 -0
- entryscape-1.7.0/entryscape/models/entity_type_discovery_module.py +34 -0
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/error.py +16 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/facet_field.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/facet_field_values_inner.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/facet_list.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/facet_list_available_inner.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/job_response.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/job_status.py +22 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/job_status_progress.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/job_status_value.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/job_type.py +2 -2
- entryscape-1.7.0/entryscape/models/job_warning.py +125 -0
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/list_catalogs_entry_type_parameter.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/list_catalogs_graph_type_parameter.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/list_catalogs_resource_type_parameter.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/login_request.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/login_response.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/metadata_format.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/metadata_request.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/parent_reference.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/search_request.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/search_request_filters.py +8 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/search_request_filters_graph_type.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/search_request_filters_resource_type.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/search_request_sort.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/search_request_sort_order.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/search_response.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/search_result.py +10 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/search_result_graph_type.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/search_result_resource_type.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/search_sort_order_parameter.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/terminology_import_mode.py +2 -2
- entryscape-1.7.0/entryscape/models/validation_outcome.py +40 -0
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/validation_profile.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/validation_response.py +18 -5
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/validation_result.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/validation_severity.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/validation_summary.py +3 -3
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/models/whoami_response.py +2 -2
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/rest.py +14 -3
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape.egg-info/PKG-INFO +29 -3
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape.egg-info/SOURCES.txt +17 -0
- {entryscape-1.6.1 → entryscape-1.7.0}/pyproject.toml +1 -1
- {entryscape-1.6.1 → entryscape-1.7.0}/LICENSE.txt +0 -0
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/api_response.py +0 -0
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape/py.typed +0 -0
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape.egg-info/dependency_links.txt +0 -0
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape.egg-info/requires.txt +0 -0
- {entryscape-1.6.1 → entryscape-1.7.0}/entryscape.egg-info/top_level.txt +0 -0
- {entryscape-1.6.1 → entryscape-1.7.0}/setup.cfg +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: entryscape
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.7.0
|
|
4
4
|
Summary: EntryScape API client for Python - provides access to EntryScape data following DCAT-AP standards
|
|
5
5
|
Author-email: Metasolutions <contact@entryscape.com>
|
|
6
6
|
License-Expression: LGPL-3.0-or-later
|
|
@@ -49,8 +49,8 @@ EntryScape API client for Python - provides access to EntryScape data following
|
|
|
49
49
|
|
|
50
50
|
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
51
51
|
|
|
52
|
-
- API version: 1.
|
|
53
|
-
- Package version: 1.
|
|
52
|
+
- API version: 1.7.0
|
|
53
|
+
- Package version: 1.7.0
|
|
54
54
|
- Generator version: 7.22.0
|
|
55
55
|
|
|
56
56
|
For more information, please visit [https://entryscape.com/en/contact-us/](https://entryscape.com/en/contact-us/)
|
|
@@ -242,6 +242,13 @@ Class | Method | HTTP request | Description
|
|
|
242
242
|
*DocumentApi* | **get_document_metadata** | **GET** /document/{context_id}/{entry_id}/metadata | Get document metadata
|
|
243
243
|
*DocumentApi* | **list_documents** | **GET** /document | List documents
|
|
244
244
|
*DocumentApi* | **update_document_metadata** | **PUT** /document/{context_id}/{entry_id}/metadata | Update document metadata
|
|
245
|
+
*EntityTypeApi* | **discover_entity_types** | **GET** /entity-types/{context_id} | Discover applicable Catalog entity types for a context
|
|
246
|
+
*EntryApi* | **create_configured_entry** | **POST** /entries/{context_id} | Create an entry of a configured Catalog type
|
|
247
|
+
*EntryApi* | **delete_configured_entry** | **DELETE** /entries/{context_id}/{entry_id} | Delete a configured Catalog entry
|
|
248
|
+
*EntryApi* | **get_configured_entry** | **GET** /entries/{context_id}/{entry_id} | Get a configured Catalog entry reference
|
|
249
|
+
*EntryApi* | **get_configured_entry_metadata** | **GET** /entries/{context_id}/{entry_id}/metadata | Get raw RDF metadata for a configured Catalog entry
|
|
250
|
+
*EntryApi* | **list_configured_entries** | **GET** /entries/{context_id} | List entries of one configured Catalog type
|
|
251
|
+
*EntryApi* | **replace_configured_entry_metadata** | **PUT** /entries/{context_id}/{entry_id}/metadata | Replace the complete metadata graph of a configured Catalog entry
|
|
245
252
|
*IdeaApi* | **create_idea** | **POST** /idea | Create idea
|
|
246
253
|
*IdeaApi* | **delete_idea** | **DELETE** /idea/{context_id}/{entry_id} | Delete idea
|
|
247
254
|
*IdeaApi* | **get_idea** | **GET** /idea/{context_id}/{entry_id} | Get idea
|
|
@@ -265,8 +272,10 @@ Class | Method | HTTP request | Description
|
|
|
265
272
|
*ModelDiagramApi* | **delete_model_diagram** | **DELETE** /model/{context_id}/diagrams/{entry_id} | Delete model diagram
|
|
266
273
|
*ModelDiagramApi* | **get_model_diagram** | **GET** /model/{context_id}/diagrams/{entry_id} | Get model diagram
|
|
267
274
|
*ModelDiagramApi* | **get_model_diagram_metadata** | **GET** /model/{context_id}/diagrams/{entry_id}/metadata | Get model diagram metadata
|
|
275
|
+
*ModelDiagramApi* | **get_model_diagram_resource** | **GET** /model/{context_id}/diagrams/{entry_id}/resource | Get model diagram layout
|
|
268
276
|
*ModelDiagramApi* | **list_model_diagrams** | **GET** /model/{context_id}/diagrams | List model diagrams
|
|
269
277
|
*ModelDiagramApi* | **update_model_diagram_metadata** | **PUT** /model/{context_id}/diagrams/{entry_id}/metadata | Update model diagram metadata
|
|
278
|
+
*ModelDiagramApi* | **update_model_diagram_resource** | **PUT** /model/{context_id}/diagrams/{entry_id}/resource | Replace model diagram layout
|
|
270
279
|
*ModelFieldApi* | **create_model_field** | **POST** /model/{context_id}/fields | Create model field
|
|
271
280
|
*ModelFieldApi* | **delete_model_field** | **DELETE** /model/{context_id}/fields/{entry_id} | Delete model field
|
|
272
281
|
*ModelFieldApi* | **get_model_field** | **GET** /model/{context_id}/fields/{entry_id} | Get model field
|
|
@@ -328,10 +337,23 @@ Class | Method | HTTP request | Description
|
|
|
328
337
|
- `AppTokenCreateResponse`
|
|
329
338
|
- `AppTokenStatus`
|
|
330
339
|
- `AppTokenVerifyRequest`
|
|
340
|
+
- `ConfigurationProvenance`
|
|
341
|
+
- `ConfigurationSource`
|
|
342
|
+
- `ConfiguredEntityType`
|
|
343
|
+
- `ConfiguredEntityTypeRole`
|
|
344
|
+
- `ConfiguredEntryList`
|
|
345
|
+
- `ConfiguredEntryParent`
|
|
346
|
+
- `ConfiguredEntryReference`
|
|
347
|
+
- `ConfiguredEntryWrite`
|
|
348
|
+
- `ConfiguredEntryWriteResourceKind`
|
|
349
|
+
- `ConfiguredProjectType`
|
|
350
|
+
- `ConfiguredTypeRelation`
|
|
331
351
|
- `EntityListItem`
|
|
332
352
|
- `EntityListResponse`
|
|
333
353
|
- `EntityReference`
|
|
334
354
|
- `EntityType`
|
|
355
|
+
- `EntityTypeDiscovery`
|
|
356
|
+
- `EntityTypeDiscoveryModule`
|
|
335
357
|
- `Error`
|
|
336
358
|
- `FacetField`
|
|
337
359
|
- `FacetFieldValuesInner`
|
|
@@ -342,6 +364,7 @@ Class | Method | HTTP request | Description
|
|
|
342
364
|
- `JobStatusProgress`
|
|
343
365
|
- `JobStatusValue`
|
|
344
366
|
- `JobType`
|
|
367
|
+
- `JobWarning`
|
|
345
368
|
- `ListCatalogsEntryTypeParameter`
|
|
346
369
|
- `ListCatalogsGraphTypeParameter`
|
|
347
370
|
- `ListCatalogsResourceTypeParameter`
|
|
@@ -362,6 +385,7 @@ Class | Method | HTTP request | Description
|
|
|
362
385
|
- `SearchResultResourceType`
|
|
363
386
|
- `SearchSortOrderParameter`
|
|
364
387
|
- `TerminologyImportMode`
|
|
388
|
+
- `ValidationOutcome`
|
|
365
389
|
- `ValidationProfile`
|
|
366
390
|
- `ValidationResponse`
|
|
367
391
|
- `ValidationResult`
|
|
@@ -373,6 +397,8 @@ Class | Method | HTTP request | Description
|
|
|
373
397
|
<a id="documentation-for-authorization"></a>
|
|
374
398
|
## Documentation For Authorization
|
|
375
399
|
|
|
400
|
+
Redirects are refused to prevent credentials reaching another origin; a 3xx raises an `ApiException` naming the `Location`. Configure the final API URL instead.
|
|
401
|
+
|
|
376
402
|
Authentication schemes defined for the API:
|
|
377
403
|
<a id="auth_token"></a>
|
|
378
404
|
### auth_token
|
|
@@ -7,8 +7,8 @@ EntryScape API client for Python - provides access to EntryScape data following
|
|
|
7
7
|
|
|
8
8
|
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
9
9
|
|
|
10
|
-
- API version: 1.
|
|
11
|
-
- Package version: 1.
|
|
10
|
+
- API version: 1.7.0
|
|
11
|
+
- Package version: 1.7.0
|
|
12
12
|
- Generator version: 7.22.0
|
|
13
13
|
|
|
14
14
|
For more information, please visit [https://entryscape.com/en/contact-us/](https://entryscape.com/en/contact-us/)
|
|
@@ -200,6 +200,13 @@ Class | Method | HTTP request | Description
|
|
|
200
200
|
*DocumentApi* | **get_document_metadata** | **GET** /document/{context_id}/{entry_id}/metadata | Get document metadata
|
|
201
201
|
*DocumentApi* | **list_documents** | **GET** /document | List documents
|
|
202
202
|
*DocumentApi* | **update_document_metadata** | **PUT** /document/{context_id}/{entry_id}/metadata | Update document metadata
|
|
203
|
+
*EntityTypeApi* | **discover_entity_types** | **GET** /entity-types/{context_id} | Discover applicable Catalog entity types for a context
|
|
204
|
+
*EntryApi* | **create_configured_entry** | **POST** /entries/{context_id} | Create an entry of a configured Catalog type
|
|
205
|
+
*EntryApi* | **delete_configured_entry** | **DELETE** /entries/{context_id}/{entry_id} | Delete a configured Catalog entry
|
|
206
|
+
*EntryApi* | **get_configured_entry** | **GET** /entries/{context_id}/{entry_id} | Get a configured Catalog entry reference
|
|
207
|
+
*EntryApi* | **get_configured_entry_metadata** | **GET** /entries/{context_id}/{entry_id}/metadata | Get raw RDF metadata for a configured Catalog entry
|
|
208
|
+
*EntryApi* | **list_configured_entries** | **GET** /entries/{context_id} | List entries of one configured Catalog type
|
|
209
|
+
*EntryApi* | **replace_configured_entry_metadata** | **PUT** /entries/{context_id}/{entry_id}/metadata | Replace the complete metadata graph of a configured Catalog entry
|
|
203
210
|
*IdeaApi* | **create_idea** | **POST** /idea | Create idea
|
|
204
211
|
*IdeaApi* | **delete_idea** | **DELETE** /idea/{context_id}/{entry_id} | Delete idea
|
|
205
212
|
*IdeaApi* | **get_idea** | **GET** /idea/{context_id}/{entry_id} | Get idea
|
|
@@ -223,8 +230,10 @@ Class | Method | HTTP request | Description
|
|
|
223
230
|
*ModelDiagramApi* | **delete_model_diagram** | **DELETE** /model/{context_id}/diagrams/{entry_id} | Delete model diagram
|
|
224
231
|
*ModelDiagramApi* | **get_model_diagram** | **GET** /model/{context_id}/diagrams/{entry_id} | Get model diagram
|
|
225
232
|
*ModelDiagramApi* | **get_model_diagram_metadata** | **GET** /model/{context_id}/diagrams/{entry_id}/metadata | Get model diagram metadata
|
|
233
|
+
*ModelDiagramApi* | **get_model_diagram_resource** | **GET** /model/{context_id}/diagrams/{entry_id}/resource | Get model diagram layout
|
|
226
234
|
*ModelDiagramApi* | **list_model_diagrams** | **GET** /model/{context_id}/diagrams | List model diagrams
|
|
227
235
|
*ModelDiagramApi* | **update_model_diagram_metadata** | **PUT** /model/{context_id}/diagrams/{entry_id}/metadata | Update model diagram metadata
|
|
236
|
+
*ModelDiagramApi* | **update_model_diagram_resource** | **PUT** /model/{context_id}/diagrams/{entry_id}/resource | Replace model diagram layout
|
|
228
237
|
*ModelFieldApi* | **create_model_field** | **POST** /model/{context_id}/fields | Create model field
|
|
229
238
|
*ModelFieldApi* | **delete_model_field** | **DELETE** /model/{context_id}/fields/{entry_id} | Delete model field
|
|
230
239
|
*ModelFieldApi* | **get_model_field** | **GET** /model/{context_id}/fields/{entry_id} | Get model field
|
|
@@ -286,10 +295,23 @@ Class | Method | HTTP request | Description
|
|
|
286
295
|
- `AppTokenCreateResponse`
|
|
287
296
|
- `AppTokenStatus`
|
|
288
297
|
- `AppTokenVerifyRequest`
|
|
298
|
+
- `ConfigurationProvenance`
|
|
299
|
+
- `ConfigurationSource`
|
|
300
|
+
- `ConfiguredEntityType`
|
|
301
|
+
- `ConfiguredEntityTypeRole`
|
|
302
|
+
- `ConfiguredEntryList`
|
|
303
|
+
- `ConfiguredEntryParent`
|
|
304
|
+
- `ConfiguredEntryReference`
|
|
305
|
+
- `ConfiguredEntryWrite`
|
|
306
|
+
- `ConfiguredEntryWriteResourceKind`
|
|
307
|
+
- `ConfiguredProjectType`
|
|
308
|
+
- `ConfiguredTypeRelation`
|
|
289
309
|
- `EntityListItem`
|
|
290
310
|
- `EntityListResponse`
|
|
291
311
|
- `EntityReference`
|
|
292
312
|
- `EntityType`
|
|
313
|
+
- `EntityTypeDiscovery`
|
|
314
|
+
- `EntityTypeDiscoveryModule`
|
|
293
315
|
- `Error`
|
|
294
316
|
- `FacetField`
|
|
295
317
|
- `FacetFieldValuesInner`
|
|
@@ -300,6 +322,7 @@ Class | Method | HTTP request | Description
|
|
|
300
322
|
- `JobStatusProgress`
|
|
301
323
|
- `JobStatusValue`
|
|
302
324
|
- `JobType`
|
|
325
|
+
- `JobWarning`
|
|
303
326
|
- `ListCatalogsEntryTypeParameter`
|
|
304
327
|
- `ListCatalogsGraphTypeParameter`
|
|
305
328
|
- `ListCatalogsResourceTypeParameter`
|
|
@@ -320,6 +343,7 @@ Class | Method | HTTP request | Description
|
|
|
320
343
|
- `SearchResultResourceType`
|
|
321
344
|
- `SearchSortOrderParameter`
|
|
322
345
|
- `TerminologyImportMode`
|
|
346
|
+
- `ValidationOutcome`
|
|
323
347
|
- `ValidationProfile`
|
|
324
348
|
- `ValidationResponse`
|
|
325
349
|
- `ValidationResult`
|
|
@@ -331,6 +355,8 @@ Class | Method | HTTP request | Description
|
|
|
331
355
|
<a id="documentation-for-authorization"></a>
|
|
332
356
|
## Documentation For Authorization
|
|
333
357
|
|
|
358
|
+
Redirects are refused to prevent credentials reaching another origin; a 3xx raises an `ApiException` naming the `Location`. Configure the final API URL instead.
|
|
359
|
+
|
|
334
360
|
Authentication schemes defined for the API:
|
|
335
361
|
<a id="auth_token"></a>
|
|
336
362
|
### auth_token
|
|
@@ -5,16 +5,16 @@
|
|
|
5
5
|
"""
|
|
6
6
|
EntryScape API
|
|
7
7
|
|
|
8
|
-
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
8
|
+
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags or toolsets to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool except the alpha Models API, which is opt-in: `models` adds all seven Models tags, and `all` serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `configured-types` discovers a context's configured entity types and creates, finds, replaces and deletes entries of one exact type, parents and profiles included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
9
9
|
|
|
10
|
-
The version of the OpenAPI document: 1.
|
|
10
|
+
The version of the OpenAPI document: 1.7.0
|
|
11
11
|
Contact: contact@entryscape.com
|
|
12
12
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
13
13
|
|
|
14
14
|
Do not edit the class manually.
|
|
15
15
|
""" # noqa: E501
|
|
16
16
|
|
|
17
|
-
__version__ = "1.
|
|
17
|
+
__version__ = "1.7.0"
|
|
18
18
|
|
|
19
19
|
# Define package exports
|
|
20
20
|
__all__ = [
|
|
@@ -26,6 +26,8 @@ __all__ = [
|
|
|
26
26
|
"DatasetApi",
|
|
27
27
|
"DistributionApi",
|
|
28
28
|
"DocumentApi",
|
|
29
|
+
"EntityTypeApi",
|
|
30
|
+
"EntryApi",
|
|
29
31
|
"IdeaApi",
|
|
30
32
|
"JobApi",
|
|
31
33
|
"ModelApi",
|
|
@@ -55,10 +57,23 @@ __all__ = [
|
|
|
55
57
|
"AppTokenCreateResponse",
|
|
56
58
|
"AppTokenStatus",
|
|
57
59
|
"AppTokenVerifyRequest",
|
|
60
|
+
"ConfigurationProvenance",
|
|
61
|
+
"ConfigurationSource",
|
|
62
|
+
"ConfiguredEntityType",
|
|
63
|
+
"ConfiguredEntityTypeRole",
|
|
64
|
+
"ConfiguredEntryList",
|
|
65
|
+
"ConfiguredEntryParent",
|
|
66
|
+
"ConfiguredEntryReference",
|
|
67
|
+
"ConfiguredEntryWrite",
|
|
68
|
+
"ConfiguredEntryWriteResourceKind",
|
|
69
|
+
"ConfiguredProjectType",
|
|
70
|
+
"ConfiguredTypeRelation",
|
|
58
71
|
"EntityListItem",
|
|
59
72
|
"EntityListResponse",
|
|
60
73
|
"EntityReference",
|
|
61
74
|
"EntityType",
|
|
75
|
+
"EntityTypeDiscovery",
|
|
76
|
+
"EntityTypeDiscoveryModule",
|
|
62
77
|
"Error",
|
|
63
78
|
"FacetField",
|
|
64
79
|
"FacetFieldValuesInner",
|
|
@@ -69,6 +84,7 @@ __all__ = [
|
|
|
69
84
|
"JobStatusProgress",
|
|
70
85
|
"JobStatusValue",
|
|
71
86
|
"JobType",
|
|
87
|
+
"JobWarning",
|
|
72
88
|
"ListCatalogsEntryTypeParameter",
|
|
73
89
|
"ListCatalogsGraphTypeParameter",
|
|
74
90
|
"ListCatalogsResourceTypeParameter",
|
|
@@ -89,6 +105,7 @@ __all__ = [
|
|
|
89
105
|
"SearchResultResourceType",
|
|
90
106
|
"SearchSortOrderParameter",
|
|
91
107
|
"TerminologyImportMode",
|
|
108
|
+
"ValidationOutcome",
|
|
92
109
|
"ValidationProfile",
|
|
93
110
|
"ValidationResponse",
|
|
94
111
|
"ValidationResult",
|
|
@@ -106,6 +123,8 @@ from entryscape.api.dataservice_api import DataserviceApi as DataserviceApi
|
|
|
106
123
|
from entryscape.api.dataset_api import DatasetApi as DatasetApi
|
|
107
124
|
from entryscape.api.distribution_api import DistributionApi as DistributionApi
|
|
108
125
|
from entryscape.api.document_api import DocumentApi as DocumentApi
|
|
126
|
+
from entryscape.api.entity_type_api import EntityTypeApi as EntityTypeApi
|
|
127
|
+
from entryscape.api.entry_api import EntryApi as EntryApi
|
|
109
128
|
from entryscape.api.idea_api import IdeaApi as IdeaApi
|
|
110
129
|
from entryscape.api.job_api import JobApi as JobApi
|
|
111
130
|
from entryscape.api.model_api import ModelApi as ModelApi
|
|
@@ -145,12 +164,51 @@ from entryscape.models.app_token_status import AppTokenStatus as AppTokenStatus
|
|
|
145
164
|
from entryscape.models.app_token_verify_request import (
|
|
146
165
|
AppTokenVerifyRequest as AppTokenVerifyRequest,
|
|
147
166
|
)
|
|
167
|
+
from entryscape.models.configuration_provenance import (
|
|
168
|
+
ConfigurationProvenance as ConfigurationProvenance,
|
|
169
|
+
)
|
|
170
|
+
from entryscape.models.configuration_source import (
|
|
171
|
+
ConfigurationSource as ConfigurationSource,
|
|
172
|
+
)
|
|
173
|
+
from entryscape.models.configured_entity_type import (
|
|
174
|
+
ConfiguredEntityType as ConfiguredEntityType,
|
|
175
|
+
)
|
|
176
|
+
from entryscape.models.configured_entity_type_role import (
|
|
177
|
+
ConfiguredEntityTypeRole as ConfiguredEntityTypeRole,
|
|
178
|
+
)
|
|
179
|
+
from entryscape.models.configured_entry_list import (
|
|
180
|
+
ConfiguredEntryList as ConfiguredEntryList,
|
|
181
|
+
)
|
|
182
|
+
from entryscape.models.configured_entry_parent import (
|
|
183
|
+
ConfiguredEntryParent as ConfiguredEntryParent,
|
|
184
|
+
)
|
|
185
|
+
from entryscape.models.configured_entry_reference import (
|
|
186
|
+
ConfiguredEntryReference as ConfiguredEntryReference,
|
|
187
|
+
)
|
|
188
|
+
from entryscape.models.configured_entry_write import (
|
|
189
|
+
ConfiguredEntryWrite as ConfiguredEntryWrite,
|
|
190
|
+
)
|
|
191
|
+
from entryscape.models.configured_entry_write_resource_kind import (
|
|
192
|
+
ConfiguredEntryWriteResourceKind as ConfiguredEntryWriteResourceKind,
|
|
193
|
+
)
|
|
194
|
+
from entryscape.models.configured_project_type import (
|
|
195
|
+
ConfiguredProjectType as ConfiguredProjectType,
|
|
196
|
+
)
|
|
197
|
+
from entryscape.models.configured_type_relation import (
|
|
198
|
+
ConfiguredTypeRelation as ConfiguredTypeRelation,
|
|
199
|
+
)
|
|
148
200
|
from entryscape.models.entity_list_item import EntityListItem as EntityListItem
|
|
149
201
|
from entryscape.models.entity_list_response import (
|
|
150
202
|
EntityListResponse as EntityListResponse,
|
|
151
203
|
)
|
|
152
204
|
from entryscape.models.entity_reference import EntityReference as EntityReference
|
|
153
205
|
from entryscape.models.entity_type import EntityType as EntityType
|
|
206
|
+
from entryscape.models.entity_type_discovery import (
|
|
207
|
+
EntityTypeDiscovery as EntityTypeDiscovery,
|
|
208
|
+
)
|
|
209
|
+
from entryscape.models.entity_type_discovery_module import (
|
|
210
|
+
EntityTypeDiscoveryModule as EntityTypeDiscoveryModule,
|
|
211
|
+
)
|
|
154
212
|
from entryscape.models.error import Error as Error
|
|
155
213
|
from entryscape.models.facet_field import FacetField as FacetField
|
|
156
214
|
from entryscape.models.facet_field_values_inner import (
|
|
@@ -165,6 +223,7 @@ from entryscape.models.job_status import JobStatus as JobStatus
|
|
|
165
223
|
from entryscape.models.job_status_progress import JobStatusProgress as JobStatusProgress
|
|
166
224
|
from entryscape.models.job_status_value import JobStatusValue as JobStatusValue
|
|
167
225
|
from entryscape.models.job_type import JobType as JobType
|
|
226
|
+
from entryscape.models.job_warning import JobWarning as JobWarning
|
|
168
227
|
from entryscape.models.list_catalogs_entry_type_parameter import (
|
|
169
228
|
ListCatalogsEntryTypeParameter as ListCatalogsEntryTypeParameter,
|
|
170
229
|
)
|
|
@@ -207,6 +266,7 @@ from entryscape.models.search_sort_order_parameter import (
|
|
|
207
266
|
from entryscape.models.terminology_import_mode import (
|
|
208
267
|
TerminologyImportMode as TerminologyImportMode,
|
|
209
268
|
)
|
|
269
|
+
from entryscape.models.validation_outcome import ValidationOutcome as ValidationOutcome
|
|
210
270
|
from entryscape.models.validation_profile import ValidationProfile as ValidationProfile
|
|
211
271
|
from entryscape.models.validation_response import (
|
|
212
272
|
ValidationResponse as ValidationResponse,
|
|
@@ -9,6 +9,8 @@ from entryscape.api.dataservice_api import DataserviceApi
|
|
|
9
9
|
from entryscape.api.dataset_api import DatasetApi
|
|
10
10
|
from entryscape.api.distribution_api import DistributionApi
|
|
11
11
|
from entryscape.api.document_api import DocumentApi
|
|
12
|
+
from entryscape.api.entity_type_api import EntityTypeApi
|
|
13
|
+
from entryscape.api.entry_api import EntryApi
|
|
12
14
|
from entryscape.api.idea_api import IdeaApi
|
|
13
15
|
from entryscape.api.job_api import JobApi
|
|
14
16
|
from entryscape.api.model_api import ModelApi
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
"""
|
|
2
2
|
EntryScape API
|
|
3
3
|
|
|
4
|
-
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
4
|
+
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags or toolsets to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool except the alpha Models API, which is opt-in: `models` adds all seven Models tags, and `all` serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `configured-types` discovers a context's configured entity types and creates, finds, replaces and deletes entries of one exact type, parents and profiles included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.7.0
|
|
7
7
|
Contact: contact@entryscape.com
|
|
8
8
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
9
9
|
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
"""
|
|
2
2
|
EntryScape API
|
|
3
3
|
|
|
4
|
-
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
4
|
+
This API provides structured access to EntryScape data following DCAT-AP standards. All entity endpoints follow a consistent pattern: - GET /{entity} - List all entities - POST /{entity} - Create a new entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id} - Get entity reference info - DELETE /{entity}/{context_id}/{entry_id} - Delete an entity (DCAT types only) - GET /{entity}/{context_id}/{entry_id}/metadata - Get raw RDF metadata - PUT /{entity}/{context_id}/{entry_id}/metadata - Replace raw RDF metadata (JSON-LD, Turtle, RDF/XML, or N-Triples passthrough) ## Reading and consistency Reads of a single entity — `GET /{entity}/{context_id}/{entry_id}` and its `/metadata` — go straight to the store and always reflect the latest write. Lists and search do not. They are answered from a search index that is updated asynchronously, so for a short interval after a write: - an entry that was just created may be missing from the list it belongs to, while reading it by id already works; - an entry that was just deleted may still appear; - `results` counts what the index holds, not what the store holds. Write a client that tolerates this: after creating an entry, use the id the create returned rather than searching for what you just wrote. `results` is also an upper bound rather than an exact count when the caller cannot read every hit (see the field's own description). Separately, responses are cached for 15 minutes by default, which is a second and unrelated source of staleness. A write invalidates the cache entries it affects, but a read that lands in the indexing gap can cache a list that does not yet show it. ## Naming the EntryStore instance One API host can serve multiple EntryStore instances. By default, requests use the deployment's default instance. To target another configured instance, send its hostname (optionally with a port and base path) as either `entrystore_host` or `X-Entrystore-Host`; the query parameter wins if both are provided. A bare hostname means `/store/`, so `luzern.entryscape.net` and `luzern.entryscape.net/store/` identify the same target. The API deployment must allow the instance. Otherwise it returns `400`; ask the deployment operator to add it rather than trying another spelling. Do not include `https://`, credentials, a query string or a fragment. See [Naming the EntryStore instance](https://docs.entryscape.com/en/api/#naming-the-entrystore-instance) for examples and authentication considerations when switching instances. ## Authentication Most endpoints require an authenticated session. Reading public data works without authentication, while creating, updating, and deleting entities requires a valid user session. 1. **Log in** with `POST /auth/login`, supplying an EntryStore username and password. The response returns an `auth_token`. 2. **Send the token** on subsequent requests via the `X-Auth-Token` header. This is the recommended method for SDK and programmatic access. Browser clients can instead rely on the `auth_token` cookie, which the server sets automatically on login (`SameSite=Lax; Secure`). 3. **Inspect the session** with `GET /auth/whoami`, which returns the current user or an anonymous/guest identity when no valid token is supplied. 4. **Log out** with `POST /auth/logout` to invalidate the token and clear the cookie. ### Writes and CSRF Send the token as the `X-Auth-Token` **header** and there is nothing else to do: creates, updates and deletes work as they are, which is how the SDKs and the MCP server are built. The `auth_token` cookie is different. A cookie is attached by the browser automatically, so a state-changing request authenticated by it alone is what cross-site request forgery abuses, and those requests additionally need a double-submit token: read the `XSRF-TOKEN` cookie the server sets on any response and send its value back as the `X-XSRF-TOKEN` header. Without it the request is rejected with `403` before it reaches the endpoint. A custom header cannot be forged this way — cross-origin JavaScript cannot set one without a CORS preflight, which this API grants only to configured origins — so the header is the recommended path for anything that is not a browser session. ### App Tokens An app token identifies an integration. Create one with `POST /app-token` (unauthenticated). Creation requires an email address: the token starts in the `pending` state and a 6-digit code is emailed to the owner. Confirm the code with `POST /app-token/verify` to activate the token and receive its value, which is shown only once — store it securely. `GET /app-token/{app_token_id}` then returns its details and quota usage, authenticated by the token itself via the `X-App-Token` header. **The `X-App-Token` header is accepted only by `GET /app-token/{app_token_id}`.** No other operation reads it, and the read quota is recorded but not yet enforced: reading public data needs no token of any kind, and sending an app token with a read neither grants nor meters anything. Metered public read access is the intent of the two-token model, not a description of this release — see the `security` declared on each operation for what it actually accepts. ## SDKs Generated clients for Python, TypeScript, JavaScript and C# wrap every operation below, and each operation on this page shows the SDK call beside the `curl` command. Three of them install from a public registry: ``` pip install entryscape # Python npm install @entryscape/api-client # TypeScript and JavaScript dotnet add package Entryscape # C# ``` `@entryscape/api-client` ships an ESM and a CommonJS build, so `import` and `require()` both work and TypeScript is not required to use it — the name describes what it is written in, not what you have to write. There is a separate generated JavaScript SDK, and it is deliberately **not** on npm; this package is the npm client for both languages. Every SDK, including the separate JavaScript one, is also published as a tarball. The downloads are linked in the sidebar, they are the route to take when a registry is unreachable or a build has to vendor its dependencies, and each archive carries the SDK's own README: - **Python** — `pip install entryscape`, or `python-sdk.tar.gz`. - **TypeScript and JavaScript** — `npm install @entryscape/api-client`, or `typescript-sdk.tar.gz`. - **JavaScript (the separate generated client)** — not published to a registry, by design; `javascript-sdk.tar.gz` only. - **C#** — `dotnet add package Entryscape`, or `csharp-sdk.tar.gz`. - **MCP server** — `npx -y @entryscape/mcp-server`, or `mcp-server.tar.gz`. ## MCP Server A Model Context Protocol (MCP) server is generated from this specification and published alongside the SDKs (`@entryscape/mcp-server`), exposing the API as tools for AI assistants and agents. Each operation becomes one tool named after its `operationId` — `listDatasets`, `createCatalog`, `search`, `getJobStatus`. The `auth` operations are the exception: the server reads its token once at startup, so a `login` tool could install nothing and a `logout` tool would only invalidate the token the server was started with. On connect the server also hands the assistant a short set of rules that hold across every tool: a token is bound to one EntryStore instance, the search index lags a write, uploads finish as jobs. ### Install The server is on npm, and MCP servers are normally launched straight from there, so nothing has to be installed first: ``` npx -y @entryscape/mcp-server ``` `npm install -g @entryscape/mcp-server` works too and puts an `entryscape-mcp` binary on `PATH`. It is also listed in the MCP Registry as `com.entryscape/mcp-server`, which is where clients and marketplaces look it up. Without npm, download `mcp-server.tar.gz` from the SDK downloads and unpack it. The package ships prebuilt; install its runtime dependency once: ``` mkdir entryscape-mcp && tar -xzf mcp-server.tar.gz -C entryscape-mcp cd entryscape-mcp && npm install --omit=dev ``` ### Configure The server is a stdio MCP server configured through environment variables, read once at startup: - `ENTRYSCAPE_API_URL` — base URL of the API server, path included. Required: there is no default, and the server refuses to start without it. - `ENTRYSCAPE_AUTH_TOKEN` — a session token from `POST /auth/login`, sent as the `X-Auth-Token` header. Optional: without it reads see public entries and every write is refused. A token is valid only for the EntryStore instance that issued it. - `ENTRYSCAPE_ENTRYSTORE_HOST` — the EntryStore instance the API server should use, for example `dev.entryscape.com/store/`. Unset means the API server's own default. - `ENTRYSCAPE_MCP_UPLOAD_ROOT` — the directory the upload tools may read files from. **Unset means uploads are disabled**: `addFileToDistribution`, `replaceFileInDistribution` and `importTerminology` refuse and say so. - `ENTRYSCAPE_MCP_TAGS` — comma-separated tags or toolsets to serve tools for, for example `catalog,dataset,distribution,search`. Unset serves every tool except the alpha Models API, which is opt-in: `models` adds all seven Models tags, and `all` serves every tool. The package's `README.md` lists the remaining variables (timeouts and size caps). Register the server with any MCP-capable client by adding it to the client's `mcpServers` configuration: ```json { \"mcpServers\": { \"entryscape\": { \"command\": \"npx\", \"args\": [\"-y\", \"@entryscape/mcp-server\"], \"env\": { \"ENTRYSCAPE_API_URL\": \"https://<your EntryScape API host>\", \"ENTRYSCAPE_AUTH_TOKEN\": \"your-session-token\" } } } } ``` From an unpacked download instead, the command is `\"command\": \"node\", \"args\": [\"/path/to/entryscape-mcp/dist/bin/entryscape-mcp.js\"]`. ### Claude Code The unpacked package is also a Claude Code plugin, so one install gives the server and the skills below together. Claude Code installs plugins from marketplaces, and the package carries a one-entry marketplace pointing at itself: ``` claude plugin marketplace add /path/to/entryscape-mcp claude plugin install entryscape@entryscape --scope user ``` The plugin passes `ENTRYSCAPE_API_URL`, `ENTRYSCAPE_AUTH_TOKEN`, `ENTRYSCAPE_ENTRYSTORE_HOST`, `ENTRYSCAPE_MCP_TAGS` and `ENTRYSCAPE_MCP_UPLOAD_ROOT` through from the shell Claude Code was started in, so set them there. To try the plugin for one session without installing it, start Claude Code with `--plugin-dir /path/to/entryscape-mcp`. ### Skills `skills/` in the package holds procedures that span several tools, in the Agent Skills format (a `SKILL.md` with `name` and `description`): which tools to call in which order, what to check between calls, and where to stop. Claude Code loads them from the plugin; other clients that read the format can be pointed at the directory. The `find` skill covers discovery, facets and selective metadata reads; `publish-dataset` takes a dataset from catalog to validated distribution with its file; `edit-metadata` changes an entry that already exists without dropping the rest of its graph, models included; `configured-types` discovers a context's configured entity types and creates, finds, replaces and deletes entries of one exact type, parents and profiles included; `migrate-from-taskrunner` moves an integration off the deprecated Taskrunner API. Every tool a skill names is checked against this specification when the package is built. ## Deprecation Policy When endpoints or features are deprecated: 1. The operation is marked with `deprecated: true` in this spec 2. The operation description documents the replacement endpoint and sunset date 3. Deprecated endpoints remain functional for at least 6 months after announcement 4. The server returns a `Sunset` header with the planned removal date 5. After the sunset date, the endpoint may be removed in a future release
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.
|
|
6
|
+
The version of the OpenAPI document: 1.7.0
|
|
7
7
|
Contact: contact@entryscape.com
|
|
8
8
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
9
9
|
|