update openapi spec

comet-ml · Nov 6, 2024 · 22a431f · 22a431f
1 parent 35ed985
commit 22a431f
Show file tree

Hide file tree

Showing 10 changed files with 65 additions and 110 deletions.
diff --git a/sdks/python/code_generation/fern/openapi/openapi.yaml b/sdks/python/code_generation/fern/openapi/openapi.yaml
@@ -699,6 +699,10 @@ paths:
         in: query
         schema:
           type: string
+      - name: sorting
+        in: query
+        schema:
+          type: string
       responses:
         "200":
           description: Project resource
@@ -968,7 +972,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/Prompt_Write'
+              $ref: '#/components/schemas/Prompt_Updatable'
       responses:
         "204":
           description: No content
@@ -1012,20 +1016,14 @@ paths:
       responses:
         "204":
           description: No content
-  /v1/private/prompts/{id}/versions/{versionId}:
+  /v1/private/prompts/versions/{versionId}:
     get:
       tags:
       - Prompts
       summary: Get prompt version by id
       description: Get prompt version by id
       operationId: getPromptVersionById
       parameters:
-      - name: id
-        in: path
-        required: true
-        schema:
-          type: string
-          format: uuid
       - name: versionId
         in: path
         required: true
@@ -1080,7 +1078,7 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/PromptVersionPage_Public'
-  /v1/private/prompts/prompts/versions/retrieve:
+  /v1/private/prompts/versions/retrieve:
     post:
       tags:
       - Prompts
@@ -2923,6 +2921,10 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/Project_Public'
+        sortableBy:
+          type: array
+          items:
+            type: string
     Project_Public:
       required:
       - name
@@ -3014,8 +3016,10 @@ components:
           format: uuid
           readOnly: true
         commit:
+          pattern: "^[a-zA-Z0-9]{8}$"
           type: string
-          description: "version short unique identifier, generated if absent"
+          description: "version short unique identifier, generated if absent. it must\
+            \ be 8 characters long"
         template:
           type: string
         variables:
@@ -3063,8 +3067,10 @@ components:
           format: uuid
           readOnly: true
         commit:
+          pattern: "^[a-zA-Z0-9]{8}$"
           type: string
-          description: "version short unique identifier, generated if absent"
+          description: "version short unique identifier, generated if absent. it must\
+            \ be 8 characters long"
         template:
           type: string
         variables:
@@ -3151,6 +3157,8 @@ components:
           items:
             $ref: '#/components/schemas/PromptVersion_Public'
     PromptVersion_Public:
+      required:
+      - template
       type: object
       properties:
         id:
@@ -3162,8 +3170,12 @@ components:
           format: uuid
           readOnly: true
         commit:
+          pattern: "^[a-zA-Z0-9]{8}$"
+          type: string
+          description: "version short unique identifier, generated if absent. it must\
+            \ be 8 characters long"
+        template:
           type: string
-          description: "version short unique identifier, generated if absent"
         created_at:
           type: string
           format: date-time
@@ -3227,6 +3239,16 @@ components:
           type: string
         commit:
           type: string
+    Prompt_Updatable:
+      required:
+      - name
+      type: object
+      properties:
+        name:
+          type: string
+        description:
+          pattern: (?s)^\s*(\S.*\S|\S)\s*$
+          type: string
     Span:
       required:
       - name

diff --git a/sdks/python/src/opik/rest_api/__init__.py b/sdks/python/src/opik/rest_api/__init__.py
@@ -89,7 +89,6 @@
     PromptVersionDetail,
     PromptVersionPagePublic,
     PromptVersionPublic,
-    PromptWrite,
     Span,
     SpanBatch,
     SpanPagePublic,
@@ -223,7 +222,6 @@
     "PromptVersionDetail",
     "PromptVersionPagePublic",
     "PromptVersionPublic",
-    "PromptWrite",
     "Span",
     "SpanBatch",
     "SpanPagePublic",

