Skip to content

Updated API documentation, PG-4988#238

Merged
lachiebol merged 3 commits into5.x-devfrom
PG-4988-api-documentation
Feb 24, 2026
Merged

Updated API documentation, PG-4988#238
lachiebol merged 3 commits into5.x-devfrom
PG-4988-api-documentation

Conversation

@lachiebol
Copy link
Contributor

@lachiebol lachiebol commented Feb 24, 2026

Description

To have a look at what it looks like in swagger
ddev matomo:console openapidocs:generate-spec-file --plugin CustomAlerts --not-dry-run --add-annotations

Then copy json result into: https://editor.swagger.io/

Issue No

Steps to Replicate the Issue

Checklist

  • [✖] Tested locally or on demo2/demo3?
  • [NA] 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?
  • [✔] I have understood, reviewed, and tested all AI outputs before use
  • [✔] All AI instructions respect security, IP, and privacy rules

@lachiebol lachiebol requested a review from a team February 24, 2026 03:31
@AltamashShaikh
Copy link
Contributor

@lachiebol FYI, even PHPStorm provides the preview, when viewing spec file

image

@lachiebol
Copy link
Contributor Author

@AltamashShaikh Thanks for letting me know 😄 I wasn't aware, something might be missing in my setup as that doesn't show for me.

@lachiebol lachiebol merged commit 77d8e3c into 5.x-dev Feb 24, 2026
11 checks passed
@lachiebol lachiebol deleted the PG-4988-api-documentation branch February 24, 2026 04:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants