Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review HTTP Reporting APIs marked with @internal and make them public APIs where it makes sense #12925

Open
mattab opened this issue May 17, 2018 · 0 comments
Labels
c: APIs For bugs and features in the Matomo HTTP and plugin APIs.

Comments

@mattab
Copy link
Member

mattab commented May 17, 2018

We have several @internal tagged HTTP API methods, which results in them being hidden from the documentation and unavailable to users.

The goal of this issue is to review all 15 @internal tagged APIs and remove the tag where possible. For example the following APIs should be made public APIs: setAnonymizeIpSettings, deactivateDoNotTrack, activateDoNotTrack, setScheduleReportDeletionSettings, ...

In some cases it probably does not make sense ie. when exposing this API would not provide new value to users.

For all APIs now made public:

  • ensure the name is good/consistent for being API, otherwise rename the method
  • ensure there are tests running so the API always will work
  • mention in the Developer Changelog
@Findus23 Findus23 added the c: APIs For bugs and features in the Matomo HTTP and plugin APIs. label May 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: APIs For bugs and features in the Matomo HTTP and plugin APIs.
Projects
None yet
Development

No branches or pull requests

3 participants