feat:Update Replicate API OpenAPI Spec with Response and Request Schemas

[HavenDV]

Summary by CodeRabbit

• New Features

  • Enhanced the account and deployment endpoints with additional details such as user type, username, and avatar information.
  • Expanded prediction responses to include richer structured data and improved action links.

• Documentation

  • Updated API request and response schemas, providing clearer expectations and stronger validation for more reliable integrations.

[coderabbitai]

Walkthrough

The changes update the OpenAPI specification for the Replicate API. The modifications add required fields and properties to response schemas for the /account, /deployments, and /predictions endpoints. They also enhance the structure of training and prediction request schemas, ensuring better validation and consistency in API responses.

Changes

File(s)	Change Summary
src/libs/Replicate/openapi.yaml	Updated /account endpoint: requires type and username, added avatar_url. Updated /deployments endpoint: created_by now requires type and username, with an added avatar_url. Updated /predictions endpoint: introduced schemas_prediction_response with required fields (including id, model, version, etc.) and enhanced the urls object; also updated training and version prediction request schemas.

Possibly related PRs

• feat:Add created_after and created_before parameters to GET /predictions #69: Introduces new query parameters for the /predictions endpoint, directly complementing the response schema enhancements.
• feat:Update OpenAPI Specification for Replicate HTTP API and Enhance Documentation #39: Updates descriptions and response codes for the /predictions endpoint, aligning with the modifications in the schema structure.

Suggested reviewers

• github-actions

Poem

I'm a happy rabbit, coding away,
Hopping through specs where new fields now stay.
With avatars and types shining so bright,
My API hops leap into the light.
Cheers and carrots for changes done right! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4fe2dcf and 4cb3399.

⛔ Files ignored due to path filters (49)

• src/libs/Replicate/Generated/JsonConverters.OneOf2.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/JsonConverters.OneOf6.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/JsonConverters.SchemasPredictionResponseStatus.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/JsonConverters.SchemasPredictionResponseStatusNullable.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/JsonConverters.SchemasPredictionResponseVersion.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/JsonConverters.SchemasPredictionResponseVersionNullable.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/JsonSerializerContext.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/OneOf.2.Json.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/OneOf.2.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/OneOf.6.Json.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/OneOf.6.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.IReplicateApi.DeploymentsCreate.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.IReplicateApi.DeploymentsGet.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.IReplicateApi.DeploymentsList.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.IReplicateApi.DeploymentsPredictionsCreate.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.IReplicateApi.DeploymentsUpdate.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.IReplicateApi.ModelsPredictionsCreate.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.IReplicateApi.PredictionsCreate.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.IReplicateApi.PredictionsList.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.AccountGetResponse.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.DeploymentsCreateResponseCurrentReleaseCreatedBy.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.DeploymentsGetResponseCurrentReleaseCreatedBy.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.DeploymentsListResponseResultCurrentReleaseCreatedBy.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.DeploymentsUpdateResponseCurrentReleaseCreatedBy.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.PredictionsListResponse.Json.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.PredictionsListResponse.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionResponse.Json.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionResponse.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionResponseInput.Json.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionResponseInput.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionResponseMetrics.Json.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionResponseMetrics.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionResponseOutput.Json.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionResponseOutput.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionResponseOutputItem.Json.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionResponseOutputItem.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionResponseStatus.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionResponseUrls.Json.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionResponseUrls.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.SchemasPredictionResponseVersion.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.ReplicateApi.DeploymentsCreate.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.ReplicateApi.DeploymentsGet.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.ReplicateApi.DeploymentsList.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.ReplicateApi.DeploymentsPredictionsCreate.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.ReplicateApi.DeploymentsUpdate.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.ReplicateApi.ModelsPredictionsCreate.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.ReplicateApi.PredictionsCreate.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.ReplicateApi.PredictionsList.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/Replicate/openapi.yaml (14 hunks)

🔇 Additional comments (9)

src/libs/Replicate/openapi.yaml (9)

23-30: Account Endpoint Response Schema Enhancements
The addition of the required fields (type and username) along with the new avatar_url property (with its URI format and description) improves the clarity and validation of the account response. Please ensure that your documentation and client integrations are updated to reflect these mandatory fields.

---

117-126: Deployment ‘created_by’ Object Schema Update
In the deployments endpoints, the created_by object now requires type and username and additionally includes an avatar_url property with the proper URI format. This change enforces a consistent structure in the deployment responses. Verify that all API consumers are aware of these requirements.

---

159-162: Deployment Creation Endpoint Description Update
The updated description for the deployment creation (POST) endpoint now provides a comprehensive cURL example and detailed guidance. This enhancement greatly improves usability and clarity. Ensure that any corresponding documentation is aligned with these changes.

---

288-296: Deployment Retrieval Endpoint Description Enhancement
The revised description for the GET deployment endpoint now includes a more illustrative example, making it easier for developers to understand the expected response. It is advisable to confirm that these examples are fully consistent with the actual response schema.

---

374-389: Deployment Update Endpoint Description Improvement
The update (PATCH) endpoint now explicitly mentions that modifying deployment properties will increment the current_release number. This added detail helps clarify versioning behavior for end users. Ensure client implementations properly handle this nuance.

---

506-515: Predictions Creation via Deployment Endpoint Response Schema
For the /deployments/{deployment_owner}/{deployment_name}/predictions endpoint, both the 201 and 202 responses now reference the schemas_prediction_response schema. This standardizes the response across endpoints. Please verify that the schema accurately represents all fields returned by the endpoint.

---

807-823: Predictions List Response Schema Refinement
The /predictions GET response has been updated to include pagination properties (next and previous) and a results array that uses schemas_prediction_response for each prediction. This clear structure is beneficial for client-side processing—just ensure that its implementation is consistent with client expectations.

---

838-847: Predictions Creation Endpoint Response Update
The /predictions POST endpoint now uses the schemas_prediction_response schema for both 201 and 202 responses. This creates consistency across prediction-related endpoints. Confirm that all possible response fields are handled correctly by downstream consumers.

---

961-1053: Enhanced Prediction Response Schema
The updated schemas_prediction_response schema now mandates fields such as id, model, version, input, output, data_removed, error, status, created_at, and urls. In particular, the output property is defined using a union type to allow for multiple data formats (object, array, string, number, boolean). This robust schema should improve validation and clarity. Please verify that all potential output types are correctly managed by both the server and client implementations.

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.