feat: add options field docs in create property API

[Prashant-Surya]

Description

• Create property API will now take options in the payload to create options in one call for OPTION type
• Update type for setting custom property values with latest api changes

Type of Change

• Feature (non-breaking change which adds functionality)
• Improvement (change that would cause existing functionality to not work as expected)

Summary by CodeRabbit

• Documentation
  • Updated add-property API documentation with new "options" parameter for OPTION-type properties.
  • Refined add-property-values API parameter structure to support multiple value types (string, boolean, number, arrays).
  • Enhanced guidance on multi-value property handling and per-property-type behavior.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
developer-docs	Error			Nov 29, 2025 1:26pm

[coderabbitai]

Walkthrough

Two API reference documentation files are updated with parameter modifications. The add-property endpoint gains an optional "options" parameter for OPTION-type properties, while the add-property-values endpoint restructures its "value" parameter to support multiple scalar types and multi-value handling.

Changes

Cohort / File(s)

Summary

API Reference Documentation api-reference/issue-types/properties/add-property.mdx, api-reference/issue-types/values/add-property-values.mdx

Updated parameter documentation: add-property introduces "options" parameter (object array) for OPTION-type properties with field specs (name, description, is_active, sort_order, parent, is_default, logo_props); add-property-values restructures "value" parameter from nested object[] to flexible scalar/array type (string | boolean | number | string[]) with clarified multi-value and per-property-type semantics

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• These are straightforward documentation updates to markdown files describing API parameters
• Changes are localized to two files with clear, factual additions and parameter restructuring
• No code logic, testing, or complex interdependencies involved

Poem

🐰 With whiskers twitching and a hop so light,
Documentation blooms in fields so bright!
New options dance, new values take their form—
API knowledge keeps the garden warm! 📚✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: documenting the new 'options' field in the create property API, which aligns with the primary modification in add-property.mdx.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/custom-properties-api

---

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 (2)

api-reference/issue-types/values/add-property-values.mdx (2)

32-32: Clarify multi-value UUID input flexibility.

Line 32 indicates that multi-value OPTION/RELATION properties accept "list of strings (UUIDs) or single string," but the documentation doesn't explain how the API handles both formats. Specifically:

1. When a single UUID string is sent for a multi-value property, does it create one record, or is behavior identical to passing ["uuid"]?
2. Are there edge cases where format matters (e.g., does sending a single string prevent multiple record creation that a list would enable)?

Clarify the expected behavior to avoid developer confusion about when to use single strings vs. arrays.

Suggested clarification:

- OPTION/RELATION (multi, when is_multi=True): list of strings (UUIDs) or single string
+ OPTION/RELATION (multi, when is_multi=True): list of strings (UUIDs) for multiple values, or single string (UUID) for a single value

And expand lines 34-35:

  For multi-value properties (is_multi=True):
- - Accept either a single UUID string or a list of UUID strings
+ - Accept either a single UUID string or a list of UUID strings. Single strings create one property value; lists create multiple records.

Also applies to: 34-35

---

31-32: Consider specifying UUID format expectations.

The documentation references UUIDs but doesn't specify the expected format (e.g., with hyphens, UUID v4). While this may be obvious from API responses, explicitly stating the format would help developers avoid format mismatches.

Example addition:

- OPTION/RELATION (single): string (UUID)
- OPTION/RELATION (multi, when is_multi=True): list of strings (UUIDs) or single string
+ OPTION/RELATION (single): string (UUID in standard format, e.g., `550e8400-e29b-41d4-a716-446655440000`)
+ OPTION/RELATION (multi, when is_multi=True): list of strings (UUIDs) or single string

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b793a98 and 356b720.

📒 Files selected for processing (2)

• api-reference/issue-types/properties/add-property.mdx (1 hunks)
• api-reference/issue-types/values/add-property-values.mdx (1 hunks)

🔇 Additional comments (1)

api-reference/issue-types/properties/add-property.mdx (1)

36-46: Well-documented options parameter for OPTION-type property creation.

The new options parameter documentation is clear and comprehensive. It effectively explains how developers can set options during property creation rather than requiring a separate API call. The field descriptions and reference to the post-creation API endpoint are helpful.