app.core.items

Items API router - full CRUD for Kumiho items.

Functions

create_item(request[, client])

Create a new item.

delete_item([kref, force, client])

Delete an item.

deprecate_item([kref, deprecated, client])

Deprecate or restore an item.

fulltext_search([query, context, kind, ...])

Full-text fuzzy search across items (Google-like search).

get_item_by_kref([kref, client])

Get an item by its kref.

get_item_by_path([space_path, item_name, ...])

Get an item by its path components.

list_items([space_path, name_filter, ...])

List items in a specific space.

search_items([context_filter, name_filter, ...])

Search for items across the system using pattern/glob matching.

update_item_metadata([kref, request, client])

Update an item's metadata.

async app.core.items.list_items(space_path=Query(PydanticUndefined), name_filter=Query(None), kind_filter=Query(None), client=Depends(dependency=<function get_kumiho_client>, use_cache=True, scope=None))[source]

List items in a specific space.

Parameters:
  • space_path (str)

  • name_filter (str | None)

  • kind_filter (str | None)

  • client (Any)

async app.core.items.search_items(context_filter=Query(None), name_filter=Query(None), kind_filter=Query(None), client=Depends(dependency=<function get_kumiho_client>, use_cache=True, scope=None))[source]

Search for items across the system using pattern/glob matching.

Parameters:
  • context_filter (str | None)

  • name_filter (str | None)

  • kind_filter (str | None)

  • client (Any)

Full-text fuzzy search across items (Google-like search).

Provides Google-like search with automatic typo tolerance. Searches across item names, kinds, usernames, and optionally revision/artifact metadata. Results are ranked by relevance score.

Parameters:
  • query (str)

  • context (str | None)

  • kind (str | None)

  • include_deprecated (bool)

  • include_revision_metadata (bool)

  • include_artifact_metadata (bool)

  • client (Any)

async app.core.items.create_item(request, client=Depends(dependency=<function get_kumiho_client>, use_cache=True, scope=None))[source]

Create a new item.

Parameters:
  • request (ItemCreate)

  • client (Any)

async app.core.items.get_item_by_kref(kref=Query(PydanticUndefined), client=Depends(dependency=<function get_kumiho_client>, use_cache=True, scope=None))[source]

Get an item by its kref.

Parameters:
  • kref (str)

  • client (Any)

async app.core.items.get_item_by_path(space_path=Query(PydanticUndefined), item_name=Query(PydanticUndefined), kind=Query(PydanticUndefined), client=Depends(dependency=<function get_kumiho_client>, use_cache=True, scope=None))[source]

Get an item by its path components.

Parameters:
  • space_path (str)

  • item_name (str)

  • kind (str)

  • client (Any)

async app.core.items.update_item_metadata(kref=Query(PydanticUndefined), request=None, client=Depends(dependency=<function get_kumiho_client>, use_cache=True, scope=None))[source]

Update an item’s metadata.

Parameters:
  • kref (str)

  • request (ItemUpdate | None)

  • client (Any)

async app.core.items.delete_item(kref=Query(PydanticUndefined), force=Query(False), client=Depends(dependency=<function get_kumiho_client>, use_cache=True, scope=None))[source]

Delete an item.

Parameters:
  • kref (str)

  • force (bool)

  • client (Any)

async app.core.items.deprecate_item(kref=Query(PydanticUndefined), deprecated=Query(True), client=Depends(dependency=<function get_kumiho_client>, use_cache=True, scope=None))[source]

Deprecate or restore an item.

Parameters:
  • kref (str)

  • deprecated (bool)

  • client (Any)