developer-documentation icon indicating copy to clipboard operation
developer-documentation copied to clipboard

Missing information about CoreAdminHome.invalidateArchivedReports in reporting API page

Open heurteph-ei opened this issue 2 years ago • 4 comments

Page and section where documentation is missing

https://developer.matomo.org/api-reference/reporting-api#CoreAdminHome

What is missing

Information about method=CoreAdminHome.invalidateArchivedReports

heurteph-ei avatar Mar 15 '22 14:03 heurteph-ei

@tsteur is there any reason not to add this function to the API docs? Simple change I guess, we could add to the current milestone if wanted.

justinvelluppillai avatar Aug 09 '22 01:08 justinvelluppillai

@justinvelluppillai the method has an @hideExceptForSuperUser which means it doesn't appear in the docs I believe unless the docs are requested by a super user. I'm not really sure why it's set there. I've looked at the blame but it's been there for a very long time. image

Potentially it could be added to the docs but would need to make sure to not regress any behaviour.

Maybe @mattab remembers why it was hidden from the docs.

tsteur avatar Aug 09 '22 02:08 tsteur

I can't remember... Maybe it wouldn't regress anything if @hideExceptForSuperUser was removed?

mattab avatar Aug 14 '22 22:08 mattab

A little up, as I encountered the case again while helping users in matomo forum...

heurteph-ei avatar Sep 15 '23 13:09 heurteph-ei