Skip to content

API Description Review Findings # #96

@jillLovato

Description

@jillLovato

Problem description
CAMARA Outreach team is reviewing all API descriptions on the CAMARA website using a checklist.

Possible evolution
In case of findings an issue is opened to ask the Sub Project to enhance the API description in the Wiki, and then open an issue at the Marketing repo so that the Outreach team then can update the website.

Alternative solution

Additional context

Findings from QoS Booking and Assignment:

  • Change “SubProject Wiki:” → “Sub Project Wiki:”
  • Update API Wiki link text/link to specifically reference QoSBooking and Assignment API description, not just QoS Booking.
  • Update API Repository link text so it does not look like it belongs only to the separate QoS Booking API.
  • Bold the use case names and add relevant GSMA Use Case Library links.
  • Reformat benefits as bold benefit name + description.
  • Fix minor grammar/copy:
  • “existing and an active” → “existing, active”;
  • “Ensure compliance” → “Ensures compliance.”"
  • Replace with an image that is descriptive of the API / use cases

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    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