Skip to content

generate OpenAPI specs based on official pinecone documentation #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

generate OpenAPI specs based on official pinecone documentation #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions download_openapi_specs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import requests
import yaml

URLS_AND_PATHS = [
(
"https://docs.pinecone.io/reference/upsert?json=on",
"vector_openapi.yml",
),
(
"https://docs.pinecone.io/reference/list_collections?json=on",
"index_openapi.yml",
),
]


def download_openapi_spec(url: str):
sess = requests.Session()
response = sess.get(url)
if response.status_code == 200:
data = response.json()
else:
raise Exception(f"Failed to download OpenAPI specs from {url}")
return data["oasDefinition"]


def write_openapi_spec(spec: dict, path: str):
with open(path, "w") as f:
f.write(yaml.dump(spec))


if __name__ == "__main__":
for url, path in URLS_AND_PATHS:
spec = download_openapi_spec(url)
write_openapi_spec(spec, path)
Loading