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

Fix API reference page is partly broken #11033

Merged
merged 7 commits into from Dec 18, 2016
Merged

Fix API reference page is partly broken #11033

merged 7 commits into from Dec 18, 2016

Conversation

mattab
Copy link
Member

@mattab mattab commented Dec 18, 2016

In http://developer.piwik.org/api-reference/reporting-api
the titles Module XYZ are missing because in Piwik 3 we use an angular js directive to display titles.

in this PR we restore the previous behavior for the listAllMethods controller action (called to generate our API ref doc in https://github.com/piwik/developer-documentation/blame/master/docs/3.x/reporting-api.md#L204-L206 )

@mattab mattab added the not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org. label Dec 18, 2016
@mattab mattab added this to the 3.0.0-rc milestone Dec 18, 2016
* @return string
*/
public function getAllInterfaceString($outputExampleUrls = true, $prefixUrls = '')
public function getAllInterfaceString($outputExampleUrls = true, $prefixUrls = '', $displayTitlesAsAngularDirective = true)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be better to either have a separate method for this, OR to rename it to something like "embedded or widgetized" and not that specific that will break over time and be misused over time. Ideally it was a separate method though or we would include angular wherever it is embedded.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of calling the API directly maybe it could be built a widget maybe? not sure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants