docs: Port "Point Actions" REST API page to 7.2#564
Conversation
Convert the legacy Point Actions REST API reference from Markdown to RST and replace the placeholder note on the 7.2 page. Content mirrors the already-ported Point Groups sibling page conventions.
| .. vale on No newline at end of file | ||
| .. vale on | ||
|
|
||
| Use this endpoint to obtain details on Mautic's Point Actions. |
There was a problem hiding this comment.
Source content for the entire point_actions.rst page. Converted the legacy _api_endpoint_point_actions.md Markdown endpoint reference (Get, List, Create, Edit, Delete Point Actions and Get Point Action Types) to RST, matching the conventions of the already-ported docs/rest_api/point_groups.rst sibling page.
There was a problem hiding this comment.
@promptless-for-oss There are a couple of things:
- Specifically for the REST API pages, we want to keep the structure and wording (if applicable) consistent throughout the pages. Refer to https://github.com/mautic/developer-documentation-new/blob/7.1/docs/rest_api/forms.rst for the format.
Please address this, also for other open PRs that updating the REST API pages.
- Remove the first note admonition right after main title. Also apply this for other open PRs.
Address review feedback on PR mautic#564: - Restructure point_actions.rst to match docs/rest_api/forms.rst: real RST subsection headings (HTTP request / Response / Properties / parameters), bullet-style response status wording, and :ref: cross-references instead of repeated tables and bold pseudo-headings. - Remove the leading placeholder note admonition after the main title. - Add 'Point Action(s)' to the Mautic Vale vocabulary so feature headings pass Google.Headings, consistent with existing accepted terms like 'Marketing Messages'.
|
Thanks for the review, @adiati98! I've updated this PR to address both points:
Vale passes on the changed file. Your broader request to apply the same conventions to the other open REST API PRs is noted and will be handled per-PR separately. |
adiati98
left a comment
There was a problem hiding this comment.
@promptless-for-oss please address the suggestions.
- Remove Point Action/Point Actions from Vale vocab accept.txt (feature names are handled by Mautic FeatureList, capitalization is intentional) - Change property/parameter types from 'integer' to 'int' per devs' convention - Fix publishedOnly description to 'Returns only currently activated entities' - Rename 'Get Point Action Types' heading to 'Get Point Action types' - Wrap 'Point Action properties' heading in vale off to match forms.rst
|
Thanks for the review, @adiati98! I've pushed updates addressing all your suggestions:
Ran Vale on the changed RST file and resolved the findings. Ready for another look. |
|
Thanks, @adiati98! I've applied your suggestion.
I also re-checked the rest of the page for consistency: the |
adiati98
left a comment
There was a problem hiding this comment.
@promptless-for-oss please address the suggestions. I think you should use the parameters from the response code-block and create a new table. Please do deep analyze if you need to.
Replace the response-property cross-references in the Create and Edit sections with a dedicated POST parameters table of writable request fields, matching the canonical forms.rst format. Fields and required markers (name, type, delta) verified against PointType/Point entity in mautic/mautic. Edit references the Create table with an all-optional note.
|
Thanks @adiati98 — good catch. I dug into the source: the classic REST create/edit endpoints validate through |
Open this suggestion in Promptless to view citations and reasoning process
Ports the legacy Point Actions REST API reference into docs/rest_api/point_actions.rst on the 7.2 base branch, converting the legacy Markdown to RST and replacing the placeholder note. Covers Get, List, Create, Edit, Delete Point Actions and Get Point Action Types endpoints. Resolves docs issue #452 (7.1 source content, targeting 7.2 per team decision to set content in the default branch first, then backport).
Trigger Events
blockedlabel is to set content, structure, and tone in one branch, then backport/cherry pick i...Tip: Use labels in the Promptless dashboard to categorize suggestions by release or team 🏷️