Publish hidden resources docs (#2501)

nuclia · Sep 27, 2024 · a1a6972 · a1a6972
1 parent c68cfd6
commit a1a6972
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 12 deletions.
diff --git a/nucliadb/src/nucliadb/search/api/v1/find.py b/nucliadb/src/nucliadb/search/api/v1/find.py
@@ -124,7 +124,7 @@ async def find_knowledgebox(
     with_synonyms: bool = fastapi_query(SearchParamDefaults.with_synonyms),
     autofilter: bool = fastapi_query(SearchParamDefaults.autofilter),
     security_groups: list[str] = fastapi_query(SearchParamDefaults.security_groups),
-    show_hidden: bool = fastapi_query(SearchParamDefaults.show_hidden, include_in_schema=False),
+    show_hidden: bool = fastapi_query(SearchParamDefaults.show_hidden),
     reranker: Reranker = fastapi_query(SearchParamDefaults.reranker),
     x_ndb_client: NucliaDBClientType = Header(NucliaDBClientType.API),
     x_nucliadb_user: str = Header(""),

diff --git a/nucliadb/src/nucliadb/search/api/v1/search.py b/nucliadb/src/nucliadb/search/api/v1/search.py
@@ -156,7 +156,7 @@ async def search_knowledgebox(
     with_synonyms: bool = fastapi_query(SearchParamDefaults.with_synonyms),
     autofilter: bool = fastapi_query(SearchParamDefaults.autofilter),
     security_groups: list[str] = fastapi_query(SearchParamDefaults.security_groups),
-    show_hidden: bool = fastapi_query(SearchParamDefaults.show_hidden, include_in_schema=False),
+    show_hidden: bool = fastapi_query(SearchParamDefaults.show_hidden),
     x_ndb_client: NucliaDBClientType = Header(NucliaDBClientType.API),
     x_nucliadb_user: str = Header(""),
     x_forwarded_for: str = Header(""),
@@ -239,7 +239,7 @@ async def catalog_get(
     range_modification_end: Optional[DateTime] = fastapi_query(
         SearchParamDefaults.range_modification_end
     ),
-    hidden: Optional[bool] = fastapi_query(SearchParamDefaults.hidden, include_in_schema=False),
+    hidden: Optional[bool] = fastapi_query(SearchParamDefaults.hidden),
 ) -> Union[KnowledgeboxSearchResults, HTTPClientError]:
     item = CatalogRequest(
         query=query,

diff --git a/nucliadb/src/nucliadb/search/api/v1/suggest.py b/nucliadb/src/nucliadb/search/api/v1/suggest.py
@@ -82,7 +82,7 @@ async def suggest_knowledgebox(
     x_forwarded_for: str = Header(""),
     debug: bool = fastapi_query(SearchParamDefaults.debug),
     highlight: bool = fastapi_query(SearchParamDefaults.highlight),
-    show_hidden: bool = fastapi_query(SearchParamDefaults.show_hidden, include_in_schema=False),
+    show_hidden: bool = fastapi_query(SearchParamDefaults.show_hidden),
 ) -> Union[KnowledgeboxSuggestResults, HTTPClientError]:
     try:
         return await suggest(

diff --git a/nucliadb_models/src/nucliadb_models/resource.py b/nucliadb_models/src/nucliadb_models/resource.py
@@ -25,7 +25,6 @@
 
 from google.protobuf.json_format import MessageToDict
 from pydantic import BaseModel, Field, field_validator, model_validator
-from pydantic.json_schema import SkipJsonSchema
 
 from nucliadb_models.conversation import FieldConversation
 from nucliadb_models.external_index_providers import ExternalIndexProvider
@@ -297,7 +296,7 @@ class Resource(BaseModel):
     last_seqid: Optional[int] = None
     last_account_seq: Optional[int] = None
     queue: Optional[QueueType] = None
-    hidden: SkipJsonSchema[Optional[bool]] = None
+    hidden: Optional[bool] = None
 
     origin: Optional[Origin] = None
     extra: Optional[Extra] = None

diff --git a/nucliadb_models/src/nucliadb_models/search.py b/nucliadb_models/src/nucliadb_models/search.py
@@ -668,7 +668,7 @@ class CatalogRequest(BaseModel):
     range_modification_end: Optional[DateTime] = (
         SearchParamDefaults.range_modification_end.to_pydantic_field()
     )
-    hidden: SkipJsonSchema[Optional[bool]] = SearchParamDefaults.hidden.to_pydantic_field()
+    hidden: Optional[bool] = SearchParamDefaults.hidden.to_pydantic_field()
 
     @field_validator("faceted")
     @classmethod
@@ -736,7 +736,7 @@ class BaseSearchRequest(BaseModel):
     autofilter: bool = SearchParamDefaults.autofilter.to_pydantic_field()
     resource_filters: List[str] = SearchParamDefaults.resource_filters.to_pydantic_field()
     security: Optional[RequestSecurity] = SearchParamDefaults.security.to_pydantic_field()
-    show_hidden: SkipJsonSchema[bool] = SearchParamDefaults.show_hidden.to_pydantic_field()
+    show_hidden: bool = SearchParamDefaults.show_hidden.to_pydantic_field()
 
     rephrase: bool = Field(
         default=False,
@@ -1263,7 +1263,7 @@ class AskRequest(BaseModel):
         le=1.0,
     )
     security: Optional[RequestSecurity] = SearchParamDefaults.security.to_pydantic_field()
-    show_hidden: SkipJsonSchema[bool] = SearchParamDefaults.show_hidden.to_pydantic_field()
+    show_hidden: bool = SearchParamDefaults.show_hidden.to_pydantic_field()
     rag_strategies: list[RagStrategies] = Field(
         default=[],
         title="RAG context building strategies",

diff --git a/nucliadb_models/src/nucliadb_models/writer.py b/nucliadb_models/src/nucliadb_models/writer.py
@@ -21,7 +21,6 @@
 from typing import Dict, List, Optional, Union
 
 from pydantic import BaseModel, Field, field_validator
-from pydantic.json_schema import SkipJsonSchema
 
 from nucliadb_models import content_types
 from nucliadb_models.conversation import InputConversationField
@@ -87,7 +86,7 @@ class CreateResourcePayload(BaseModel):
     fieldmetadata: Optional[List[UserFieldMetadata]] = None
     origin: Optional[InputOrigin] = None
     extra: Optional[Extra] = None
-    hidden: SkipJsonSchema[Optional[bool]] = None
+    hidden: Optional[bool] = None
 
     files: Dict[FieldIdString, FileField] = FieldDefaults.files
     links: Dict[FieldIdString, LinkField] = FieldDefaults.links
@@ -138,7 +137,7 @@ class UpdateResourcePayload(BaseModel):
         title="Security",
         description="Security metadata for the resource. It can be used to have fine-grained control over who can access the resource.",  # noqa
     )
-    hidden: SkipJsonSchema[Optional[bool]] = None
+    hidden: Optional[bool] = None
 
 
 class ResourceCreated(BaseModel):