codeocean 0.9.0__tar.gz → 0.9.1__tar.gz

{codeocean-0.9.0 → codeocean-0.9.1}/CHANGELOG.md

@@ -1,10 +1,12 @@
 CHANGELOG
 =========
 
+## 0.9.1 (2025-08-29)
+- [#56](https://github.com/codeocean/codeocean-sdk-python/pull/56) fix: update query description in search APIs
+
 ## 0.9.0 (2025-08-05)
 - [#47](https://github.com/codeocean/codeocean-sdk-python/pull/47) feat: add error handling
 
-
 ## 0.8.0 (2025-07-11)
 - [#50](https://github.com/codeocean/codeocean-sdk-python/pull/50) feat: Add Min-Server-Version header support
 - [#49](https://github.com/codeocean/codeocean-sdk-python/pull/49) feat: Identify AI agents in API requests

{codeocean-0.9.0 → codeocean-0.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codeocean
-Version: 0.9.0
+Version: 0.9.1
 Summary: Code Ocean Python SDK
 Project-URL: Homepage, https://github.com/codeocean/codeocean-sdk-python
 Project-URL: Issues, https://github.com/codeocean/codeocean-sdk-python/issues

{codeocean-0.9.0 → codeocean-0.9.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "codeocean"
-version = "0.9.0"
+version = "0.9.1"
 authors = [
   { name="Code Ocean", email="dev@codeocean.com" },
 ]

{codeocean-0.9.0 → codeocean-0.9.1}/src/codeocean/capsule.py

@@ -140,7 +140,38 @@ class CapsuleSearchParams:
     query: Optional[str] = dataclass_field(
         default=None,
         metadata={
-            "description": "Search query in free text or structured format (name:... tag:...)"
+            "description": """Search expression supporting free text and field:value filters.
+            Valid fields:
+             - id
+             - name
+             - doi
+             - tag
+             - field
+             - affiliation
+             - journal
+             - article
+             - author
+
+            Free text:
+             - Matches across weighted fields (name, tags, description, authors, etc.)
+
+            Syntax rules:
+             - Same field repeated = OR
+             - Different fields = AND
+             - Quotes = exact phrase
+             - No explicit OR operator
+             - No wildcards (*)
+             - Not case sensitive
+
+            Notes:
+             - "description" is not directly searchable; it is covered by free-text matching.
+
+            Examples:
+             - name:RNA-seq tag:genomics
+             - name:"single cell analysis"
+             - Synergy
+             - name:Synergy
+            """
         },
     )
     next_token: Optional[str] = dataclass_field(

{codeocean-0.9.0 → codeocean-0.9.1}/src/codeocean/data_asset.py

@@ -538,8 +538,30 @@ class DataAssetSearchParams:
     query: Optional[str] = field(
         default=None,
         metadata={
-            "description": "Search query in free text or structured format "
-            "(name:... tag:... run_script:... commit_id:...)",
+            "description": """Search expression supporting free text and field:value filters.
+            Valid fields:
+             - name
+             - tag
+             - run_script
+             - commit_id
+             - contained_data_id
+
+            Free text:
+             - Matches across weighted fields (name, tags, description, custom metadata)
+
+            Syntax rules:
+             - Same field repeated = OR
+             - Different fields = AND
+             - Quotes = exact phrase
+             - No explicit OR operator
+             - No wildcards (*)
+             - Not case sensitive
+
+            Examples:
+             - name:RNA-seq tag:genomics
+             - name:"analysis pipeline"
+             - name:Synergy
+            """
         },
     )
     next_token: Optional[str] = field(