docs(vector-stores): clarify files.delete required param in api.md#1832
Open
xodn348 wants to merge 1 commit intoopenai:masterfrom
Open
docs(vector-stores): clarify files.delete required param in api.md#1832xodn348 wants to merge 1 commit intoopenai:masterfrom
xodn348 wants to merge 1 commit intoopenai:masterfrom
Conversation
The delete method for vectorStores.files takes a required params object
containing vector_store_id, not generic spread params. Update api.md
to explicitly show { vector_store_id } instead of { ...params } so
callers know exactly which field to provide.
Fixes openai#1729
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #1729
The
api.mdentry forvectorStores.files.deleteused{ ...params }as a placeholder, which doesn't tell callers what field is actually required. The TypeScript implementation takesFileDeleteParamswherevector_store_idis the only required field.Before:
After:
This matches the actual implementation in
src/resources/vector-stores/files.tswhereconst { vector_store_id } = paramsis destructured and used to build the request path.