Skip to content

Commit 8d9dd16

Browse files
authored
Cleanup, add authentication, external docs
1 parent f90b5f0 commit 8d9dd16

File tree

1 file changed

+15
-22
lines changed

1 file changed

+15
-22
lines changed

openapi.yml

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
openapi: 3.0.2
22
info:
33
title: Pinecone API
4-
description: Pinecone is a vector database. This is an unofficial, reverse-engineered, community-managed OpenAPI spec that (should) accurately model the Pinecone API. This project was developed independent of and is unaffiliated with Pinecone Systems. Users should switch to the official API spec, if and when Pinecone releases it.
4+
description: Pinecone is a vector database. This is an unofficial, community-managed OpenAPI spec that (should) accurately model the Pinecone API. This project was developed independent of and is unaffiliated with Pinecone Systems. Users should switch to the official API spec, if and when Pinecone releases it.
55
contact:
66
name: Andy Boothe
7-
url: https://github.com/sigpwned/pinecone-openapi-spec
8-
version: 20230331.0
7+
url: https://github.com/sigpwned/pinecone-java-client
8+
version: 20230331.1
99
servers:
1010
- url: https://controller.{environment}.pinecone.io
1111
variables:
@@ -17,6 +17,9 @@ servers:
1717
- us-east1-gcp
1818
- eu-west1-gcp
1919
- us-east1-aws
20+
externalDocs:
21+
- url: https://docs.pinecone.io/
22+
description: The official Pinecone API documentation
2023
tags:
2124
- name: Index Operations
2225
description: Endpoints for manipulating indexes
@@ -480,25 +483,12 @@ components:
480483
schema:
481484
$ref: '#/components/schemas/ErrorMessage'
482485

483-
parameters:
484-
secretId:
485-
name: secretId
486-
in: path
487-
description: The ID of the secret to manipulate
488-
required: true
489-
schema:
490-
type: string
491-
format: SecretId
492-
limit:
493-
name: limit
494-
in: query
495-
description: The maximum number of items to return per page
496-
required: false
497-
schema:
498-
type: integer
499-
format: int32
500-
default: 10
501-
486+
securitySchemes:
487+
ApiKey:
488+
type: apiKey
489+
in: header
490+
name: Api-Key
491+
502492
schemas:
503493
CollectionName:
504494
description: The unique name of a collection.
@@ -975,3 +965,6 @@ components:
975965

976966
ErrorMessage:
977967
type: string
968+
969+
security:
970+
- ApiKey: []

0 commit comments

Comments
 (0)