Skip to content

Commit ec7dc59

Browse files
authored
Merge pull request #29 from pinecone-io/ch11314
add error codes to control plane operations
2 parents 9696b50 + 8df2d13 commit ec7dc59

File tree

3 files changed

+46
-4
lines changed

3 files changed

+46
-4
lines changed

pinecone/core/client/model/create_request.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ def _from_openapi_data(cls, name, dimension, *args, **kwargs): # noqa: E501
161161
_visited_composed_classes = (Animal,)
162162
index_type (str): The type of vector index. Pinecone supports 'approximated'.. [optional] if omitted the server will use the default value of "approximated" # noqa: E501
163163
metric (str): The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.. [optional] if omitted the server will use the default value of "cosine" # noqa: E501
164-
pods (int): The number of pods for the index to use, per replica.. [optional] if omitted the server will use the default value of 1 # noqa: E501
164+
pods (int): The number of pods for the index to use,including replicas.. [optional] if omitted the server will use the default value of 1 # noqa: E501
165165
replicas (int): The number of replicas. Replicas duplicate your index. They provide higher availability and throughput.. [optional] if omitted the server will use the default value of 1 # noqa: E501
166166
shards (int): The number of shards to be used in the index.. [optional] if omitted the server will use the default value of 1 # noqa: E501
167167
pod_type (str): The type of pod to use. One of 's1' or 'p1'.. [optional] if omitted the server will use the default value of "p1" # noqa: E501
@@ -255,7 +255,7 @@ def __init__(self, name, dimension, *args, **kwargs): # noqa: E501
255255
_visited_composed_classes = (Animal,)
256256
index_type (str): The type of vector index. Pinecone supports 'approximated'.. [optional] if omitted the server will use the default value of "approximated" # noqa: E501
257257
metric (str): The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.. [optional] if omitted the server will use the default value of "cosine" # noqa: E501
258-
pods (int): The number of pods for the index to use, per replica.. [optional] if omitted the server will use the default value of 1 # noqa: E501
258+
pods (int): The number of pods for the index to use,including replicas.. [optional] if omitted the server will use the default value of 1 # noqa: E501
259259
replicas (int): The number of replicas. Replicas duplicate your index. They provide higher availability and throughput.. [optional] if omitted the server will use the default value of 1 # noqa: E501
260260
shards (int): The number of shards to be used in the index.. [optional] if omitted the server will use the default value of 1 # noqa: E501
261261
pod_type (str): The type of pod to use. One of 's1' or 'p1'.. [optional] if omitted the server will use the default value of "p1" # noqa: E501

specs/index_service.json

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,15 @@
6161
}
6262
}
6363
}
64+
},
65+
"400": {
66+
"description": "Bad request. Exceeded quota"
67+
},
68+
"409": {
69+
"description": "Index of given name already exists."
70+
},
71+
"500": {
72+
"description": "Invalid parameters/request"
6473
}
6574
},
6675
"tags": [
@@ -107,6 +116,9 @@
107116
},
108117
"404": {
109118
"description": "Index not found"
119+
},
120+
"500": {
121+
"description": "Invalid request/parameters"
110122
}
111123
},
112124
"tags": [
@@ -140,6 +152,9 @@
140152
},
141153
"404": {
142154
"description": "Index not found"
155+
},
156+
"500": {
157+
"description": "Invalid request/params"
143158
}
144159
},
145160
"tags": [
@@ -183,6 +198,12 @@
183198
},
184199
"404": {
185200
"description": "Index not found"
201+
},
202+
"400": {
203+
"description": "Bad request,not enough quota"
204+
},
205+
"500": {
206+
"description": "Invalid request/params"
186207
}
187208
},
188209
"tags": [
@@ -232,7 +253,7 @@
232253
},
233254
"pods": {
234255
"type": "integer",
235-
"description": "The number of pods for the index to use, per replica.",
256+
"description": "The number of pods for the index to use,including replicas.",
236257
"default": 1
237258
},
238259
"replicas": {

specs/pinecone_api.json

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,15 @@
324324
}
325325
}
326326
}
327+
},
328+
"400": {
329+
"description": "Bad request. Exceeded quota"
330+
},
331+
"409": {
332+
"description": "Index of given name already exists."
333+
},
334+
"500": {
335+
"description": "Invalid parameters/request"
327336
}
328337
},
329338
"tags": [
@@ -370,6 +379,9 @@
370379
},
371380
"404": {
372381
"description": "Index not found"
382+
},
383+
"500": {
384+
"description": "Invalid request/parameters"
373385
}
374386
},
375387
"tags": [
@@ -403,6 +415,9 @@
403415
},
404416
"404": {
405417
"description": "Index not found"
418+
},
419+
"500": {
420+
"description": "Invalid request/params"
406421
}
407422
},
408423
"tags": [
@@ -444,8 +459,14 @@
444459
}
445460
}
446461
},
462+
"400": {
463+
"description": "Bad request,not enough quota"
464+
},
447465
"404": {
448466
"description": "Index not found"
467+
},
468+
"500": {
469+
"description": "Invalid request/params"
449470
}
450471
},
451472
"tags": [
@@ -893,7 +914,7 @@
893914
},
894915
"pods": {
895916
"type": "integer",
896-
"description": "The number of pods for the index to use, per replica.",
917+
"description": "The number of pods for the index to use,including replicas.",
897918
"default": 1
898919
},
899920
"replicas": {

0 commit comments

Comments
 (0)