Skip to content
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

Jump to bottom

[spruce] Update docstrings, update pinecone-generated-ts-fetch for usage #186

Merged
merged 3 commits into from
Jan 13, 2024
Merged

[spruce] Update docstrings, update pinecone-generated-ts-fetch for usage #186

merged 3 commits into from
Jan 13, 2024

Conversation

austin-denoble
Copy link
Contributor

Problem

We have a lot of stale docstrings that need to be brought in line with upcoming changes. The control plane spec has also been updated tweaking usage: https://github.com/pinecone-io/pinecone-protos/pull/106

Solution

  • Update docstrings for control plane operations, types, etc. Feedback welcome here I just did what I thought was best for some of these.
  • Regenerate pinecone-generated-ts-fetch, readUnits should now be a number in stead of a `string.
  • Tweak fetch and query integration tests to validate for usage.

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Non-code change (docs, etc)

Test Plan

Make sure integration tests pass in CI.

@austin-denoble
update docstrings to reflect changes, replace openapi core to adjust …
5d87eff 
…usage type, update fetch and query integration tests
@austin-denoble austin-denoble requested a review from jhamon January 13, 2024 03:28
@austin-denoble austin-denoble marked this pull request as ready for review January 13, 2024 03:33
jhamon
jhamon approved these changes Jan 13, 2024
View reviewed changes
Copy link
Collaborator

@jhamon jhamon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@austin-denoble austin-denoble merged commit d3d4e50 into spruce Jan 13, 2024
26 checks passed
@austin-denoble austin-denoble deleted the adenoble/update-docstrings-plus-core branch January 13, 2024 04:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jhamon jhamon jhamon approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@austin-denoble @jhamon