feat:Enhance OpenAPI Specification with New Query Parameters and Schemas #52
Conversation
WalkthroughThe changes involve enhancements to the OpenAPI specification for the Instill AI API. Two new query parameters, 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 (1)
src/libs/Instill/openapi.yaml (1)
Based on the verification results, I can now provide a final response:
Schema definitions are properly structured but references need path correction
The OpenAPI schema definitions are correctly structured with 416 schema definitions under the components/schemas section. However, the schema references in the file include the filename prefix "openapi.yaml:" which needs to be removed for proper OpenAPI specification compliance.
- All schema references should be in the format
#/components/schemas/{name}instead ofopenapi.yaml:#/components/schemas/{name}- The components/schemas section is properly defined and contains the required schema definitions
- The schema structure follows OpenAPI 3.0.1 specification format
🔗 Analysis chain
Line range hint
1-10500: Verify schema references consistencyLet's verify that all schema references are properly defined and used.
Let me verify the schema definitions with a more targeted approach.
Let me check the schema structure more thoroughly.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check for any undefined schema references in the OpenAPI spec # Search for schema references echo "Checking for schema references..." refs=$(rg -o '#/components/schemas/[^"'\''}\s]+' | sort -u | cut -d'/' -f4-) # Search for schema definitions echo "Checking for schema definitions..." schemas=$(rg -A 1 '^ {4}[^$ ].*:$' | rg -o '^ \K[^:]+' | sort -u) # Compare references and definitions echo "Comparing references and definitions..." for ref in $refs; do if ! echo "$schemas" | rg -q "^$ref$"; then echo "Warning: Referenced schema '$ref' not found in definitions" fi doneLength of output: 100343
Script:
#!/bin/bash # Check if the schemas section exists and contains definitions echo "Checking for components/schemas section..." rg -A 1 '^components:' # Check a sample of schema definitions echo "Checking for specific schema definitions..." rg -A 3 '^ {4}(AITask|Pipeline|Model|Organization):$'Length of output: 1253
Script:
#!/bin/bash # Check the structure of components/schemas section echo "Checking components/schemas structure..." rg -A 5 '^ schemas:' # Count total schema definitions echo "Counting schema definitions..." rg -c '^ {4}[A-Za-z0-9.]+:$' # Check if schema references match the pattern in definitions echo "Checking schema reference patterns..." rg -A 1 '^\s+\$ref: ''#/components/schemas/' | sort -uLength of output: 687
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (44)
src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceCreateApp.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceCreateConversation.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceListApps.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceListConversations.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceUpdateApp.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceUpdateConversation.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.ArtifactClient.CreateCatalog.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceCreateApp.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceCreateConversation.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceListApps.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceListConversations.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceUpdateApp.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceUpdateConversation.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.IArtifactClient.CreateCatalog.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.AIAgentAppMetadata.Json.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.AIAgentAppMetadata.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.App.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.AppPublicServiceListAppsAppType.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.AppPublicServiceListConversationsChatWith.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.AppType.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.AppV1alphaMessage.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.CatalogType.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.ChatWith.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.Conversation.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.CreateAppBody.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.CreateCatalogBody.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.CreateConversationBody.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.File.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.Tool.Json.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.Tool.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.ToolConfig.Json.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.ToolConfig.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.UpdateAppBody.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.UpdateConversationBody.g.csis excluded by!**/generated/**src/libs/Instill/Generated/JsonConverters.AppPublicServiceListAppsAppType.g.csis excluded by!**/generated/**src/libs/Instill/Generated/JsonConverters.AppPublicServiceListAppsAppTypeNullable.g.csis excluded by!**/generated/**src/libs/Instill/Generated/JsonConverters.AppPublicServiceListConversationsChatWith.g.csis excluded by!**/generated/**src/libs/Instill/Generated/JsonConverters.AppPublicServiceListConversationsChatWithNullable.g.csis excluded by!**/generated/**src/libs/Instill/Generated/JsonConverters.CatalogType.g.csis excluded by!**/generated/**src/libs/Instill/Generated/JsonConverters.CatalogTypeNullable.g.csis excluded by!**/generated/**src/libs/Instill/Generated/JsonConverters.ChatWith.g.csis excluded by!**/generated/**src/libs/Instill/Generated/JsonConverters.ChatWithNullable.g.csis excluded by!**/generated/**src/libs/Instill/Generated/JsonSerializerContext.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(17 hunks)
🔇 Additional comments (3)
src/libs/Instill/openapi.yaml (3)
31-38: LGTM! Well-structured query parameters
The new query parameters appType and chatWith are properly defined with clear descriptions and appropriate enums. The implementation follows OpenAPI best practices.
Also applies to: 227-234
5744-5768: LGTM! Well-defined schemas and enums
The new schemas and enums are properly structured:
AIAgentAppMetadata: Comprehensive schema for agent configurationCatalogType: Clear enum for catalog persistence typesChatWith: Appropriate enum for chat interaction types
Also applies to: 6104-6110, 6154-6160
9966-9973: LGTM! Consistent schema updates
The updates to existing schemas properly integrate the new AI agent and chat features while maintaining backward compatibility.
Also applies to: 10027-10039
Summary by CodeRabbit
New Features
appTypeandchatWithfor enhanced filtering and interaction options.AIAgentAppMetadataand enumerations for better categorization.Improvements