Skip to content

Commit 18ed7bc

Browse files
fix(docs/api): remove references to nonexistent types
1 parent 03d1cdb commit 18ed7bc

File tree

1 file changed

+8
-33
lines changed

1 file changed

+8
-33
lines changed

api.md

Lines changed: 8 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,19 @@ Methods:
1515
Types:
1616

1717
```python
18-
from hubmap_search_sdk.types import (
19-
Dataset,
20-
SearchExecuteIndexQueryResponse,
21-
SearchExecuteQueryResponse,
22-
)
18+
from hubmap_search_sdk.types import Dataset
2319
```
2420

2521
Methods:
2622

27-
- <code title="post /{index_name}/search">client.search.<a href="./src/hubmap_search_sdk/resources/search.py">execute_index_query</a>(index_name, \*\*<a href="src/hubmap_search_sdk/types/search_execute_index_query_params.py">params</a>) -> <a href="./src/hubmap_search_sdk/types/search_execute_index_query_response.py">object</a></code>
28-
- <code title="post /search">client.search.<a href="./src/hubmap_search_sdk/resources/search.py">execute_query</a>(\*\*<a href="src/hubmap_search_sdk/types/search_execute_query_params.py">params</a>) -> <a href="./src/hubmap_search_sdk/types/search_execute_query_response.py">object</a></code>
23+
- <code title="post /{index_name}/search">client.search.<a href="./src/hubmap_search_sdk/resources/search.py">execute_index_query</a>(index_name, \*\*<a href="src/hubmap_search_sdk/types/search_execute_index_query_params.py">params</a>) -> object</code>
24+
- <code title="post /search">client.search.<a href="./src/hubmap_search_sdk/resources/search.py">execute_query</a>(\*\*<a href="src/hubmap_search_sdk/types/search_execute_query_params.py">params</a>) -> object</code>
2925

3026
# ParamSearch
3127

32-
Types:
33-
34-
```python
35-
from hubmap_search_sdk.types import ParamSearchExecuteResponse
36-
```
37-
3828
Methods:
3929

40-
- <code title="get /param-search/{entity_type}">client.param_search.<a href="./src/hubmap_search_sdk/resources/param_search.py">execute</a>(entity_type, \*\*<a href="src/hubmap_search_sdk/types/param_search_execute_params.py">params</a>) -> <a href="./src/hubmap_search_sdk/types/param_search_execute_response.py">object</a></code>
30+
- <code title="get /param-search/{entity_type}">client.param_search.<a href="./src/hubmap_search_sdk/resources/param_search.py">execute</a>(entity_type, \*\*<a href="src/hubmap_search_sdk/types/param_search_execute_params.py">params</a>) -> object</code>
4131

4232
# Reindex
4333

@@ -47,32 +37,17 @@ Methods:
4737

4838
# Mget
4939

50-
Types:
51-
52-
```python
53-
from hubmap_search_sdk.types import (
54-
MgetRetrieveMultipleResponse,
55-
MgetRetrieveMultipleByIndexResponse,
56-
)
57-
```
58-
5940
Methods:
6041

61-
- <code title="post /mget">client.mget.<a href="./src/hubmap_search_sdk/resources/mget.py">retrieve_multiple</a>(\*\*<a href="src/hubmap_search_sdk/types/mget_retrieve_multiple_params.py">params</a>) -> <a href="./src/hubmap_search_sdk/types/mget_retrieve_multiple_response.py">object</a></code>
62-
- <code title="post /{index_name}/mget">client.mget.<a href="./src/hubmap_search_sdk/resources/mget.py">retrieve_multiple_by_index</a>(index_name, \*\*<a href="src/hubmap_search_sdk/types/mget_retrieve_multiple_by_index_params.py">params</a>) -> <a href="./src/hubmap_search_sdk/types/mget_retrieve_multiple_by_index_response.py">object</a></code>
42+
- <code title="post /mget">client.mget.<a href="./src/hubmap_search_sdk/resources/mget.py">retrieve_multiple</a>(\*\*<a href="src/hubmap_search_sdk/types/mget_retrieve_multiple_params.py">params</a>) -> object</code>
43+
- <code title="post /{index_name}/mget">client.mget.<a href="./src/hubmap_search_sdk/resources/mget.py">retrieve_multiple_by_index</a>(index_name, \*\*<a href="src/hubmap_search_sdk/types/mget_retrieve_multiple_by_index_params.py">params</a>) -> object</code>
6344

6445
# Mapping
6546

66-
Types:
67-
68-
```python
69-
from hubmap_search_sdk.types import MappingRetrieveDefaultResponse, MappingRetrieveIndexResponse
70-
```
71-
7247
Methods:
7348

74-
- <code title="get /mapping">client.mapping.<a href="./src/hubmap_search_sdk/resources/mapping.py">retrieve_default</a>() -> <a href="./src/hubmap_search_sdk/types/mapping_retrieve_default_response.py">object</a></code>
75-
- <code title="get /{index_name}/mapping">client.mapping.<a href="./src/hubmap_search_sdk/resources/mapping.py">retrieve_index</a>(index_name) -> <a href="./src/hubmap_search_sdk/types/mapping_retrieve_index_response.py">object</a></code>
49+
- <code title="get /mapping">client.mapping.<a href="./src/hubmap_search_sdk/resources/mapping.py">retrieve_default</a>() -> object</code>
50+
- <code title="get /{index_name}/mapping">client.mapping.<a href="./src/hubmap_search_sdk/resources/mapping.py">retrieve_index</a>(index_name) -> object</code>
7651

7752
# Update
7853

0 commit comments

Comments
 (0)