[DoNotMerge] Demo adding SwaggerUI to documentation

[snake14]

[DoNotMerge]

Description:

This is to demo adding SwaggerUI to the developer documentation. It's using a local JSON OpenAPI spec file for a few plugins. Browse to /api-reference/reporting-api#openapi-documentation (if you're using DDEV https://devdocs.ddev.site/api-reference/reporting-api#openapi-documentation) to see the changes.

Review

• Functional review done
• Potential edge cases thought about (behavior of the code with strange input, with strange internal state or possible interactions with other Matomo subsystems)
• Usability review done (is anything maybe unclear or think about anything that would cause people to reach out to support)
• Security review done
• Wording review done
• Code review done
• Tests were added if useful/possible
• Reviewed for breaking changes
• Developer changelog updated if needed
• Documentation added if needed
• Existing documentation updated if needed

[AltamashShaikh]

@snake14 I am not seeing any swagger UI, I ran composer install inside app folder, do I need to do something additional ?

[snake14]

@snake14 I am not seeing any swagger UI, I ran composer install inside app folder, do I need to do something additional ?

@AltamashShaikh Running composer install should be all that you need. SwaggerUI should be at the bottom where the list of API methods used to be:

The hash in the URL should have scrolled your window. I'm not sure why it didn't.

[AltamashShaikh]

@snake14 app/openapi/demo_matomo_spec_v1.0.0.json Would be pulled directly from demo.matomo.cloud right?

Rest looks good to me, as we are going to update the theming going forward

[AltamashShaikh]

Good to check, if this doc would be indexed by searchengines or not

[snake14]

@snake14 app/openapi/demo_matomo_spec_v1.0.0.json Would be pulled directly from demo.matomo.cloud right?

Rest looks good to me, as we are going to update the theming going forward

@AltamashShaikh Most likely. This is just a POC.

[snake14]

Good to check, if this doc would be indexed by searchengines or not

@AltamashShaikh I'm guessing it's safe to allow indexing as it looks like the site allows indexing for the latest version: https://github.com/matomo-org/developer-documentation/blob/8dd5f6580b9b7de3dfaf901d14468309e4ab27a1/app/templates/base.twig#L10,L12

[james-hill-matomo]

Nice updates :)

[snake14]

Nice updates :)

Thank you @james-hill-matomo . I think I might convert this back to draft to make it even more obvious it shouldn't be merged.