Skip to content

Started on swagger docs page, #PG-4639#862

Open
lachiebol wants to merge 5 commits intolivefrom
PG-4639-add-swagger-page
Open

Started on swagger docs page, #PG-4639#862
lachiebol wants to merge 5 commits intolivefrom
PG-4639-add-swagger-page

Conversation

@lachiebol
Copy link

@lachiebol lachiebol commented Feb 20, 2026

Description

Hidden page, can be found at /api-reference-swagger

Haven't done much css just some basic touch ups, theming to be done in https://innocraft.atlassian.net/browse/PG-4594

Checklist

  • [✔] I have understood, reviewed, and tested all AI outputs before use
  • [✔] All AI instructions respect security, IP, and privacy rules

Review

@lachiebol lachiebol changed the title Started on swagger docs page Started on swagger docs page, #PG-4639 Feb 20, 2026
@lachiebol lachiebol marked this pull request as ready for review February 20, 2026 02:09
if (typeof SwaggerUIBundle === 'function') {
SwaggerUIBundle({
dom_id: '#swagger-ui',
url: '/openapi/matomo_openapi_spec_v1.0.0.json',
Copy link
Contributor

Choose a reason for hiding this comment

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

@lachiebol This should ideally come from a demo URL right ?

Copy link
Author

@lachiebol lachiebol Feb 20, 2026

Choose a reason for hiding this comment

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

@AltamashShaikh Oh will we grab from demo using the OpenApiDocs API?

I might need to do a separate PR to let us get the generated version in OpenApiDocs. Currently the API method generates a spec only for one plugin, and does it every time the endpoint is hit

Copy link
Contributor

Choose a reason for hiding this comment

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

@lachiebol How are you planning to keep this updated ?

Copy link
Author

Choose a reason for hiding this comment

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

@AltamashShaikh That was a thought I was having while doing this, so I think having it be from demo would make sense. We could have some process that regenerates the spec

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes a command which cloud team can run after deployment

Copy link
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.

@lachiebol The plugin names should be ordered alphabetically I think

Image

Copy link
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.

The UI doesn't look great, but this PR does what is required.

@lachiebol
Copy link
Author

The UI doesn't look great, but this PR does what is required.

@AltamashShaikh I decided to keep styling pretty much out of the box, since this page isn't public and we have a future ticket for doing the theme https://innocraft.atlassian.net/browse/PG-4594

Copy link
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.

Looks good now :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

2 participants

Comments