feat:Update OpenAPI Specification with New Endpoints and Response Schemas #59
Conversation
This file contains 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
WalkthroughThe pull request introduces significant updates to the OpenAPI specification for the Instill AI API. It adds new endpoints for searching and listing catalog chunks, along with corresponding response schemas. Additionally, it updates an existing endpoint for listing catalog files to include a new response schema. The Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
coderabbitai
bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
src/libs/Instill/openapi.yaml (2)
Line range hint
1591-1717: Consider enhancing pagination implementation for search chunks endpointThe search chunks endpoint could benefit from consistent pagination implementation:
- Add
nextPageTokenin response schema for cursor-based pagination- Consider adding sorting parameters for deterministic ordering
'/v1alpha/namespaces/{namespaceId}/chunks': get: parameters: + - name: pageToken + in: query + description: Token for the next page of results + schema: + type: string + - name: orderBy + in: query + description: Field to sort by, e.g. "createTime desc" + schema: + type: string responses: '200': content: application/json: schema: properties: + nextPageToken: + type: string + description: Token for retrieving the next page
10125-10127: Add validation constraints for originalFileName fieldConsider adding validation constraints to ensure data quality:
originalFileName: title: original file name type: string + maxLength: 255 + pattern: '^[a-zA-Z0-9._-]+$' + description: "Original filename with extension. Must contain only alphanumeric characters, dots, underscores and hyphens."
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (16)
src/libs/Instill/Generated/Instill.ArtifactClient.ListChunks.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.ArtifactClient.SearchChunks.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.ArtifactClient.SearchSourceFiles.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.IArtifactClient.ListChunks.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.IArtifactClient.SearchChunks.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.IArtifactClient.SearchSourceFiles.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.SearchChunksResponse.Json.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.SearchChunksResponse.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.SearchChunksResponse2.Json.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.SearchChunksResponse2.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.SearchSourceFilesResponse.Json.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.SearchSourceFilesResponse.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.SearchSourceFilesResponse2.Json.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.SearchSourceFilesResponse2.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.SourceFile.g.csis excluded by!**/generated/**src/libs/Instill/Generated/JsonSerializerContextTypes.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/Instill/openapi.yaml(5 hunks)
🔇 Additional comments (1)
src/libs/Instill/openapi.yaml (1)
Line range hint 1-10127: API specification follows OpenAPI best practices
The OpenAPI specification demonstrates good practices:
- Consistent error handling using standard response schemas
- Proper authentication configuration
- Comprehensive endpoint documentation
- Clear parameter descriptions
- Logical endpoint grouping by tags
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 by CodeRabbit
New Features
originalFileName.Bug Fixes