ksapi 3.15.0__tar.gz → 3.16.0__tar.gz

{ksapi-3.15.0 → ksapi-3.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ksapi
-Version: 3.15.0
+Version: 3.16.0
 Summary: Knowledge Stack API
 Home-page: 
 Author: OpenAPI Generator community

{ksapi-3.15.0 → ksapi-3.16.0}/ksapi/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "3.15.0"
+__version__ = "3.16.0"
 
 # Define package exports
 __all__ = [
@@ -371,6 +371,7 @@ __all__ = [
     "SignInRequest",
     "SignUpResponse",
     "SkillFile",
+    "SkillFileDocument",
     "SkillOrder",
     "SkillResponse",
     "SkillSearchResult",
@@ -848,6 +849,7 @@ from ksapi.models.sheet_visibility_change import SheetVisibilityChange as SheetV
 from ksapi.models.sign_in_request import SignInRequest as SignInRequest
 from ksapi.models.sign_up_response import SignUpResponse as SignUpResponse
 from ksapi.models.skill_file import SkillFile as SkillFile
+from ksapi.models.skill_file_document import SkillFileDocument as SkillFileDocument
 from ksapi.models.skill_order import SkillOrder as SkillOrder
 from ksapi.models.skill_response import SkillResponse as SkillResponse
 from ksapi.models.skill_search_result import SkillSearchResult as SkillSearchResult

{ksapi-3.15.0 → ksapi-3.16.0}/ksapi/api_client.py

@@ -91,7 +91,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/3.15.0/python'
+        self.user_agent = 'OpenAPI-Generator/3.16.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{ksapi-3.15.0 → ksapi-3.16.0}/ksapi/configuration.py

@@ -562,7 +562,7 @@ conf = ksapi.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 0.1.0\n"\
-               "SDK Package Version: 3.15.0".\
+               "SDK Package Version: 3.16.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

{ksapi-3.15.0 → ksapi-3.16.0}/ksapi/models/__init__.py

@@ -314,6 +314,7 @@ from ksapi.models.sheet_visibility_change import SheetVisibilityChange
 from ksapi.models.sign_in_request import SignInRequest
 from ksapi.models.sign_up_response import SignUpResponse
 from ksapi.models.skill_file import SkillFile
+from ksapi.models.skill_file_document import SkillFileDocument
 from ksapi.models.skill_order import SkillOrder
 from ksapi.models.skill_response import SkillResponse
 from ksapi.models.skill_search_result import SkillSearchResult

ksapi-3.16.0/ksapi/models/skill_file_document.py

@@ -0,0 +1,91 @@
+# coding: utf-8
+
+"""
+    Knowledge Stack API
+
+    Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user's live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema's `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call. 
+
+    The version of the OpenAPI document: 0.1.0
+    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, StrictStr
+from typing import Any, ClassVar, Dict
+from uuid import UUID
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class SkillFileDocument(BaseModel):
+    """
+    SkillFileDocument
+    """ # noqa: E501
+    path: StrictStr = Field(description="Path relative to the skill root, e.g. SKILL.md")
+    document_id: UUID = Field(description="The file's Document id, as used in an @[doc:<id>] reference")
+    __properties: ClassVar[List[str]] = ["path", "document_id"]
+
+    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 SkillFileDocument 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 SkillFileDocument from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "path": obj.get("path"),
+            "document_id": obj.get("document_id")
+        })
+        return _obj
+
+

{ksapi-3.15.0 → ksapi-3.16.0}/ksapi/models/skill_response.py

@@ -24,6 +24,7 @@ from uuid import UUID
 from ksapi.models.item_permissions import ItemPermissions
 from ksapi.models.path_part_approval_state import PathPartApprovalState
 from ksapi.models.skill_file import SkillFile
+from ksapi.models.skill_file_document import SkillFileDocument
 from ksapi.models.user_info import UserInfo
 from typing import Optional, Set
 from typing_extensions import Self
@@ -44,13 +45,14 @@ class SkillResponse(BaseModel):
     skill_md: Optional[StrictStr] = Field(default=None, description="Full SKILL.md content; populated on the detail read and on mutation responses, null on list.")
     file_paths: Optional[List[StrictStr]] = Field(default=None, description="Bundle file paths relative to the skill root (SKILL.md excluded); populated on the detail read and on mutation responses, empty on list.")
     files: Optional[List[SkillFile]] = Field(default=None, description="Bundle files with their contents; populated only on the detail read (GET /skills/{id}), null on list. Lets the editor read the current file set so a PATCH can safely resubmit the whole set.")
+    file_documents: Optional[List[SkillFileDocument]] = Field(default=None, description="Every working file with its Document id, SKILL.md included, sorted by path; populated with file_paths, empty on list.")
     has_unpublished_changes: Optional[StrictBool] = Field(default=False, description="Whether the working copy differs from the active published version. Always present (incl. list responses) so the UI can flag a skill with an unpublished draft.")
     approval_state: PathPartApprovalState
     owner: Optional[UserInfo] = Field(default=None, description="Creator, or null.")
     created_at: datetime
     updated_at: datetime
     permissions: Optional[ItemPermissions] = Field(default=None, description="Caller's effective rights; populated on the list, detail read, and mutation responses.")
-    __properties: ClassVar[List[str]] = ["part_type", "id", "path_part_id", "parent_path_part_id", "materialized_path", "tenant_id", "name", "description", "skill_md", "file_paths", "files", "has_unpublished_changes", "approval_state", "owner", "created_at", "updated_at", "permissions"]
+    __properties: ClassVar[List[str]] = ["part_type", "id", "path_part_id", "parent_path_part_id", "materialized_path", "tenant_id", "name", "description", "skill_md", "file_paths", "files", "file_documents", "has_unpublished_changes", "approval_state", "owner", "created_at", "updated_at", "permissions"]
 
     @field_validator('part_type')
     def part_type_validate_enum(cls, value):
@@ -108,6 +110,13 @@ class SkillResponse(BaseModel):
                 if _item_files:
                     _items.append(_item_files.to_dict())
             _dict['files'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in file_documents (list)
+        _items = []
+        if self.file_documents:
+            for _item_file_documents in self.file_documents:
+                if _item_file_documents:
+                    _items.append(_item_file_documents.to_dict())
+            _dict['file_documents'] = _items
         # override the default output from pydantic by calling `to_dict()` of owner
         if self.owner:
             _dict['owner'] = self.owner.to_dict()
@@ -162,6 +171,7 @@ class SkillResponse(BaseModel):
             "skill_md": obj.get("skill_md"),
             "file_paths": obj.get("file_paths"),
             "files": [SkillFile.from_dict(_item) for _item in obj["files"]] if obj.get("files") is not None else None,
+            "file_documents": [SkillFileDocument.from_dict(_item) for _item in obj["file_documents"]] if obj.get("file_documents") is not None else None,
             "has_unpublished_changes": obj.get("has_unpublished_changes") if obj.get("has_unpublished_changes") is not None else False,
             "approval_state": obj.get("approval_state"),
             "owner": UserInfo.from_dict(obj["owner"]) if obj.get("owner") is not None else None,

{ksapi-3.15.0 → ksapi-3.16.0}/ksapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ksapi
-Version: 3.15.0
+Version: 3.16.0
 Summary: Knowledge Stack API
 Home-page: 
 Author: OpenAPI Generator community

{ksapi-3.15.0 → ksapi-3.16.0}/ksapi.egg-info/SOURCES.txt

@@ -359,6 +359,7 @@ ksapi/models/sheet_visibility_change.py
 ksapi/models/sign_in_request.py
 ksapi/models/sign_up_response.py
 ksapi/models/skill_file.py
+ksapi/models/skill_file_document.py
 ksapi/models/skill_order.py
 ksapi/models/skill_response.py
 ksapi/models/skill_search_result.py
@@ -805,6 +806,7 @@ test/test_sheet_visibility_change.py
 test/test_sign_in_request.py
 test/test_sign_up_response.py
 test/test_skill_file.py
+test/test_skill_file_document.py
 test/test_skill_order.py
 test/test_skill_response.py
 test/test_skill_search_result.py

{ksapi-3.15.0 → ksapi-3.16.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ksapi"
-version = "3.15.0"
+version = "3.16.0"
 description = "Knowledge Stack API"
 authors = [
   {name = "OpenAPI Generator Community",email = "team@openapitools.org"},

{ksapi-3.15.0 → ksapi-3.16.0}/setup.py

@@ -19,7 +19,7 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "ksapi"
-VERSION = "3.15.0"
+VERSION = "3.16.0"
 PYTHON_REQUIRES = ">= 3.9"
 REQUIRES = [
     "urllib3 >= 2.1.0, < 3.0.0",

{ksapi-3.15.0 → ksapi-3.16.0}/test/test_folder_response_or_document_response_or_workflow_definition_response_or_workflow_run_response_or_data_source_response_or_data_source_schema_r.py

@@ -292,6 +292,11 @@ class TestFolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflow
                         content = '', 
                         encoding = 'utf-8', )
                     ],
+                file_documents = [
+                    ksapi.models.skill_file_document.SkillFileDocument(
+                        path = '', 
+                        document_id = '', )
+                    ],
                 has_unpublished_changes = True
             )
         else:

{ksapi-3.15.0 → ksapi-3.16.0}/test/test_paginated_response_skill_response.py

@@ -55,6 +55,11 @@ class TestPaginatedResponseSkillResponse(unittest.TestCase):
                                 content = '', 
                                 encoding = 'utf-8', )
                             ], 
+                        file_documents = [
+                            ksapi.models.skill_file_document.SkillFileDocument(
+                                path = '', 
+                                document_id = '', )
+                            ], 
                         has_unpublished_changes = True, 
                         approval_state = 'not_required', 
                         owner = null, 
@@ -88,6 +93,11 @@ class TestPaginatedResponseSkillResponse(unittest.TestCase):
                                 content = '', 
                                 encoding = 'utf-8', )
                             ], 
+                        file_documents = [
+                            ksapi.models.skill_file_document.SkillFileDocument(
+                                path = '', 
+                                document_id = '', )
+                            ], 
                         has_unpublished_changes = True, 
                         approval_state = 'not_required', 
                         owner = null, 

ksapi-3.16.0/test/test_skill_file_document.py

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+"""
+    Knowledge Stack API
+
+    Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user's live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema's `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call. 
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from ksapi.models.skill_file_document import SkillFileDocument
+
+class TestSkillFileDocument(unittest.TestCase):
+    """SkillFileDocument unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> SkillFileDocument:
+        """Test SkillFileDocument
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `SkillFileDocument`
+        """
+        model = SkillFileDocument()
+        if include_optional:
+            return SkillFileDocument(
+                path = '',
+                document_id = ''
+            )
+        else:
+            return SkillFileDocument(
+                path = '',
+                document_id = '',
+        )
+        """
+
+    def testSkillFileDocument(self):
+        """Test SkillFileDocument"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

{ksapi-3.15.0 → ksapi-3.16.0}/test/test_skill_response.py

@@ -53,6 +53,11 @@ class TestSkillResponse(unittest.TestCase):
                         content = '', 
                         encoding = 'utf-8', )
                     ],
+                file_documents = [
+                    ksapi.models.skill_file_document.SkillFileDocument(
+                        path = '', 
+                        document_id = '', )
+                    ],
                 has_unpublished_changes = True,
                 approval_state = 'not_required',
                 owner = ksapi.models.user_info.UserInfo(