Skip to content

Update Swagger Generator to read php function & class docblocks, #PG-4883#19

Merged
lachiebol merged 7 commits into
5.x-devfrom
PG-4883-update-swagger-generator
Feb 9, 2026
Merged

Update Swagger Generator to read php function & class docblocks, #PG-4883#19
lachiebol merged 7 commits into
5.x-devfrom
PG-4883-update-swagger-generator

Conversation

@lachiebol
Copy link
Copy Markdown
Contributor

@lachiebol lachiebol commented Feb 5, 2026

Description

Also added a few fixes to this:

There was an issue where param defaults that were strings (e.g sortorder="desc") were wrapped twice in quotes, I removed the json_encode when it's a string, as it already wraps them in quotes before outputting

Another issue where functions that returned void would not have any response associated with them, I've attached the GenericSuccess response to anything that returns void.

Also updated the annotations source -> we're not adding the OA annotations to the API.php file anymore

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)
  • [✔] Version bumped?

@lachiebol lachiebol changed the title Pg 4883 update swagger generator Update Swagger Generator to read php function & class docblocks, #PG-4883 Feb 5, 2026
@lachiebol lachiebol requested a review from a team February 5, 2026 01:54
@lachiebol lachiebol added the Needs Review For pull requests that need a code review. label Feb 5, 2026
@lachiebol lachiebol marked this pull request as ready for review February 5, 2026 01:54
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

@lachiebol lachiebol merged commit e4436d1 into 5.x-dev Feb 9, 2026
7 checks passed
@lachiebol lachiebol deleted the PG-4883-update-swagger-generator branch February 9, 2026 01:52
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