Skip to content

Commit 5758e11

Browse files
mbhaskarCopilot
mbhaskar
and
Copilot
committed
Add api.md and api.metadata.yml for consistency check
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 8d17144 commit 5758e11

2 files changed

Lines changed: 33 additions & 2 deletions

File tree

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -646,6 +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]]] = ...,
649650
initial_headers: Optional[dict[str, str]] = ...,
650651
return_properties: Literal[False] = False,
651652
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -668,6 +669,7 @@ namespace azure.cosmos
668669
change_feed_policy: Optional[dict[str, Any]] = ...,
669670
computed_properties: Optional[list[dict[str, str]]] = ...,
670671
full_text_policy: Optional[dict[str, Any]] = ...,
672+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
671673
initial_headers: Optional[dict[str, str]] = ...,
672674
return_properties: Literal[True],
673675
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -690,6 +692,7 @@ namespace azure.cosmos
690692
change_feed_policy: Optional[dict[str, Any]] = ...,
691693
computed_properties: Optional[list[dict[str, str]]] = ...,
692694
full_text_policy: Optional[dict[str, Any]] = ...,
695+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
693696
initial_headers: Optional[dict[str, str]] = ...,
694697
return_properties: Literal[False] = False,
695698
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -712,6 +715,7 @@ namespace azure.cosmos
712715
change_feed_policy: Optional[dict[str, Any]] = ...,
713716
computed_properties: Optional[list[dict[str, str]]] = ...,
714717
full_text_policy: Optional[dict[str, Any]] = ...,
718+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
715719
initial_headers: Optional[dict[str, str]] = ...,
716720
return_properties: Literal[True],
717721
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -838,6 +842,7 @@ namespace azure.cosmos
838842
analytical_storage_ttl: Optional[int] = ...,
839843
computed_properties: Optional[list[dict[str, str]]] = ...,
840844
full_text_policy: Optional[dict[str, Any]] = ...,
845+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
841846
initial_headers: Optional[dict[str, str]] = ...,
842847
return_properties: Literal[False] = False,
843848
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -857,6 +862,7 @@ namespace azure.cosmos
857862
analytical_storage_ttl: Optional[int] = ...,
858863
computed_properties: Optional[list[dict[str, str]]] = ...,
859864
full_text_policy: Optional[dict[str, Any]] = ...,
865+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
860866
initial_headers: Optional[dict[str, str]] = ...,
861867
return_properties: Literal[True],
862868
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -892,6 +898,19 @@ namespace azure.cosmos
892898
) -> UserProxy: ...
893899

894900

