Skip to content

docs: clarify form status omission semantics - #92

Open
treyhyde wants to merge 1 commit into
v2from
docs/FLCRM-22114-form-status-omission
Open

treyhyde wants to merge 1 commit into
v2from
docs/FLCRM-22114-form-status-omission

Conversation

@treyhyde

Copy link
Copy Markdown
Member

Summary

Clarify the shared FormBody.status_field contract for create versus update operations.

  • New forms: omitting status_field uses default settings.
  • Existing forms: omitting status_field preserves the current configuration.
  • Explicit status_field: null clears the status field.

This documents the backend behavior addressed by fulcrumapp/fulcrum#11149 and closes the API-contract follow-up from review.

Validation

  • Confirmed the schema remains valid JSON.
  • Confirmed FormBody is used by both create and update form operations.

@treyhyde
treyhyde requested review from a team as code owners September 18, 2026 17:13
Copilot AI lite review requested due to automatic review settings September 18, 2026 17:13

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Pull request overview

Clarifies the FormBody.status_field omission and null semantics for create and update operations.

Changes:

  • Documents that omission uses defaults for new forms.
  • Documents that omission preserves existing configuration for updates.
  • Documents that explicitly setting status_field to null clears it.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread reference/rest-api.json
},
"status_field": {
"description": "Configuration for the built-in status field. Omit to use the default status field settings.",
"description": "Configuration for the built-in status field. For new forms, omit this property to use the default status field settings. For updates, omit this property to preserve the form's existing status field configuration. Set it to null to clear the status field.",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the default status field settings just disabled (that's what I'm seeing in testing)? Is that clarified anywhere?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants