Skip to content

Finalising annotation generation before annotating first plugins#9

Merged
snake14 merged 9 commits into
5.x-devfrom
PG-4544-annotation-improvements
Sep 17, 2025
Merged

Finalising annotation generation before annotating first plugins#9
snake14 merged 9 commits into
5.x-devfrom
PG-4544-annotation-improvements

Conversation

@snake14
Copy link
Copy Markdown
Contributor

@snake14 snake14 commented Sep 15, 2025

Description

Make various improvements in the annotation generation including fixing some issues. This will allow most examples to be included and most responses typed.

Issue No

PG-4544

Steps to Replicate the Issue

  1. Check out the latest version of the CustomReports plugin
  2. Run the command to generate the annotations: ddev matomo:console openapidocs:generate-annotations --plugin=CustomReports --not-dry-run
  3. Run the command to generate the spec file: ddev matomo:console openapidocs:generate-spec-file --plugin=CustomReports --not-dry-run
  4. Open the spec file at plugins/CustomReports/OpenApi/Specs/CustomReports_v1.0.0.json and preview in PHPStorm to see the SwaggerUI presentation with almost all parameters and responses fully typed (A CustomReports PR is making a few changes to allow even better results).

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?

@snake14 snake14 marked this pull request as ready for review September 15, 2025 21:48
@snake14 snake14 added the Needs Review For pull requests that need a code review. label Sep 15, 2025
@snake14 snake14 requested a review from a team September 15, 2025 21:49
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.

Left couple of comments, rest looks good to me.

Comment thread Annotations/AnnotationGenerator.php
Comment thread Annotations/AnnotationGenerator.php Outdated
AltamashShaikh

This comment was marked as off-topic.

@snake14 snake14 merged commit 70a541c into 5.x-dev Sep 17, 2025
7 checks passed
@snake14 snake14 deleted the PG-4544-annotation-improvements branch September 17, 2025 02:18
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