Skip to content

API description review finding #43

Description

@MarkusKuemmerle

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 in Device Visit Location:

  • The API description is very short. A couple of more details could be helpful.
  • Use Case section: Please check if you can link exisiting use cases in the GSMA use case library
  • Use Case names and Benefit names: Use capitals for the main words to be in the same style like all other API descriptions. Also use capitals after a colon.
  • The image should visualize the most interesting use case to attract customers and developers. Please provide us instructions how such a visual should be built and look like. We ask the LF creative team to create the visual. You can put the instructions also in the wiki page below the visual.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Fields

    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