Conversation
lachiebol
changed the title
| if (typeof SwaggerUIBundle === 'function') { | ||
| SwaggerUIBundle({ | ||
| dom_id: '#swagger-ui', | ||
| url: '/openapi/matomo_openapi_spec_v1.0.0.json', |
There was a problem hiding this comment.
@lachiebol This should ideally come from a demo URL right ?
There was a problem hiding this comment.
@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
There was a problem hiding this comment.
@lachiebol How are you planning to keep this updated ?
There was a problem hiding this comment.
@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
There was a problem hiding this comment.
Yes a command which cloud team can run after deployment
There was a problem hiding this comment.
@AltamashShaikh @james-hill-matomo Is this something we should resolve now? Or can it be left for later?
There was a problem hiding this comment.
Just thinking we'd have to setup an endpoint and have it reachable on demo.matomo.org for anything to show with the new change. Not sure how much effort that would take
There was a problem hiding this comment.
as discussed, this should be good to merge now, will create a follow-on ticket to make this dynamic, things to check before merge, can we gzip the response ?
AltamashShaikh
left a comment
AltamashShaikh
left a comment
There was a problem hiding this comment.
@lachiebol The plugin names should be ordered alphabetically I think
AltamashShaikh
left a comment
AltamashShaikh
left a comment
There was a problem hiding this comment.
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 |
AltamashShaikh
left a comment
AltamashShaikh
left a comment
There was a problem hiding this comment.
Looks good now :)
2 participants
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
Review