Problem description
This issue is based on the Camara Marketing “Checklist for API description review”:
https://github.com/camaraproject/Marketing/blob/main/documentation/SupportingDocuments/Checklist_for_API_description_review.md
The Brand Registration API page reviewed:
https://camaraproject.org/brand-registration/
The page has checklist compliance gaps for:
- API Description (the image is only illustrative)
- Use Cases (text format / missing GSMA Use Case Library links)
- Sub Project Wiki (incorrect prefix / no link)
Expected action
Please update the Brand Registration API documentation page so it matches the checklist by applying the following corrections:
- API Description
- The image is currently illustrative and does not clearly represent a “typical use case” workflow/value for developers (as expected by the checklist).
- Use Cases
- Sub Project Wiki
- The correct prefix is "Sub Project Wiki:" (current prefix: "SubProject Wiki:")
- No link available in the section, just a pointer to the API Wiki section. Proposal: inline the link to the Verified Caller API wiki in this section as well.
Additional context
Checklist reference:
https://github.com/camaraproject/Marketing/blob/main/documentation/SupportingDocuments/Checklist_for_API_description_review.md
Reviewed page export:
https://camaraproject.org/brand-registration/
Problem description
This issue is based on the Camara Marketing “Checklist for API description review”:
https://github.com/camaraproject/Marketing/blob/main/documentation/SupportingDocuments/Checklist_for_API_description_review.md
The Brand Registration API page reviewed:
https://camaraproject.org/brand-registration/
The page has checklist compliance gaps for:
Expected action
Please update the Brand Registration API documentation page so it matches the checklist by applying the following corrections:
Additional context
Checklist reference:
https://github.com/camaraproject/Marketing/blob/main/documentation/SupportingDocuments/Checklist_for_API_description_review.md
Reviewed page export:
https://camaraproject.org/brand-registration/