feat:Update OpenAPI spec for /predictions POST and version property documentation

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Clarified the accepted formats for the model version identifier in the API documentation.
  • Updated the description of the predictions endpoint to remove outdated guidance about official models.

[coderabbitai]

Walkthrough

The OpenAPI specification was updated to clarify documentation for the /predictions POST endpoint and the version property in prediction requests. The note about using a different operation for official models was removed, and the accepted formats for the version identifier were explicitly listed and described.

Changes

Cohort / File(s)	Change Summary
OpenAPI Documentation Updates src/libs/Replicate/openapi.yaml	Removed note about official model operation from /predictions POST endpoint. Expanded and clarified the accepted formats for the version property in the prediction request schema. No structural or operational changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A nibble at docs, a hop in the spec,
The version formats now clearly reflect.
No more confusion, the path is now bright—
Official or custom, all formats in sight.
With every small tweak, the docs grow more neat,
And bunnies like me find clarity sweet! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 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 34f6a76 and ac36907.

⛔ Files ignored due to path filters (3)

• src/libs/Replicate/Generated/Replicate.IReplicateApi.PredictionsCreate.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.Models.SchemasVersionPredictionRequest.g.cs is excluded by !**/generated/**
• src/libs/Replicate/Generated/Replicate.ReplicateApi.PredictionsCreate.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🔇 Additional comments (2)

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

850-850: Removal of obsolete guidance looks correct
The note that redirected users of official models to models.predictions.create has been dropped. Given that the spec already exposes the dedicated POST /models/{owner}/{name}/predictions endpoint, removing duplicative wording keeps things concise and avoids confusion.

---

1508-1509: Potential ambiguity between bullet 1 and the dedicated /models/{owner}/{name}/predictions endpoint
The first bullet now tells users of official models to supply just {owner}/{model} in the version field of predictions.create. However, the spec still documents a separate endpoint (POST /models/{owner}/{name}/predictions) whose summary is “Create a prediction using an official model” and which explicitly instructs non-official-model users to fall back to predictions.create.

If both approaches are indeed supported, consider adding a brief clarifier such as “This works in addition to the /models/{owner}/{name}/predictions endpoint” to avoid readers assuming they must choose one over the other.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch bot/update-openapi_202508051825

---

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.
• 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.

Support

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

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 generate unit tests to generate unit tests for 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.