entryscape 1.3.0__py3-none-any.whl

entryscape/models/search_request.py

@@ -0,0 +1,158 @@
+# coding: utf-8
+
+"""
+EntryScape API
+
+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.  ## 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. Two of them install from a public registry:  ``` pip install entryscape                 # Python npm install @entryscape/api-client     # TypeScript and JavaScript ```  `@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 C# and JavaScript ones, 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#** — not published to NuGet yet; `csharp-sdk.tar.gz` only. - **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
+
+The version of the OpenAPI document: 1.3.0
+Contact: contact@entryscape.com
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from entryscape.models.search_request_filters import SearchRequestFilters
+from entryscape.models.search_request_sort import SearchRequestSort
+from entryscape.models.search_request_sort_order import SearchRequestSortOrder
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class SearchRequest(BaseModel):
+    """
+    Advanced search request body
+    """  # noqa: E501
+
+    query: Optional[Annotated[str, Field(strict=True, max_length=1000)]] = Field(
+        default=None, description="Full-text search query"
+    )
+    filters: Optional[SearchRequestFilters] = None
+    facets: Optional[
+        Annotated[
+            List[Annotated[str, Field(min_length=1, strict=True, max_length=256)]],
+            Field(max_length=50),
+        ]
+    ] = Field(
+        default=None,
+        description="Fields to compute facets for. Only the fields listed by `GET /search/facets` are accepted; any other field is rejected with 400. ",
+    )
+    facet_limit: Optional[Annotated[int, Field(le=100, strict=True, ge=1)]] = Field(
+        default=10, description="Maximum number of facet values per field"
+    )
+    sort: Optional[SearchRequestSort] = None
+    sort_order: Optional[SearchRequestSortOrder] = SearchRequestSortOrder.DESC
+    limit: Optional[Annotated[int, Field(le=100, strict=True, ge=1)]] = Field(
+        default=50, description="Results per page"
+    )
+    offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(
+        default=0, description="Pagination offset. Ignored when `cursor` is provided. "
+    )
+    cursor: Optional[Annotated[str, Field(strict=True, max_length=512)]] = Field(
+        default=None,
+        description="Opaque cursor token from a previous search response's `next_cursor` field. When provided, `offset` is ignored and results continue from the cursor position. ",
+    )
+    __properties: ClassVar[List[str]] = [
+        "query",
+        "filters",
+        "facets",
+        "facet_limit",
+        "sort",
+        "sort_order",
+        "limit",
+        "offset",
+        "cursor",
+    ]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SearchRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of filters
+        if self.filters:
+            _dict["filters"] = self.filters.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SearchRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        # raise errors for additional fields in the input
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                raise ValueError(
+                    "Error due to additional fields (not defined in SearchRequest) in the input: "
+                    + _key
+                )
+
+        _obj = cls.model_validate(
+            {
+                "query": obj.get("query"),
+                "filters": (
+                    SearchRequestFilters.from_dict(obj["filters"])
+                    if obj.get("filters") is not None
+                    else None
+                ),
+                "facets": obj.get("facets"),
+                "facet_limit": (
+                    obj.get("facet_limit") if obj.get("facet_limit") is not None else 10
+                ),
+                "sort": obj.get("sort"),
+                "sort_order": (
+                    obj.get("sort_order")
+                    if obj.get("sort_order") is not None
+                    else SearchRequestSortOrder.DESC
+                ),
+                "limit": obj.get("limit") if obj.get("limit") is not None else 50,
+                "offset": obj.get("offset") if obj.get("offset") is not None else 0,
+                "cursor": obj.get("cursor"),
+            }
+        )
+        return _obj

entryscape/models/search_request_filters.py

@@ -0,0 +1,144 @@
+# coding: utf-8
+
+"""
+EntryScape API
+
+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.  ## 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. Two of them install from a public registry:  ``` pip install entryscape                 # Python npm install @entryscape/api-client     # TypeScript and JavaScript ```  `@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 C# and JavaScript ones, 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#** — not published to NuGet yet; `csharp-sdk.tar.gz` only. - **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
+
+The version of the OpenAPI document: 1.3.0
+Contact: contact@entryscape.com
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from entryscape.models.search_request_filters_graph_type import (
+    SearchRequestFiltersGraphType,
+)
+from entryscape.models.search_request_filters_resource_type import (
+    SearchRequestFiltersResourceType,
+)
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class SearchRequestFilters(BaseModel):
+    """
+    Filter criteria
+    """  # noqa: E501
+
+    rdf_type: Optional[Annotated[str, Field(strict=True, max_length=2048)]] = Field(
+        default=None, description="Filter by RDF type URI"
+    )
+    context: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(
+        default=None, description="Filter by context ID"
+    )
+    graph_type: Optional[SearchRequestFiltersGraphType] = None
+    resource_type: Optional[SearchRequestFiltersResourceType] = None
+    public: Optional[StrictBool] = Field(
+        default=None, description="Filter by public/private status"
+    )
+    created_after: Optional[datetime] = Field(
+        default=None, description="Filter entries created after this date"
+    )
+    created_before: Optional[datetime] = Field(
+        default=None, description="Filter entries created before this date"
+    )
+    modified_after: Optional[datetime] = Field(
+        default=None, description="Filter entries modified after this date"
+    )
+    modified_before: Optional[datetime] = Field(
+        default=None, description="Filter entries modified before this date"
+    )
+    __properties: ClassVar[List[str]] = [
+        "rdf_type",
+        "context",
+        "graph_type",
+        "resource_type",
+        "public",
+        "created_after",
+        "created_before",
+        "modified_after",
+        "modified_before",
+    ]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SearchRequestFilters from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SearchRequestFilters from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        # raise errors for additional fields in the input
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                raise ValueError(
+                    "Error due to additional fields (not defined in SearchRequestFilters) in the input: "
+                    + _key
+                )
+
+        _obj = cls.model_validate(
+            {
+                "rdf_type": obj.get("rdf_type"),
+                "context": obj.get("context"),
+                "graph_type": obj.get("graph_type"),
+                "resource_type": obj.get("resource_type"),
+                "public": obj.get("public"),
+                "created_after": obj.get("created_after"),
+                "created_before": obj.get("created_before"),
+                "modified_after": obj.get("modified_after"),
+                "modified_before": obj.get("modified_before"),
+            }
+        )
+        return _obj

