Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
9818afd
[SYNPY-1869] Add SearchIndex entity + search-management APIs; rename …
BryanFauble Jul 13, 2026
c721574
[SYNPY-1869] Wire SearchIndex into container traversal; use delete_no…
BryanFauble Jul 13, 2026
40eedeb
merge with develop
linglp Jul 21, 2026
872762e
fix docstring
linglp Jul 21, 2026
0d72f00
clean up
linglp Jul 21, 2026
10fdb9b
fix docstring
linglp Jul 21, 2026
ee0729d
add to docstring
linglp Jul 21, 2026
9620ba3
edit docstring
linglp Jul 21, 2026
ad09eb2
update docstring
linglp Jul 21, 2026
f52f7cf
add docstring
linglp Jul 22, 2026
b6b613f
move SearchIndexSynchronousProtocol to its own test file
linglp Jul 22, 2026
5b188c0
remove __all__ because functions already got added to __init__
linglp Jul 22, 2026
582fbf9
clean up comment
linglp Jul 22, 2026
3da1f40
fix and add parameter explanation in docstring
linglp Jul 22, 2026
4fcb624
fix documentation
linglp Jul 22, 2026
27b6457
add docstring example
linglp Jul 22, 2026
ca211bd
Merge branch 'develop' into synpy-1869-search-index
linglp Jul 22, 2026
6377fd8
add examples to all these data classes
linglp Jul 22, 2026
0630b54
add examples and expand docstring for searchIndex and protocol
linglp Jul 22, 2026
5a794f3
add example to protocol; also separate protocol from search management
linglp Jul 22, 2026
1ebad6f
added integration test for search_management.py
linglp Jul 23, 2026
a29064b
Merge branch 'develop' into synpy-1869-search-index
linglp Jul 23, 2026
2f40743
add to docstring
linglp Jul 23, 2026
e31672c
move test related to auto complete to unit test file for search index…
linglp Jul 23, 2026
7cf8ff0
fix parameter
linglp Jul 23, 2026
b548722
edit docstring
linglp Jul 23, 2026
ec72846
Merge branch 'develop' into synpy-1869-search-index
linglp Jul 23, 2026
44e2e50
remove columns attribute from search index; updated test; also remove…
linglp Jul 23, 2026
a9e747e
hard code include_columns to false
linglp Jul 23, 2026
30a8158
add a deprecation statement to SchemaOrganization instead of complete…
linglp Jul 23, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# SchemaOrganization
# Organization

## API Reference

::: synapseclient.models.SchemaOrganization
::: synapseclient.models.Organization
options:
inherited_members: true
members:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# SchemaOrganization
# Organization

## API Reference

::: synapseclient.models.SchemaOrganization
::: synapseclient.models.Organization
options:
inherited_members: true
members:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/json_schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
!!! warning "Deprecated — removed in v5.0.0"
The legacy `synapseclient.services.json_schema` classes (`JsonSchema`,
`JsonSchemaVersion`, `JsonSchemaOrganization`) are deprecated and will be removed in
**v5.0.0**. Use the object-oriented `JSONSchema` and `SchemaOrganization` models
**v5.0.0**. Use the object-oriented `JSONSchema` and `Organization` models
instead — see the [Working with JSON Schema tutorial](../tutorials/python/json_schema.md).

::: synapseclient.services.json_schema
4 changes: 2 additions & 2 deletions docs/tutorials/python/tutorial_scripts/json_schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

import synapseclient
from synapseclient.core.utils import make_bogus_data_file
from synapseclient.models import File, Folder, JSONSchema, Project, SchemaOrganization
from synapseclient.models import File, Folder, JSONSchema, Organization, Project

# 1. Set up Synapse Python client
syn = synapseclient.Synapse()
Expand Down Expand Up @@ -48,7 +48,7 @@

# 3. Try create test organization and json schema if they do not exist
# --8<-- [start:create_org_and_schema]
organization = SchemaOrganization(name=ORG_NAME)
organization = Organization(name=ORG_NAME)
try:
organization.store()
except Exception as e:
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ nav:
- Curator: reference/experimental/sync/curator.md
- Link: reference/experimental/sync/link_entity.md
- Functional Interfaces: reference/experimental/functional_interfaces.md
- SchemaOrganization: reference/experimental/sync/schema_organization.md
- Organization: reference/experimental/sync/organization.md
- JSONSchema: reference/experimental/sync/json_schema.md
- Wiki: reference/experimental/sync/wiki.md
- FormGroup and Form: reference/experimental/sync/form.md
Expand Down Expand Up @@ -123,7 +123,7 @@ nav:
- UserProfile: reference/experimental/async/user_profile.md
- Curator: reference/experimental/async/curator.md
- Link: reference/experimental/async/link_entity.md
- SchemaOrganization: reference/experimental/async/schema_organization.md
- Organization: reference/experimental/async/organization.md
- JSONSchema: reference/experimental/async/json_schema.md
- Wiki: reference/experimental/async/wiki.md
- FormGroup and Form: reference/experimental/async/form.md
Expand Down
43 changes: 43 additions & 0 deletions synapseclient/api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,28 @@
get_project_setting,
update_project_setting,
)
from .search_services import (
autocomplete_search,
bind_search_config_to_entity,
clear_search_config_binding,
create_column_analyzer_override,
create_search_configuration,
create_synonym_set,
create_text_analyzer,
get_column_analyzer_override,
get_search_config_binding,
get_search_configuration,
get_synonym_set,
get_text_analyzer,
list_column_analyzer_overrides,
list_search_configurations,
list_synonym_sets,
list_text_analyzers,
update_column_analyzer_override,
update_search_configuration,
update_synonym_set,
update_text_analyzer,
)
from .storage_location_services import (
create_storage_location_setting,
get_storage_location_setting,
Expand Down Expand Up @@ -392,4 +414,25 @@
"create_project_setting",
"update_project_setting",
"delete_project_setting",
# search_services
"create_text_analyzer",
"get_text_analyzer",
"update_text_analyzer",
"list_text_analyzers",
"create_column_analyzer_override",
"get_column_analyzer_override",
"update_column_analyzer_override",
"list_column_analyzer_overrides",
"create_synonym_set",
"get_synonym_set",
"update_synonym_set",
"list_synonym_sets",
"create_search_configuration",
"get_search_configuration",
"update_search_configuration",
"list_search_configurations",
"bind_search_config_to_entity",
"get_search_config_binding",
"clear_search_config_binding",
"autocomplete_search",
]
2 changes: 2 additions & 0 deletions synapseclient/api/entity_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,7 @@ class type. This will also download the file if `download_file` is set to True.
MaterializedView,
Project,
RecordSet,
SearchIndex,
SubmissionView,
Table,
VirtualTable,
Expand Down Expand Up @@ -379,6 +380,7 @@ class type. This will also download the file if `download_file` is set to True.
concrete_types.RECORD_SET_ENTITY: RecordSet,
concrete_types.SUBMISSION_VIEW: SubmissionView,
concrete_types.VIRTUAL_TABLE: VirtualTable,
concrete_types.SEARCH_INDEX_ENTITY: SearchIndex,
concrete_types.LINK_ENTITY: Link,
concrete_types.DOCKER_REPOSITORY: DockerRepository,
}
Expand Down
1 change: 1 addition & 0 deletions synapseclient/api/entity_services.py
Original file line number Diff line number Diff line change
Expand Up @@ -1242,6 +1242,7 @@ async def main():
"submissionview",
"dataset",
"materializedview",
"searchindex",
]

request_body = {
Expand Down
Loading
Loading