feat:Update OpenAPI Specification for Instill AI API with New Endpoints and Schema Changes #55
Conversation
WalkthroughThe changes primarily involve significant updates to the OpenAPI specification for the Instill AI API. Key modifications include the removal of 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 (3)
src/libs/Instill/openapi.yaml (3)
Line range hint
15-17: Security concern: HTTP endpoint exposedThe API allows non-secure HTTP connections. For production environments, it's recommended to:
- Remove the HTTP endpoint
- Force all traffic over HTTPS to ensure data security
Apply this change:
servers: - url: https://api.instill.tech - - url: http://api.instill.tech
Line range hint
18-7711: Consider standardizing API versioningThe API mixes different version prefixes (v1alpha, v1beta) across endpoints. This could lead to:
- Confusion about API stability
- Inconsistent client implementations
- Maintenance challenges
Consider:
- Standardizing on a single version prefix for related functionality
- Documenting version transition plans
- Using API versioning matrix in documentation
Line range hint
7717-7721: Enhance 401 response schemasThe 401 unauthorized responses use empty schemas. Consider adding structured error information to help API consumers better handle authentication failures.
Example enhancement:
'401': description: Returned when the client credentials are not valid. content: application/json: schema: type: object properties: code: type: integer example: 401 message: type: string example: "Invalid or expired authentication token"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (6)
src/libs/Instill/Generated/Instill.Models.Integration.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.SetupSchema.Json.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.SetupSchema.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.SetupSchemaSchema.Json.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.SetupSchemaSchema.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(1 hunks)
🔇 Additional comments (3)
src/libs/Instill/openapi.yaml (3)
Line range hint 1-14: Base API configuration looks good!
The API version, license, and contact information are well documented. The beta versioning (v0.46.0-beta) appropriately indicates the API is still under development.
Line range hint 7722-7725: Documentation structure is well organized!
The API specification includes:
- Clear tag categorization
- Comprehensive descriptions
- Proper external documentation links
7712-7716:
Consider revising the default security token value
While the Bearer authentication scheme is correctly implemented, the default value Bearer instill_sk_*** could potentially expose the token format pattern. Consider using a more generic placeholder like Bearer <token>.
Apply this change:
- x-default: Bearer instill_sk_***
+ x-default: Bearer <token>Likely invalid or redundant comment.
Summary by CodeRabbit
PipelineandPipelineReleaseschemas for better clarity and detail.