entryscape/models/search_request_filters_graph_type.py

@@ -0,0 +1,44 @@
+# coding: utf-8
+
+"""
+EntryScape API
+
+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.  ## 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. Two of them install from a public registry:  ``` pip install entryscape                 # Python npm install @entryscape/api-client     # TypeScript and JavaScript ```  `@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 C# and JavaScript ones, 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#** — not published to NuGet yet; `csharp-sdk.tar.gz` only. - **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
+
+The version of the OpenAPI document: 1.3.0
+Contact: contact@entryscape.com
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class SearchRequestFiltersGraphType(str, Enum):
+    """
+    Filter by entry graph type
+    """
+
+    """
+    allowed enum values
+    """
+    NONE = "None"
+    CONTEXT = "Context"
+    SYSTEMCONTEXT = "Systemcontext"
+    USER = "User"
+    GROUP = "Group"
+    LIST = "List"
+    RESULTLIST = "Resultlist"
+    GRAPH = "Graph"
+    STRING = "String"
+    PIPELINE = "Pipeline"
+    PIPELINERESULT = "PipelineResult"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SearchRequestFiltersGraphType from a JSON string"""
+        return cls(json.loads(json_str))

entryscape/models/search_request_filters_resource_type.py

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+"""
+EntryScape API
+
+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.  ## 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. Two of them install from a public registry:  ``` pip install entryscape                 # Python npm install @entryscape/api-client     # TypeScript and JavaScript ```  `@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 C# and JavaScript ones, 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#** — not published to NuGet yet; `csharp-sdk.tar.gz` only. - **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
+
+The version of the OpenAPI document: 1.3.0
+Contact: contact@entryscape.com
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class SearchRequestFiltersResourceType(str, Enum):
+    """
+    Filter by resource type
+    """
+
+    """
+    allowed enum values
+    """
+    INFORMATION = "Information"
+    RESOLVABLE = "Resolvable"
+    NAMED = "Named"
+    UNKNOWN = "Unknown"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SearchRequestFiltersResourceType from a JSON string"""
+        return cls(json.loads(json_str))

entryscape/models/search_request_sort.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+EntryScape API
+
+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.  ## 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. Two of them install from a public registry:  ``` pip install entryscape                 # Python npm install @entryscape/api-client     # TypeScript and JavaScript ```  `@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 C# and JavaScript ones, 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#** — not published to NuGet yet; `csharp-sdk.tar.gz` only. - **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
+
+The version of the OpenAPI document: 1.3.0
+Contact: contact@entryscape.com
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class SearchRequestSort(str, Enum):
+    """
+    Sort field
+    """
+
+    """
+    allowed enum values
+    """
+    TITLE = "title"
+    CREATED = "created"
+    MODIFIED = "modified"
+    SCORE = "score"
+    SIZE = "size"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SearchRequestSort from a JSON string"""
+        return cls(json.loads(json_str))

entryscape/models/search_request_sort_order.py

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+"""
+EntryScape API
+
+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.  ## 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. Two of them install from a public registry:  ``` pip install entryscape                 # Python npm install @entryscape/api-client     # TypeScript and JavaScript ```  `@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 C# and JavaScript ones, 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#** — not published to NuGet yet; `csharp-sdk.tar.gz` only. - **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
+
+The version of the OpenAPI document: 1.3.0
+Contact: contact@entryscape.com
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class SearchRequestSortOrder(str, Enum):
+    """
+    Sort direction
+    """
+
+    """
+    allowed enum values
+    """
+    ASC = "asc"
+    DESC = "desc"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SearchRequestSortOrder from a JSON string"""
+        return cls(json.loads(json_str))