Skip to content

docs: Port "Point Actions" REST API page to 7.2#564

Open
promptless-for-oss wants to merge 5 commits into
mautic:7.2from
Promptless:promptless/docs-issue-452-point-actions-7.2
Open

docs: Port "Point Actions" REST API page to 7.2#564
promptless-for-oss wants to merge 5 commits into
mautic:7.2from
Promptless:promptless/docs-issue-452-point-actions-7.2

Conversation

@promptless-for-oss

Copy link
Copy Markdown
Contributor

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


Tip: Use labels in the Promptless dashboard to categorize suggestions by release or team 🏷️

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.
Comment thread docs/rest_api/point_actions.rst Outdated
.. vale on No newline at end of file
.. vale on

Use this endpoint to obtain details on Mautic's Point Actions.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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.

Source: https://github.com/mautic/developer-documentation/blob/main/source/includes/_api_endpoint_point_actions.md

@adiati98 adiati98 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.

@promptless-for-oss There are a couple of things:

  1. 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.

  1. 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'.
@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Thanks for the review, @adiati98! I've updated this PR to address both points:

  1. Consistent REST API page format — I restructured and reworded docs/rest_api/point_actions.rst to follow the canonical format of forms.rst, aligning section ordering, heading style, and wording conventions.
  2. Leading note admonition — removed the .. note:: admonition that appeared right after the main title.

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 adiati98 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.

@promptless-for-oss please address the suggestions.

Comment thread .github/styles/config/vocabularies/Mautic/accept.txt Outdated
Comment thread docs/rest_api/point_actions.rst Outdated
Comment thread docs/rest_api/point_actions.rst Outdated
Comment thread docs/rest_api/point_actions.rst Outdated
Comment thread docs/rest_api/point_actions.rst Outdated
Comment thread docs/rest_api/point_actions.rst Outdated
- 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
@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Thanks for the review, @adiati98! I've pushed updates addressing all your suggestions:

  • Feature-name capitalization — Removed the Point Action/Point Actions entries from the Vale vocab accept list so the Mautic FeatureList governs capitalization, and followed the style throughout the page.
  • integerint — Changed all property/parameter types to int per the devs' convention.
  • publishedOnly description — Now reads 'Returns only currently activated entities'.
  • Get Point Action types — Renamed the heading, and updated its description to 'Retrieves an array of available Point Action types.' and the response wording to * Returns ``200 OK`` when the request successfully retrieves the Point Action types.

Ran Vale on the changed RST file and resolved the findings. Ready for another look.

Comment thread docs/rest_api/point_actions.rst Outdated
@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Thanks, @adiati98! I've applied your suggestion.

  • Changed the isPublished property description from Point Action publication statusPoint Action activation status, aligning with the Activate/Turn On terminology convention.

I also re-checked the rest of the page for consistency: the publishUp/publishDown rows already read "Activation/Deactivation date and time" and the publishedOnly parameter already reads "Returns only currently activated entities" from the prior review round. The remaining publishUp/publishDown/isPublished tokens are literal API property names, so those stay verbatim. Vale passes on the changed file. Ready for another look.

@adiati98 adiati98 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.

@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.

Comment thread docs/rest_api/point_actions.rst Outdated
Comment thread docs/rest_api/point_actions.rst Outdated
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.
@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Thanks @adiati98 — good catch. I dug into the source: the classic REST create/edit endpoints validate through PointType (PointBundle/Form/Type/PointType.php), and Point::loadValidatorMetadata marks only name, type, and delta as required. I've replaced the property cross-references with a dedicated POST parameters table under Create listing just the writable request fields (with required markers), and Edit now references that table with an "all parameters optional" note — matching the forms.rst pattern you linked. Ready for another look.

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.

2 participants