Skip to content

Commit c839b8b

Browse files
simorenohsimorenoh
authored
Cosmos: update changelog for release (#48005)
* Update CHANGELOG.md * Rename global_secondary_index_definition keyword to global_secondary_index Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 771f35e3-c666-4532-9928-7c23c92efb91 * Update api.metadata.yml hash after GSI parameter rename Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 771f35e3-c666-4532-9928-7c23c92efb91 * Apply suggestion from @simorenoh
1 parent f0ac2f5 commit c839b8b

6 files changed

Lines changed: 101 additions & 105 deletions

File tree

‎sdk/cosmos/azure-cosmos/CHANGELOG.md‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
11
## Release History
22

3-
### 4.16.2 (Unreleased)
3+
### 4.16.2 (2026-07-15)
44

55
#### Features Added
6-
* Added `GlobalSecondaryIndexDefinition` class and `global_secondary_index_definition` keyword to `create_container`, `create_container_if_not_exists`, and `replace_container` methods for creating Global Secondary Index (GSI) containers. See [PR 47468](https://github.com/Azure/azure-sdk-for-python/pull/47468).
7-
8-
#### Breaking Changes
6+
* Added `GlobalSecondaryIndexDefinition` class and `global_secondary_index` keyword to `create_container`, `create_container_if_not_exists`, and `replace_container` methods for creating Global Secondary Index (GSI) containers. See [PR 47468](https://github.com/Azure/azure-sdk-for-python/pull/47468).
97

108
#### Bugs Fixed
119
* Fixed `KeyError: 'version'` in `SessionContainer.get_session_token` (sync and async) when the container's `partitionKey` definition returned by the service does not include the optional `version` field. The error was silently swallowed by a broad `except`, causing the client to send no `x-ms-session-token` header on subsequent reads. Against the Dedicated Gateway, this turned every Session-consistency read into an Integrated Cache miss. `partitionKey.version` is now treated as optional and defaults to `1`, matching how `PartitionKey` handles a missing version. See [PR 47143](https://github.com/Azure/azure-sdk-for-python/pull/47143)
1210

13-
#### Other Changes
14-
1511
### 4.16.1 (2026-06-01)
1612

1713
#### Bugs Fixed

‎sdk/cosmos/azure-cosmos/api.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -646,7 +646,7 @@ namespace azure.cosmos
646646
change_feed_policy: Optional[dict[str, Any]] = ...,
647647
computed_properties: Optional[list[dict[str, str]]] = ...,
648648
full_text_policy: Optional[dict[str, Any]] = ...,
649-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
649+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
650650
initial_headers: Optional[dict[str, str]] = ...,
651651
return_properties: Literal[False] = False,
652652
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -669,7 +669,7 @@ namespace azure.cosmos
669669
change_feed_policy: Optional[dict[str, Any]] = ...,
670670
computed_properties: Optional[list[dict[str, str]]] = ...,
671671
full_text_policy: Optional[dict[str, Any]] = ...,
672-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
672+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
673673
initial_headers: Optional[dict[str, str]] = ...,
674674
return_properties: Literal[True],
675675
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -692,7 +692,7 @@ namespace azure.cosmos
692692
change_feed_policy: Optional[dict[str, Any]] = ...,
693693
computed_properties: Optional[list[dict[str, str]]] = ...,
694694
full_text_policy: Optional[dict[str, Any]] = ...,
695-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
695+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
696696
initial_headers: Optional[dict[str, str]] = ...,
697697
return_properties: Literal[False] = False,
698698
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -715,7 +715,7 @@ namespace azure.cosmos
715715
change_feed_policy: Optional[dict[str, Any]] = ...,
716716
computed_properties: Optional[list[dict[str, str]]] = ...,
717717
full_text_policy: Optional[dict[str, Any]] = ...,
718-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
718+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
719719
initial_headers: Optional[dict[str, str]] = ...,
720720
return_properties: Literal[True],
721721
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -842,7 +842,7 @@ namespace azure.cosmos
842842
analytical_storage_ttl: Optional[int] = ...,
843843
computed_properties: Optional[list[dict[str, str]]] = ...,
844844
full_text_policy: Optional[dict[str, Any]] = ...,
845-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
845+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
846846
initial_headers: Optional[dict[str, str]] = ...,
847847
return_properties: Literal[False] = False,
848848
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -862,7 +862,7 @@ namespace azure.cosmos
862862
analytical_storage_ttl: Optional[int] = ...,
863863
computed_properties: Optional[list[dict[str, str]]] = ...,
864864
full_text_policy: Optional[dict[str, Any]] = ...,
865-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
865+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
866866
initial_headers: Optional[dict[str, str]] = ...,
867867
return_properties: Literal[True],
868868
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -1849,7 +1849,7 @@ namespace azure.cosmos.aio
18491849
conflict_resolution_policy: Optional[dict[str, str]] = ...,
18501850
default_ttl: Optional[int] = ...,
18511851
full_text_policy: Optional[dict[str, Any]] = ...,
1852-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
1852+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
18531853
indexing_policy: Optional[dict[str, str]] = ...,
18541854
initial_headers: Optional[dict[str, str]] = ...,
18551855
offer_throughput: Optional[Union[int, ThroughputProperties]] = ...,
@@ -1871,7 +1871,7 @@ namespace azure.cosmos.aio
18711871
conflict_resolution_policy: Optional[dict[str, str]] = ...,
18721872
default_ttl: Optional[int] = ...,
18731873
full_text_policy: Optional[dict[str, Any]] = ...,
1874-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
1874+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
18751875
indexing_policy: Optional[dict[str, str]] = ...,
18761876
initial_headers: Optional[dict[str, str]] = ...,
18771877
offer_throughput: Optional[Union[int, ThroughputProperties]] = ...,
@@ -1893,7 +1893,7 @@ namespace azure.cosmos.aio
18931893
conflict_resolution_policy: Optional[dict[str, str]] = ...,
18941894
default_ttl: Optional[int] = ...,
18951895
full_text_policy: Optional[dict[str, Any]] = ...,
1896-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
1896+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
18971897
indexing_policy: Optional[dict[str, str]] = ...,
18981898
initial_headers: Optional[dict[str, str]] = ...,
18991899
offer_throughput: Optional[Union[int, ThroughputProperties]] = ...,
@@ -1915,7 +1915,7 @@ namespace azure.cosmos.aio
19151915
conflict_resolution_policy: Optional[dict[str, str]] = ...,
19161916
default_ttl: Optional[int] = ...,
19171917
full_text_policy: Optional[dict[str, Any]] = ...,
1918-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
1918+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
19191919
indexing_policy: Optional[dict[str, str]] = ...,
19201920
initial_headers: Optional[dict[str, str]] = ...,
19211921
offer_throughput: Optional[Union[int, ThroughputProperties]] = ...,
@@ -2027,7 +2027,7 @@ namespace azure.cosmos.aio
20272027
conflict_resolution_policy: Optional[dict[str, str]] = ...,
20282028
default_ttl: Optional[int] = ...,
20292029
full_text_policy: Optional[dict[str, Any]] = ...,
2030-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
2030+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
20312031
indexing_policy: Optional[dict[str, str]] = ...,
20322032
initial_headers: Optional[dict[str, str]] = ...,
20332033
return_properties: Literal[False] = False,
@@ -2046,7 +2046,7 @@ namespace azure.cosmos.aio
20462046
conflict_resolution_policy: Optional[dict[str, str]] = ...,
20472047
default_ttl: Optional[int] = ...,
20482048
full_text_policy: Optional[dict[str, Any]] = ...,
2049-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
2049+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
20502050
indexing_policy: Optional[dict[str, str]] = ...,
20512051
initial_headers: Optional[dict[str, str]] = ...,
20522052
return_properties: Literal[True],
@@ -2934,7 +2934,7 @@ namespace azure.cosmos.database
29342934
change_feed_policy: Optional[dict[str, Any]] = ...,
29352935
computed_properties: Optional[list[dict[str, str]]] = ...,
29362936
full_text_policy: Optional[dict[str, Any]] = ...,
2937-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
2937+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
29382938
initial_headers: Optional[dict[str, str]] = ...,
29392939
return_properties: Literal[False] = False,
29402940
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -2957,7 +2957,7 @@ namespace azure.cosmos.database
29572957
change_feed_policy: Optional[dict[str, Any]] = ...,
29582958
computed_properties: Optional[list[dict[str, str]]] = ...,
29592959
full_text_policy: Optional[dict[str, Any]] = ...,
2960-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
2960+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
29612961
initial_headers: Optional[dict[str, str]] = ...,
29622962
return_properties: Literal[True],
29632963
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -2980,7 +2980,7 @@ namespace azure.cosmos.database
29802980
change_feed_policy: Optional[dict[str, Any]] = ...,
29812981
computed_properties: Optional[list[dict[str, str]]] = ...,
29822982
full_text_policy: Optional[dict[str, Any]] = ...,
2983-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
2983+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
29842984
initial_headers: Optional[dict[str, str]] = ...,
29852985
return_properties: Literal[False] = False,
29862986
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -3003,7 +3003,7 @@ namespace azure.cosmos.database
30033003
change_feed_policy: Optional[dict[str, Any]] = ...,
30043004
computed_properties: Optional[list[dict[str, str]]] = ...,
30053005
full_text_policy: Optional[dict[str, Any]] = ...,
3006-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
3006+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
30073007
initial_headers: Optional[dict[str, str]] = ...,
30083008
return_properties: Literal[True],
30093009
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -3130,7 +3130,7 @@ namespace azure.cosmos.database
31303130
analytical_storage_ttl: Optional[int] = ...,
31313131
computed_properties: Optional[list[dict[str, str]]] = ...,
31323132
full_text_policy: Optional[dict[str, Any]] = ...,
3133-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
3133+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
31343134
initial_headers: Optional[dict[str, str]] = ...,
31353135
return_properties: Literal[False] = False,
31363136
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -3150,7 +3150,7 @@ namespace azure.cosmos.database
31503150
analytical_storage_ttl: Optional[int] = ...,
31513151
computed_properties: Optional[list[dict[str, str]]] = ...,
31523152
full_text_policy: Optional[dict[str, Any]] = ...,
3153-
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
3153+
global_secondary_index: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
31543154
initial_headers: Optional[dict[str, str]] = ...,
31553155
return_properties: Literal[True],
31563156
vector_embedding_policy: Optional[dict[str, Any]] = ...,

‎sdk/cosmos/azure-cosmos/api.metadata.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
apiMdSha256: 2e3b8901f784591bea2745cad02d1dd4c524db0702d0f357774f896de263fdf0
1+
apiMdSha256: 1538a79b2c2da38fb83fd37ccea945314bf2f34218acda3d8f15e2f0268f3040
22
parserVersion: 0.3.28
33
pythonVersion: 3.13.14

0 commit comments

Comments
 (0)