hubmap-search-sdk 1.0.0a11__tar.gz → 1.0.0a12__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (97) hide show
  1. hubmap_search_sdk-1.0.0a12/.release-please-manifest.json +3 -0
  2. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/CHANGELOG.md +13 -0
  3. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/PKG-INFO +1 -1
  4. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/SECURITY.md +2 -2
  5. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/api.md +8 -33
  6. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/pyproject.toml +1 -1
  7. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_version.py +1 -1
  8. hubmap_search_sdk-1.0.0a11/.release-please-manifest.json +0 -3
  9. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/.gitignore +0 -0
  10. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/CONTRIBUTING.md +0 -0
  11. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/LICENSE +0 -0
  12. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/README.md +0 -0
  13. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/bin/check-release-environment +0 -0
  14. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/bin/publish-pypi +0 -0
  15. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/examples/.keep +0 -0
  16. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/mypy.ini +0 -0
  17. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/noxfile.py +0 -0
  18. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/release-please-config.json +0 -0
  19. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/requirements-dev.lock +0 -0
  20. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/requirements.lock +0 -0
  21. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/__init__.py +0 -0
  22. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_base_client.py +0 -0
  23. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_client.py +0 -0
  24. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_compat.py +0 -0
  25. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_constants.py +0 -0
  26. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_exceptions.py +0 -0
  27. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_files.py +0 -0
  28. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_models.py +0 -0
  29. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_qs.py +0 -0
  30. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_resource.py +0 -0
  31. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_response.py +0 -0
  32. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_streaming.py +0 -0
  33. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_types.py +0 -0
  34. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_utils/__init__.py +0 -0
  35. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_utils/_logs.py +0 -0
  36. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_utils/_proxy.py +0 -0
  37. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_utils/_reflection.py +0 -0
  38. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_utils/_resources_proxy.py +0 -0
  39. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_utils/_streams.py +0 -0
  40. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_utils/_sync.py +0 -0
  41. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_utils/_transform.py +0 -0
  42. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_utils/_typing.py +0 -0
  43. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/_utils/_utils.py +0 -0
  44. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/lib/.keep +0 -0
  45. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/py.typed +0 -0
  46. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/resources/__init__.py +0 -0
  47. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/resources/add.py +0 -0
  48. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/resources/clear_docs.py +0 -0
  49. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/resources/indices.py +0 -0
  50. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/resources/mapping.py +0 -0
  51. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/resources/mget.py +0 -0
  52. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/resources/param_search.py +0 -0
  53. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/resources/reindex.py +0 -0
  54. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/resources/scroll_search.py +0 -0
  55. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/resources/search.py +0 -0
  56. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/resources/update.py +0 -0
  57. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/types/__init__.py +0 -0
  58. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/types/add_create_document_params.py +0 -0
  59. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/types/add_create_document_with_index_params.py +0 -0
  60. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/types/add_update_document_with_scope_params.py +0 -0
  61. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/types/index_list_response.py +0 -0
  62. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/types/mget_retrieve_multiple_by_index_params.py +0 -0
  63. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/types/mget_retrieve_multiple_params.py +0 -0
  64. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/types/param_search_execute_params.py +0 -0
  65. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/types/scroll_search_create_params.py +0 -0
  66. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/types/search_execute_index_query_params.py +0 -0
  67. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/types/search_execute_query_params.py +0 -0
  68. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/types/update_update_document_at_index_params.py +0 -0
  69. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/types/update_update_document_params.py +0 -0
  70. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/src/hubmap_search_sdk/types/update_update_document_with_scope_params.py +0 -0
  71. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/__init__.py +0 -0
  72. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/api_resources/__init__.py +0 -0
  73. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/api_resources/test_add.py +0 -0
  74. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/api_resources/test_clear_docs.py +0 -0
  75. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/api_resources/test_indices.py +0 -0
  76. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/api_resources/test_mapping.py +0 -0
  77. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/api_resources/test_mget.py +0 -0
  78. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/api_resources/test_param_search.py +0 -0
  79. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/api_resources/test_reindex.py +0 -0
  80. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/api_resources/test_scroll_search.py +0 -0
  81. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/api_resources/test_search.py +0 -0
  82. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/api_resources/test_update.py +0 -0
  83. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/conftest.py +0 -0
  84. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/sample_file.txt +0 -0
  85. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/test_client.py +0 -0
  86. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/test_deepcopy.py +0 -0
  87. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/test_extract_files.py +0 -0
  88. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/test_files.py +0 -0
  89. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/test_models.py +0 -0
  90. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/test_qs.py +0 -0
  91. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/test_required_args.py +0 -0
  92. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/test_response.py +0 -0
  93. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/test_streaming.py +0 -0
  94. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/test_transform.py +0 -0
  95. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/test_utils/test_proxy.py +0 -0
  96. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/test_utils/test_typing.py +0 -0
  97. {hubmap_search_sdk-1.0.0a11 → hubmap_search_sdk-1.0.0a12}/tests/utils.py +0 -0
