UX improvements, #PG-5232#52
Open
lachiebol wants to merge 7 commits into
Open
Conversation
| "ReportingApiMoreInformation": "More info about the Matomo APIs available in %1$sIntroduction to Matomo API%2$s and the %3$sMatomo API Reference%4$s.", | ||
| "ReportingApiReference": "Reporting API Reference", | ||
| "ReportingApiSummary": "All the data in Matomo is available through simple APIs.", | ||
| "SwaggerPageConnectToken": "Connect your Matomo API token", |
Contributor
There was a problem hiding this comment.
Should this be "Add your Matomo API token" ?
If this is given by Gillian, good to add
Contributor
Author
There was a problem hiding this comment.
Gillian suggested 'Authenticate with a Matomo API token' Will go with that
Contributor
AltamashShaikh
left a comment
AltamashShaikh
left a comment
There was a problem hiding this comment.
@lachiebol LGTM overall, but this looks like a valid concern, can you check
High-Risk Issues Blocking
Annotations/GlobalApiComponents.php:18 changes the OpenAPI security scheme id from MatomoToken to Matomo API token, and Annotations/GlobalApiComponents.php:36 uses the same spaced name as the
component key. OpenAPI component keys are expected to be identifier-like keys, not user-facing labels with spaces. The fixture now contains "Matomo API token" under components.securitySchemes, so
generated specs become invalid or at least less interoperable for validators/codegen tooling. Keep the scheme id stable, e.g. MatomoToken, and put the user-facing copy in description or UI-layer
text.
Contributor
Author
I'll just revert this, I don't think it's impacting UX too much. The description change is probably enough here |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Issue No
Steps to Replicate the Issue
Checklist