feat:Add required web URL field to urls in prediction and training responses

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Updated API documentation to include a new browser-accessible URL for viewing predictions and trainings on replicate.com.
  • Clarified descriptions for API endpoint URLs in prediction and training responses.

[coderabbitai]

Walkthrough

The OpenAPI specification for the Replicate HTTP API was updated to add a required web URL field to the urls objects in prediction and training responses. Descriptions for existing URL fields were clarified, and example responses were updated to include the new web property.

Changes

File(s)	Change Summary
src/libs/Replicate/openapi.yaml	Added required web property to urls in prediction/training response schemas; updated descriptions and examples for urls fields to clarify API and browser endpoints.

Poem

A hop, a skip, a bounding leap,
Now "web" URLs for all to keep!
In docs they shine, a browser's door,
To view predictions, trainings, more.
With clearer words and schema bright,
Replicate's API feels just right!
🐇✨

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (4)

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

801-801: Consider updating the predictions list description
The predictions.list response now includes a urls.web field for browser access. It may be helpful to mention this new property in the description so users know they can view predictions in a browser.

---

865-865: Mention web URL in single prediction docs
The predictions.get response includes the urls.web link. The description currently focuses on API endpoints—please add a note about the new browser-view URL.

---

903-903: Include web URL in trainings list docs
Since trainings.list now returns a urls.web entry, consider updating the description to highlight the browser-accessible link.

---

928-928: Highlight web URL in training detail docs
The trainings.get operation returns urls.web. A brief mention in the description will make users aware of the browser view link.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 647656b and ed4198c.

⛔ Files ignored due to path filters (12)

• src/libs/Replicate/Generated/Replicate.IReplicateApi.PredictionsGet.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.IReplicateApi.PredictionsList.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.IReplicateApi.TrainingsCreate.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.IReplicateApi.TrainingsGet.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.IReplicateApi.TrainingsList.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.SchemasPredictionResponseUrls.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.ReplicateApi.PredictionsGet.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.ReplicateApi.PredictionsList.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.ReplicateApi.TrainingsCreate.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.ReplicateApi.TrainingsGet.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.ReplicateApi.TrainingsList.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🔇 Additional comments (3)

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

764-765: Training endpoint documentation added
The new summary and description for the trainings.create operation clearly explain how to start a model training and include a concrete example.

---

1240-1261: Prediction response schema enhancements
The schemas_prediction_response correctly adds web to the required list and clarifies descriptions for get, cancel, stream, and web URLs. This aligns with the PR objectives and improves schema clarity.

---

1358-1369: Inconsistent with PR summary: training response schema
The PR summary states that schemas_training_response should also include a required web URL, but the urls object here only lists cancel and get. Please verify and update the training response schema to include urls.web if intended.

Likely an incorrect or invalid review comment.