Skip to content

Added new endpoint to pull class level descriptions, #PG-5184#37

Merged
lachiebol merged 3 commits into
5.x-devfrom
PG-5184-add-endpoint-with-description
May 13, 2026
Merged

Added new endpoint to pull class level descriptions, #PG-5184#37
lachiebol merged 3 commits into
5.x-devfrom
PG-5184-add-endpoint-with-description

Conversation

@lachiebol
Copy link
Copy Markdown
Contributor

@lachiebol lachiebol commented May 11, 2026

Description

index.php?module=API&method=OpenApiDocs.getAllowedPluginDescriptions&format=json

Issue No

Steps to Replicate the Issue

Checklist

  • [✔] Tested locally or on demo2/demo3?
  • [✔] New test case added/updated?
  • [NA] Are all newly added texts included via translation?
  • [NA] Are text sanitized properly? (Eg use of v-text v/s v-html for vue)
  • [NA] Version bumped?
  • [✔/✖/NA] Documentation updated?

@lachiebol lachiebol changed the title Added new endpoint to pull class level descriptions as well, #PG-5184 Added new endpoint to pull class level descriptions, #PG-5184 May 11, 2026
@lachiebol lachiebol requested a review from AltamashShaikh May 12, 2026 00:00
@lachiebol lachiebol added the Needs Review For pull requests that need a code review. label May 12, 2026
@lachiebol lachiebol marked this pull request as ready for review May 12, 2026 00:00
Comment thread Generation/PluginListProvider.php Outdated
/**
* @return array<string, string>
*/
public function getAllowedPluginDescriptions(): array
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.

@lachiebol Should we make this more generic like below ? and return the response as
[
'pluginName' => ['description' => 'description'];
]

Suggested change
public function getAllowedPluginDescriptions(): array
public function getPluginMetaData(): array

This way if tomorrow a new info is required we just add it to an array

AltamashShaikh
AltamashShaikh previously approved these changes May 12, 2026
Copy link
Copy Markdown
Contributor

@AltamashShaikh AltamashShaikh left a comment

Choose a reason for hiding this comment

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

LGTM otherwise.

@lachiebol lachiebol merged commit f290b8f into 5.x-dev May 13, 2026
7 checks passed
@lachiebol lachiebol deleted the PG-5184-add-endpoint-with-description branch May 13, 2026 23:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs Review For pull requests that need a code review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants