Skip to content

Commit f90b5f0

Browse files
authored
Update README.md
1 parent 06c8e6f commit f90b5f0

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,9 @@
11
# pinecone-openapi-spec
2-
Unofficial, reverse-engineered, community-managed OpenAPI spec for the Pinecone API
2+
3+
The excellent vector database [Pinecone](https://www.pinecone.io/) has [a very useful API](https://docs.pinecone.io/reference/describe_index_stats_post), but client support is sparse. While the API and its clients are in theory [based off of an OpenAPI spec](https://www.pinecone.io/learn/pinecone-v2/#rest-api-and-python-client), [no one seems to be able to find it](https://community.pinecone.io/t/openapi-spec-for-api-reference-is-not-found/827).
4+
5+
Therefore, I reverse engineered (read: copy and pasted from the documentation) [this OpenAPI spec](openapi.yml).
6+
7+
It is very new and so should be considered very experimental. If you use it and find a bug, please open an issue, or even better submit a pull request!
8+
9+
Bug fixes will be released as tags so that users can reference a specific version of the spec and have confidence it won't change. Release tags will use the format `YYYYMMDD.N`.

0 commit comments

Comments
 (0)