Skip to content

API description checklist compliance review for Sim Swap Subscriptions marketing page #259

@anthorange

Description

@anthorange

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 Sim Swap Subscriptions API page reviewed:
https://camaraproject.org/sim-swap-subscriptions/

The page has checklist compliance gaps for:

  • API Description (the image is only illustrative)
  • Use Cases (missing GSMA Use Case Library links)
  • Sub Project Wiki (incorrect prefix)
  • API Version(s) and Release Date(s) (incorrect date)

Expected action
Please update the Sim Swap Subscriptions API documentation page so it matches the checklist by applying the following corrections:

  1. 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).
  1. Use Cases
  1. Sub Project Wiki
  • The correct prefix is "Sub Project Wiki:" (current prefix: "SubProject Wiki:")
  1. API Version(s) and Release Date(s)
  • v0.1.2 date (04.04.2025) looks incorrect compared to meta-release (Fall24). It should be a dd.mm.2024 instead of 2025.

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/sim-swap-subscriptions/

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions