feat:Add nullable full_description to public collection schema and example

[HavenDV]

Summary by CodeRabbit

• New Features
  • Public Collections API now includes an optional full_description field in collection responses, providing an extended description when available.
• Documentation
  • Updated examples for GET /collections/{collection_slug} to include the full_description field, reflecting the expanded response.

[coderabbitai]

Walkthrough

Adds a nullable string field full_description to the public collection schema in the OpenAPI spec and updates the GET /collections/{collection_slug} example to include this field. No other schema structures or operations are modified.

Changes

Cohort / File(s)	Summary of Changes
OpenAPI spec updates src/libs/Replicate/openapi.yaml, src/openapi.yaml	Introduced optional full_description (type: string, nullable: true) in components.schemas.schemas_collection_response; updated example for GET /collections/{collection_slug} to include full_description.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my nose at specs so neat,
A fuller tale makes docs complete.
One field added, calm delight—
Descriptions now can stretch their light.
Hop, hop! I stamp, approve the lore,
With “full_description,” tell me more! 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The title “feat:@coderabbitai” does not describe the primary change of adding a new full_description field to the OpenAPI collection schema and is therefore unrelated to the actual contents of the pull request.	Please revise the title to clearly summarize the main change, for example “feat: add optional full_description field to collection schema in OpenAPI”.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

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

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

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

1159-1162: Schema addition is backward‑compatible; consider noting Markdown semantics and adding an example

• Optional nullable string is safe; good placement.

• Consider adding a vendor note (e.g., x-content-format: markdown) or a short description note so SDKs/docs renderers treat it as Markdown.

• Add a brief example to guide clients.

• Intentional that schemas_collection_list_item (used by collections.list) does not include full_description? If yes, no change needed.

• Verify any server serializers/DB fields exist to avoid empty values after deploy.

Suggested tweak:

 full_description:
   type: string
   description: The full description of the collection in markdown format
   nullable: true
+  example: "## Overview\n\nLonger Markdown description with details and links."
+  x-content-format: markdown

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1321728 and dd0b817.

⛔ Files ignored due to path filters (3)

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

📒 Files selected for processing (1)

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

🔇 Additional comments (1)

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

63-63: Example updated correctly to include full_description

Example matches the new optional field and the referenced response schema.

Please confirm the backend populates full_description (or returns null) for this endpoint in prod/staging.