Note formType deprecation and removal in Forms REST API reference - #623
Note formType deprecation and removal in Forms REST API reference#623promptless-for-oss wants to merge 4 commits into
Conversation
Note that Mautic deprecated the Forms API formType field in 7.1 and removes it in 8.0 (form types are no longer used, ignored on write), per mautic/mautic#17082. Drops formType from the Create Form example.
|
I noticed that some CI checks failed for this PR. I'm investigating whether the failures are caused by this suggestion. If they're unrelated or pre-existing, I'll leave this suggestion unchanged and create a separate suggestion if a standalone docs fix is needed. |
adiati98
left a comment
adiati98
left a comment
There was a problem hiding this comment.
@promptless-for-oss please address the suggestions.
| * - ``formType`` | ||
| - string | ||
| - Type of the Form - ``standalone`` or ``campaign`` | ||
| - Type of the Form - ``standalone`` or ``campaign``. Mautic deprecated this field in 7.1 and removes it from API responses in 8.0. Form types are no longer used |
There was a problem hiding this comment.
Usea active instead of passive voice.
| * - ``formType`` | ||
| - string | ||
| - Type of the Form - ``standalone`` or ``campaign`` | ||
| - Type of the Form - ``standalone`` or ``campaign``. Mautic deprecated this field in 7.1 and removes it in 8.0. Because Form types are no longer used, Mautic ignores any value submitted for this field |
There was a problem hiding this comment.
Usea active instead of passive voice.
|
Thanks @adiati98 — on it. I'll address the review suggestions and convert the flagged passive voice to active voice, then follow up here once the changes are pushed. |
Address @adiati98 review on PR mautic#623: convert the passive constructions on the formType rows (Forms REST API reference) to active voice. - form:read row: 'Form types are no longer used' -> 'Mautic no longer uses Form types' - POST parameters row: 'Because Form types are no longer used ... any value submitted' -> 'Because Mautic no longer uses Form types, it ignores any value you submit'
|
Thanks for the review, @adiati98 — both comments are addressed. The two
The deprecation/removal details and the table formatting are unchanged, and Vale is clean on the changed lines. The update is pushed to this PR. |
4 participants
Open in Promptless
mautic/mautic PR #17082 removes the long-deprecated
formTypefield from the Form entity in Mautic 8.0. The field has been deprecated since 7.1 and disappears fromform:readresponses in 8.0; because form types are no longer used, Mautic ignores anyformTypevalue submitted on write (this was already the case before 8.0).The Forms REST API reference documented
formTypeas a live field. This annotates the field's read-response and create request property tables with its deprecation-in-7.1 / removal-in-8.0 lifecycle and its ignored-on-write behavior, and dropsformTypefrom the Create Form PHP example. The field is left in place rather than deleted because the 7.2 docs branch still serves Mautic 7.x, where responses continue to include it.File touched:
docs/rest_api/forms.rst.Trigger Events
Review feedback addressed (@adiati98 — "Use active instead of passive voice")
Both flagged
formTyperows converted to active voice per the Mautic Active Voice style rule. Facts (deprecation in 7.1, removal in 8.0, ignored-on-write) unchanged; RST table formatting preserved.docs/rest_api/forms.rst:241(Form properties / read-response row) — applied:Form types are no longer used→Mautic no longer uses Form types.docs/rest_api/forms.rst:677(POST parameters / create-request row) — applied:Because Form types are no longer used, Mautic ignores any value submitted for this field→Because Mautic no longer uses Form types, it ignores any value you submit for this field.