documentation issue - Auth
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 205
- Forks
- 129
- PR merge metrics
- No merged PRs in 30d
Description
Hi,
a wording confusion
in api code there is uses
'**clientKey**' => '', // **Client/Consumer key** from Mautic
'**clientSecret**' => '', // **Client/Consumer secret key** from Mautic
and in the Frontend there are the fields called "publickey" and "sercretkey"
so solutions are:
use only one word for one thing everywhere, else its confuising people who wants to use mautic
or make a mapping table in docs
clientKey == Client/Consumer key from Mautic (never shown in Frontend) == publickey (used in Mautic Frontend)
....
Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the API authentication parameter documentation or code and the frontend fields named publickey and sercretkey. Compare the terminology, then document a consistent naming scheme or mapping table so users can identify the corresponding Mautic values.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- api, authentication, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100