diff --git a/sdks/python/src/opik/rest_api/projects/client.py b/sdks/python/src/opik/rest_api/projects/client.py
@@ -28,6 +28,7 @@ def find_projects(
         page: typing.Optional[int] = None,
         size: typing.Optional[int] = None,
         name: typing.Optional[str] = None,
+        sorting: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ProjectPagePublic:
         """
@@ -41,6 +42,8 @@ def find_projects(
 
         name : typing.Optional[str]
 
+        sorting : typing.Optional[str]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -59,7 +62,7 @@ def find_projects(
         _response = self._client_wrapper.httpx_client.request(
             "v1/private/projects",
             method="GET",
-            params={"page": page, "size": size, "name": name},
+            params={"page": page, "size": size, "name": name, "sorting": sorting},
             request_options=request_options,
         )
         try:
@@ -277,6 +280,7 @@ async def find_projects(
         page: typing.Optional[int] = None,
         size: typing.Optional[int] = None,
         name: typing.Optional[str] = None,
+        sorting: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ProjectPagePublic:
         """
@@ -290,6 +294,8 @@ async def find_projects(
 
         name : typing.Optional[str]
 
+        sorting : typing.Optional[str]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -316,7 +322,7 @@ async def main() -> None:
         _response = await self._client_wrapper.httpx_client.request(
             "v1/private/projects",
             method="GET",
-            params={"page": page, "size": size, "name": name},
+            params={"page": page, "size": size, "name": name, "sorting": sorting},
             request_options=request_options,
         )
         try:

diff --git a/sdks/python/src/opik/rest_api/prompts/client.py b/sdks/python/src/opik/rest_api/prompts/client.py
@@ -253,29 +253,23 @@ def get_prompt_by_id(
 
     def update_prompt(
         self,
-        id_: str,
+        id: str,
         *,
         name: str,
-        id: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
-        template: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
         Update prompt
 
         Parameters
         ----------
-        id_ : str
+        id : str
 
         name : str
 
-        id : typing.Optional[str]
-
         description : typing.Optional[str]
 
-        template : typing.Optional[str]
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -289,19 +283,14 @@ def update_prompt(
 
         client = OpikApi()
         client.prompts.update_prompt(
-            id_="id",
+            id="id",
             name="name",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"v1/private/prompts/{jsonable_encoder(id_)}",
+            f"v1/private/prompts/{jsonable_encoder(id)}",
             method="PUT",
-            json={
-                "id": id,
-                "name": name,
-                "description": description,
-                "template": template,
-            },
+            json={"name": name, "description": description},
             request_options=request_options,
             omit=OMIT,
         )
@@ -370,7 +359,6 @@ def delete_prompt(
 
     def get_prompt_version_by_id(
         self,
-        id: str,
         version_id: str,
         *,
         request_options: typing.Optional[RequestOptions] = None,
@@ -380,8 +368,6 @@ def get_prompt_version_by_id(
 
         Parameters
         ----------
-        id : str
-
         version_id : str
 
         request_options : typing.Optional[RequestOptions]
@@ -398,12 +384,11 @@ def get_prompt_version_by_id(
 
         client = OpikApi()
         client.prompts.get_prompt_version_by_id(
-            id="id",
             version_id="versionId",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"v1/private/prompts/{jsonable_encoder(id)}/versions/{jsonable_encoder(version_id)}",
+            f"v1/private/prompts/versions/{jsonable_encoder(version_id)}",
             method="GET",
             request_options=request_options,
         )
@@ -505,7 +490,7 @@ def retrieve_prompt_version(
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            "v1/private/prompts/prompts/versions/retrieve",
+            "v1/private/prompts/versions/retrieve",
             method="POST",
             json={"name": name, "commit": commit},
             request_options=request_options,
@@ -796,29 +781,23 @@ async def main() -> None:
 
     async def update_prompt(
         self,
-        id_: str,
+        id: str,
         *,
         name: str,
-        id: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
-        template: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
         Update prompt
 
         Parameters
         ----------
-        id_ : str
+        id : str
 
         name : str
 
-        id : typing.Optional[str]
-
         description : typing.Optional[str]
 
-        template : typing.Optional[str]
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -837,22 +816,17 @@ async def update_prompt(
 
         async def main() -> None:
             await client.prompts.update_prompt(
-                id_="id",
+                id="id",
                 name="name",
             )
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"v1/private/prompts/{jsonable_encoder(id_)}",
+            f"v1/private/prompts/{jsonable_encoder(id)}",
             method="PUT",
-            json={
-                "id": id,
-                "name": name,
-                "description": description,
-                "template": template,
-            },
+            json={"name": name, "description": description},
             request_options=request_options,
             omit=OMIT,
         )
@@ -929,7 +903,6 @@ async def main() -> None:
 
     async def get_prompt_version_by_id(
         self,
-        id: str,
         version_id: str,
         *,
         request_options: typing.Optional[RequestOptions] = None,
@@ -939,8 +912,6 @@ async def get_prompt_version_by_id(
 
         Parameters
         ----------
-        id : str
-
         version_id : str
 
         request_options : typing.Optional[RequestOptions]
@@ -962,15 +933,14 @@ async def get_prompt_version_by_id(
 
         async def main() -> None:
             await client.prompts.get_prompt_version_by_id(
-                id="id",
                 version_id="versionId",
             )
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"v1/private/prompts/{jsonable_encoder(id)}/versions/{jsonable_encoder(version_id)}",
+            f"v1/private/prompts/versions/{jsonable_encoder(version_id)}",
             method="GET",
             request_options=request_options,
         )
@@ -1088,7 +1058,7 @@ async def main() -> None:
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "v1/private/prompts/prompts/versions/retrieve",
+            "v1/private/prompts/versions/retrieve",
             method="POST",
             json={"name": name, "commit": commit},
             request_options=request_options,