901+
class azure.cosmos.GlobalSecondaryIndexDefinition:
902+
property definition: str # Read-only
903+
property source_container_id: str # Read-only
904+
property source_container_rid: Optional[str] # Read-only
905+
property status: Optional[str] # Read-only
906+
907+
def __init__(
908+
self,
909+
source_container_id: str,
910+
definition: str
911+
): ...
912+
913+
895914
class azure.cosmos.IndexKind:
896915
Hash: Literal["Hash"] = Hash
897916
MultiHash: Literal["MultiHash"] = MultiHash
@@ -1830,6 +1849,7 @@ namespace azure.cosmos.aio
18301849
conflict_resolution_policy: Optional[dict[str, str]] = ...,
18311850
default_ttl: Optional[int] = ...,
18321851
full_text_policy: Optional[dict[str, Any]] = ...,
1852+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
18331853
indexing_policy: Optional[dict[str, str]] = ...,
18341854
initial_headers: Optional[dict[str, str]] = ...,
18351855
offer_throughput: Optional[Union[int, ThroughputProperties]] = ...,
@@ -1851,6 +1871,7 @@ namespace azure.cosmos.aio
18511871
conflict_resolution_policy: Optional[dict[str, str]] = ...,
18521872
default_ttl: Optional[int] = ...,
18531873
full_text_policy: Optional[dict[str, Any]] = ...,
1874+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
18541875
indexing_policy: Optional[dict[str, str]] = ...,
18551876
initial_headers: Optional[dict[str, str]] = ...,
18561877
offer_throughput: Optional[Union[int, ThroughputProperties]] = ...,
@@ -1872,6 +1893,7 @@ namespace azure.cosmos.aio
18721893
conflict_resolution_policy: Optional[dict[str, str]] = ...,
18731894
default_ttl: Optional[int] = ...,
18741895
full_text_policy: Optional[dict[str, Any]] = ...,
1896+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
18751897
indexing_policy: Optional[dict[str, str]] = ...,
18761898
initial_headers: Optional[dict[str, str]] = ...,
18771899
offer_throughput: Optional[Union[int, ThroughputProperties]] = ...,
@@ -1893,6 +1915,7 @@ namespace azure.cosmos.aio
18931915
conflict_resolution_policy: Optional[dict[str, str]] = ...,
18941916
default_ttl: Optional[int] = ...,
18951917
full_text_policy: Optional[dict[str, Any]] = ...,
1918+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
18961919
indexing_policy: Optional[dict[str, str]] = ...,
18971920
initial_headers: Optional[dict[str, str]] = ...,
18981921
offer_throughput: Optional[Union[int, ThroughputProperties]] = ...,
@@ -2004,6 +2027,7 @@ namespace azure.cosmos.aio
20042027
conflict_resolution_policy: Optional[dict[str, str]] = ...,
20052028
default_ttl: Optional[int] = ...,
20062029
full_text_policy: Optional[dict[str, Any]] = ...,
2030+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
20072031
indexing_policy: Optional[dict[str, str]] = ...,
20082032
initial_headers: Optional[dict[str, str]] = ...,
20092033
return_properties: Literal[False] = False,
@@ -2022,6 +2046,7 @@ namespace azure.cosmos.aio
20222046
conflict_resolution_policy: Optional[dict[str, str]] = ...,
20232047
default_ttl: Optional[int] = ...,
20242048
full_text_policy: Optional[dict[str, Any]] = ...,
2049+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
20252050
indexing_policy: Optional[dict[str, str]] = ...,
20262051
initial_headers: Optional[dict[str, str]] = ...,
20272052
return_properties: Literal[True],
@@ -2909,6 +2934,7 @@ namespace azure.cosmos.database
29092934
change_feed_policy: Optional[dict[str, Any]] = ...,
29102935
computed_properties: Optional[list[dict[str, str]]] = ...,
29112936
full_text_policy: Optional[dict[str, Any]] = ...,
2937+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
29122938
initial_headers: Optional[dict[str, str]] = ...,
29132939
return_properties: Literal[False] = False,
29142940
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -2931,6 +2957,7 @@ namespace azure.cosmos.database
29312957
change_feed_policy: Optional[dict[str, Any]] = ...,
29322958
computed_properties: Optional[list[dict[str, str]]] = ...,
29332959
full_text_policy: Optional[dict[str, Any]] = ...,
2960+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
29342961
initial_headers: Optional[dict[str, str]] = ...,
29352962
return_properties: Literal[True],
29362963
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -2953,6 +2980,7 @@ namespace azure.cosmos.database
29532980
change_feed_policy: Optional[dict[str, Any]] = ...,
29542981
computed_properties: Optional[list[dict[str, str]]] = ...,
29552982
full_text_policy: Optional[dict[str, Any]] = ...,
2983+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
29562984
initial_headers: Optional[dict[str, str]] = ...,
29572985
return_properties: Literal[False] = False,
29582986
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -2975,6 +3003,7 @@ namespace azure.cosmos.database
29753003
change_feed_policy: Optional[dict[str, Any]] = ...,
29763004
computed_properties: Optional[list[dict[str, str]]] = ...,
29773005
full_text_policy: Optional[dict[str, Any]] = ...,
3006+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
29783007
initial_headers: Optional[dict[str, str]] = ...,
29793008
return_properties: Literal[True],
29803009
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -3101,6 +3130,7 @@ namespace azure.cosmos.database
31013130
analytical_storage_ttl: Optional[int] = ...,
31023131
computed_properties: Optional[list[dict[str, str]]] = ...,
31033132
full_text_policy: Optional[dict[str, Any]] = ...,
3133+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
31043134
initial_headers: Optional[dict[str, str]] = ...,
31053135
return_properties: Literal[False] = False,
31063136
vector_embedding_policy: Optional[dict[str, Any]] = ...,
@@ -3120,6 +3150,7 @@ namespace azure.cosmos.database
31203150
analytical_storage_ttl: Optional[int] = ...,
31213151
computed_properties: Optional[list[dict[str, str]]] = ...,
31223152
full_text_policy: Optional[dict[str, Any]] = ...,
3153+
global_secondary_index_definition: Optional[Union[GlobalSecondaryIndexDefinition, dict[str, Any]]] = ...,
31233154
initial_headers: Optional[dict[str, str]] = ...,
31243155
return_properties: Literal[True],
31253156
vector_embedding_policy: Optional[dict[str, Any]] = ...,

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
apiMdSha256: de3b8c0f2a0405fac7152d562c982bf98bf7bb546c46f05e39164574e47f7f7a
1+
apiMdSha256: 2e3b8901f784591bea2745cad02d1dd4c524db0702d0f357774f896de263fdf0
22
parserVersion: 0.3.28
3-
pythonVersion: 3.13.14
3+
pythonVersion: 3.10.20

0 commit comments

Comments
 (0)