@@ -0,0 +1,3 @@
1
+ {
2
+ ".": "1.0.0-alpha.12"
3
+ }
@@ -1,5 +1,18 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.0.0-alpha.12 (2025-05-28)
4
+
5
+ Full Changelog: [v1.0.0-alpha.11...v1.0.0-alpha.12](https://github.com/hubmapconsortium/search-python-sdk/compare/v1.0.0-alpha.11...v1.0.0-alpha.12)
6
+
7
+ ### Bug Fixes
8
+
9
+ * **docs/api:** remove references to nonexistent types ([18ed7bc](https://github.com/hubmapconsortium/search-python-sdk/commit/18ed7bc089a16a84d8320455f643fe31de4aa8e1))
10
+
11
+
12
+ ### Chores
13
+
14
+ * **docs:** grammar improvements ([03d1cdb](https://github.com/hubmapconsortium/search-python-sdk/commit/03d1cdbead066a0facb544ed148ba85a4e84a2c9))
15
+
3
16
  ## 1.0.0-alpha.11 (2025-05-17)
4
17
 
5
18
  Full Changelog: [v1.0.0-alpha.10...v1.0.0-alpha.11](https://github.com/hubmapconsortium/search-python-sdk/compare/v1.0.0-alpha.10...v1.0.0-alpha.11)
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: hubmap_search_sdk
3
- Version: 1.0.0a11
3
+ Version: 1.0.0a12
4
4
  Summary: The official Python library for the hubmap-search-sdk API
5
5
  Project-URL: Homepage, https://github.com/hubmapconsortium/search-python-sdk
6
6
  Project-URL: Repository, https://github.com/hubmapconsortium/search-python-sdk
@@ -16,11 +16,11 @@ before making any information public.
16
16
  ## Reporting Non-SDK Related Security Issues
17
17
 
18
18
  If you encounter security issues that are not directly related to SDKs but pertain to the services
19
- or products provided by Hubmap Search SDK please follow the respective company's security reporting guidelines.
19
+ or products provided by Hubmap Search SDK, please follow the respective company's security reporting guidelines.
20
20
 
21
21
  ### Hubmap Search SDK Terms and Policies
22
22
 
23
- Please contact help@hubmapconsortium.org for any questions or concerns regarding security of our services.
23
+ Please contact help@hubmapconsortium.org for any questions or concerns regarding the security of our services.
24
24
 
25
25
  ---
26
26
 
@@ -15,29 +15,19 @@ Methods:
15
15
  Types:
16
16
 
17
17
  ```python
18
- from hubmap_search_sdk.types import (
19
- Dataset,
20
- SearchExecuteIndexQueryResponse,
21
- SearchExecuteQueryResponse,
22
- )
18
+ from hubmap_search_sdk.types import Dataset
23
19
  ```
24
20
 
25
21
  Methods:
26
22
 
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>
29
25
 
30
26
  # ParamSearch
31
27
 
32
- Types:
33
-
34
- ```python
35
- from hubmap_search_sdk.types import ParamSearchExecuteResponse
36
- ```
37
-
38
28
  Methods:
39
29
 
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>
41
31
 
42
32
  # Reindex
43
33
 
@@ -47,32 +37,17 @@ Methods:
47
37
 
48
38
  # Mget
49
39
 
50
- Types:
51
-
52
- ```python
53
- from hubmap_search_sdk.types import (
54
- MgetRetrieveMultipleResponse,
55
- MgetRetrieveMultipleByIndexResponse,
56
- )
57
- ```
58
-
59
40
  Methods:
60
41
 
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>
63
44
 
64
45
  # Mapping
65
46
 
66
- Types:
67
-
68
- ```python
69
- from hubmap_search_sdk.types import MappingRetrieveDefaultResponse, MappingRetrieveIndexResponse
70
- ```
71
-
72
47
  Methods:
73
48
 
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>
76
51
 
77
52
  # Update
78
53
 
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "hubmap_search_sdk"
3
- version = "1.0.0-alpha.11"
3
+ version = "1.0.0-alpha.12"
4
4
  description = "The official Python library for the hubmap-search-sdk API"
5
5
  dynamic = ["readme"]
6
6
  license = "MIT"
@@ -1,4 +1,4 @@
1
1
  # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
3
  __title__ = "hubmap_search_sdk"
4
- __version__ = "1.0.0-alpha.11" # x-release-please-version
4
+ __version__ = "1.0.0-alpha.12" # x-release-please-version
@@ -1,3 +0,0 @@
1
- {
2
- ".": "1.0.0-alpha.11"
3
- }