feat:Update OpenAPI Specification with Schema and Parameter Renaming #59
Conversation
WalkthroughThe pull request introduces significant modifications to the OpenAPI specification for the Replicate HTTP API. Key changes include renaming several schemas and parameters, specifically changing 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/Replicate/openapi.yaml (1)
Line range hint
1001-1006: Consider improving the wait parameter pattern validationWhile the parameter has been correctly renamed to
parameters_prefer_header, the pattern validation could be more precise.Consider updating the pattern to more strictly match the wait parameter format:
- pattern: '^wait(=([1-9]|[1-9][0-9]|60))?$' + pattern: '^wait(=[1-9]|[1-5][0-9]|60)?$'This change would:
- More precisely validate numbers between 1-60
- Prevent invalid values like "00" or "01"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (33)
src/libs/Replicate/Generated/JsonConverters.SchemasPredictionRequestWebhookEventsFilterItem.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/JsonConverters.SchemasPredictionRequestWebhookEventsFilterItemNullable.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/JsonConverters.SchemasTrainingRequestWebhookEventsFilterItem.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/JsonConverters.SchemasTrainingRequestWebhookEventsFilterItemNullable.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/JsonConverters.SchemasVersionPredictionRequestWebhookEventsFilterItem.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/JsonConverters.SchemasVersionPredictionRequestWebhookEventsFilterItemNullable.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/JsonSerializerContext.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/JsonSerializerContextTypes.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.IReplicateApi.DeploymentsPredictionsCreate.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.IReplicateApi.ModelsPredictionsCreate.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.IReplicateApi.PredictionsCreate.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.IReplicateApi.TrainingsCreate.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.PredictionRequestWebhookEventsFilterItem.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionRequest.Json.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionRequest.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionRequestInput.Json.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionRequestInput.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionRequestWebhookEventsFilterItem.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.SchemasTrainingRequest.Json.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.SchemasTrainingRequest.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.SchemasTrainingRequestInput.Json.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.SchemasTrainingRequestInput.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.SchemasTrainingRequestWebhookEventsFilterItem.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.SchemasVersionPredictionRequest.Json.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.SchemasVersionPredictionRequest.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.SchemasVersionPredictionRequestInput.Json.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.SchemasVersionPredictionRequestInput.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.SchemasVersionPredictionRequestWebhookEventsFilterItem.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.Models.TrainingRequestWebhookEventsFilterItem.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.ReplicateApi.DeploymentsPredictionsCreate.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.ReplicateApi.ModelsPredictionsCreate.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.ReplicateApi.PredictionsCreate.g.csis excluded by!**/generated/**src/libs/Replicate/Generated/Replicate.ReplicateApi.TrainingsCreate.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/Replicate/openapi.yaml(8 hunks)
🔇 Additional comments (4)
src/libs/Replicate/openapi.yaml (4)
467-467: Schema references are consistently updated
The schema references have been properly updated across all endpoints to use the new prefixed naming convention.
Also applies to: 729-729, 751-751
Line range hint 845-920: Schema definitions are properly renamed
The schema definitions have been correctly renamed with the "schemas_" prefix while maintaining their original structure and content.
462-462: Parameter references are consistently updated
The prefer_header parameter references have been properly updated to use the new parameters_prefer_header name across all relevant endpoints.
Also applies to: 746-746
Line range hint 1-1012: Overall changes look good
The renaming changes are:
- Consistent across all references
- Non-breaking to the API contract
- Well-documented with accurate examples
Summary by CodeRabbit