Remove sdk documentation logic (#2205)

nuclia · May 30, 2024 · fbf4d61 · fbf4d61 · github-actions · May 30, 2024
1 parent fc242f5
commit fbf4d61
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 605 deletions.
diff --git a/nucliadb/nucliadb/search/api/v1/chat.py b/nucliadb/nucliadb/search/api/v1/chat.py
@@ -95,6 +95,7 @@ class SyncChatResponse(pydantic.BaseModel):
     description="Chat on a Knowledge Box",
     tags=["Search"],
     response_model=None,
+    deprecated=True,
 )
 @requires(NucliaDBRoles.READER)
 @version(1)

diff --git a/nucliadb/nucliadb/search/api/v1/resource/ask.py b/nucliadb/nucliadb/search/api/v1/resource/ask.py
@@ -75,8 +75,6 @@ async def resource_ask_endpoint_by_uuid(
     description="Ask questions to a resource",
     tags=["Search"],
     response_model=SyncAskResponse,
-    # Add this to OpenAPI schema when endpoint is not in beta anymore
-    include_in_schema=False,
 )
 @requires(NucliaDBRoles.READER)
 @version(1)

diff --git a/nucliadb/nucliadb/search/api/v1/resource/chat.py b/nucliadb/nucliadb/search/api/v1/resource/chat.py
@@ -46,6 +46,7 @@
     description="Chat with a resource",
     tags=["Search"],
     response_model=None,
+    deprecated=True,
 )
 @requires(NucliaDBRoles.READER)
 @version(1)
@@ -82,6 +83,7 @@ async def resource_chat_endpoint_by_uuid(
     description="Chat with a resource",
     tags=["Search"],
     response_model=None,
+    deprecated=True,
 )
 @requires(NucliaDBRoles.READER)
 @version(1)

diff --git a/nucliadb_sdk/README.md b/nucliadb_sdk/README.md
@@ -32,16 +32,6 @@ ndb = NucliaDB(region=Region.ON_PREM, api="http://localhost:8080/api")
 
 Then, each method of the `NucliaDB` class maps to an HTTP endpoint of the NucliaDB API. The parameters it accepts correspond to the Pydantic models associated to the request body scheme of the endpoint.
 
-You can use Python's built-in `help` directive to check the list of available methods with their signature:
-
-```python
-from nucliadb_sdk import NucliaDB
-
-help(NucliaDB)
-help(NucliaDB.chat)
-help(NucliaDB.create_resource)
-```
-
 The method-to-endpoint mappings for the sdk are declared in-code [in the _NucliaDBBase class](https://github.com/nuclia/nucliadb/blob/main/nucliadb_sdk/nucliadb_sdk/v2/sdk.py).
 
 For instance, to create a resource in your Knowledge Box, the endpoint is defined [here](https://docs.nuclia.dev/docs/api#tag/Resources/operation/Create_Resource_kb__kbid__resources_post).