Get spec generation ready for initial plugin API specs

[snake14]

Description

Doing some cleanup to improve the quality of the annotations and specs which can be generated.

Issue No

PG-4544

Steps to Replicate the Issue

1. Run ddev matomo:console openapidocs:generate-spec-file --plugin=CustomReports --not-dry-run
2. Open plugins/CustomReports/OpenApi/Specs/CustomReports_v1.0.0.json in PHPStorm and confirm that everything validates
3. Switch to preview mode and see the spec presented via Swagger UI

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?

[AltamashShaikh]

@snake14
no input for array values, is that expected ?

Also unreleated, getAvailableDimensions and getAvailableMetrics requires idsite but it is never used

[snake14]

@snake14 no input for array values, is that expected ?

Also unreleated, getAvailableDimensions and getAvailableMetrics requires idsite but it is never used

@AltamashShaikh Yes. That's apparently how SwaggerUI works. If you click on the Try it out button, it provides the ability to add items to the array:

Even if a parameter isn't used by the method, if it's in the signature and doesn't provide a default value in the signature, it's technically a required parameter and enforced by Matomo. If I make a request to either of those endpoints without the idSite parameter, I receive the following error response: Please specify a value for 'idSite'..

[AltamashShaikh]

Looks good to me 👍

[snake14]

@AltamashShaikh I thought that I had moved it out of draft. Can you please approve so that I can merge?