docs: Add Themes API endpoint documentation (#471)#482
Conversation
Migrate Themes REST API documentation from legacy markdown to RST format. Content verified against Mautic 7.0 source code (ThemeApiController.php and ThemeHelper.php). Documents all endpoints: get, list, create, delete. Adds detailed response properties including theme config fields.
Co-authored-by: promptless[bot] <promptless[bot]@users.noreply.github.com>
promptless-for-oss
force-pushed
the
promptless/issue-471-themes-api-page
branch
from
614b540 to
749cc08
Compare
|
@mautic/core-team can you please review the content here? TIA! ✨ |
adiati98
left a comment
adiati98
left a comment
There was a problem hiding this comment.
@promptless-for-oss please address the suggestions
Address PR review suggestions from @adiati98: - Improve intro paragraph and section headers for consistency - Use "HTTP request" and "Response" as proper RST section headers - Add "Returns 200 OK" pattern to all Response sections - Change property headers to proper RST formatting - Improve wording for theme descriptions and error responses - Add vale off/on around "Config object properties" header - Use bullet list format for error conditions - Update note about default Theme deletion prevention
|
I've addressed all the review suggestions from @adiati98. Changes applied:
Ready for re-review. |
adiati98
left a comment
adiati98
left a comment
There was a problem hiding this comment.
Let's address the Vale warnings.
@promptless-for-oss please address the suggestions
- Add vale off/on directives around all 4 HTTP request section headers - Shorten 'application' to 'app' in delete default Themes note
|
Thanks @adiati98 for the review feedback! I've addressed all your suggestions:
The changes have been pushed to this PR branch. |
adiati98
left a comment
adiati98
left a comment
There was a problem hiding this comment.
@promptless-for-oss please address the suggestions
Address PR review feedback from @adiati98 to use "ZIP file" consistently throughout the Themes API documentation.
|
Thanks for the review, @adiati98! I've applied all 6 suggestions - the changes capitalize "ZIP file" consistently throughout the Themes API documentation. The updated commit has been pushed to this PR. |
|
@promptless-for-oss please backport the changes here to branch 7.1, 6.0, and 5.x. |
|
Thanks @adiati98! I've created the backport PRs: Completed backports:
Note about 7.1: The 7.1 branch doesn't exist in this repository. The available version branches are 7.0 (default), 6.0, and 5.x. The original PR #482 already targets 7.0, so no separate 7.1 backport is needed. Both backports include the complete Themes API documentation covering all endpoints (get, list, create, delete) with detailed response properties. |
@promptless-for-oss, we do have 7.1 branch. |
|
You're right, apologies for the confusion! I can confirm the 7.1 branch exists. I've prepared the 7.1 backport content, but I'm encountering a technical issue creating the PR - our system needs to sync the 7.1 branch. I've escalated this to the Promptless team and will follow up once the PR is ready. In the meantime, the 6.0 and 5.x backports are ready for review:
|
|
@promptless-for-oss try to backport to branch 7.1 again. |
…o 7.1 Backports the complete Themes REST API documentation from PR mautic#482 to the 7.1 branch. Documents all endpoints (get, list, create, delete) with detailed response properties and configuration objects.
|
Done! I've recreated the backport to branch 7.1. Backport PR: #514 The PR contains the complete Themes API documentation targeting the 7.1 branch. |
adiati98
left a comment
adiati98
left a comment
There was a problem hiding this comment.
Thank you, @khawarlatifkhan! 🚀
Backport of Themes REST API documentation from PR #482 to the 5.x branch. Replaces placeholder stub with complete documentation for all endpoints (get, list, create, delete) with response properties.
Backport of Themes REST API documentation from PR #482 to the 6.0 branch. Replaces placeholder stub with complete documentation for all endpoints (get, list, create, delete) with response properties.
4 participants
Migrates the Themes REST API documentation from legacy markdown to RST format. Content verified against Mautic 7.0 source code. Documents all endpoints (get, list, create, delete) with detailed response properties.
Closes #471