Pinecone Configure Index Example is an example object payload from Pinecone, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "configure_index",
"method": "PATCH",
"path": "/indexes/{index_name}",
"summary": "Configure an index",
"requestExamples": [
{
"contentType": "application/json",
"name": "vertical-scaling",
"example": {
"spec": {
"pod": {
"pod_type": "p1.x2"
}
}
}
},
{
"contentType": "application/json",
"name": "horizontal-scaling",
"example": {
"spec": {
"pod": {
"replicas": 4
}
}
}
},
{
"contentType": "application/json",
"name": "scaling-both",
"example": {
"spec": {
"pod": {
"pod_type": "p1.x2",
"replicas": 4
}
}
}
},
{
"contentType": "application/json",
"name": "disable-deletion-protection",
"example": {
"delete_protection": "disabled"
}
},
{
"contentType": "application/json",
"name": "update-index-tags",
"example": {
"tags": {
"tag0": "new-val",
"tag1": ""
}
}
}
],
"responseExamples": [
{
"status": "400",
"contentType": "application/json",
"name": "index-metric-validation-error",
"example": {
"error": {
"code": "INVALID_ARGUMENT",
"message": "Bad request. The request body included invalid request parameters."
},
"status": 400
}
},
{
"status": "401",
"contentType": "application/json",
"name": "unauthorized",
"example": {
"error": {
"code": "UNAUTHENTICATED",
"message": "Invalid API key."
},
"status": 401
}
},
{
"status": "402",
"contentType": "application/json",
"name": "payment-required",
"example": {
"error": {
"code": "PAYMENT_REQUIRED",
"message": "Request failed. Pay all past due invoices to lift restrictions on your account."
},
"status": 402
}
},
{
"status": "403",
"contentType": "application/json",
"name": "unauthorized",
"example": {
"error": {
"code": "FORBIDDEN",
"message": "Increase your quota or upgrade to create more indexes."
},
"status": 403
}
},
{
"status": "404",
"contentType": "application/json",
"name": "index-not-found",
"example": {
"error": {
"code": "NOT_FOUND",
"message": "Index example-index not found."
},
"status": 404
}
},
{
"status": "422",
"contentType": "application/json",
"name": "missing-field",
"example": {
"error": {
"code": "UNPROCESSABLE_ENTITY",
"message": "Failed to deserialize the JSON body into the target type: missing field `metric` at line 1 column 16"
},
"status": 422
}
},
{
"status": "500",
"contentType": "application/json",
"name": "internal-server-error",
"example": {
"error": {
"code": "UNKNOWN",
"message": "Internal server error"
},
"status": 500
}
}
]
}