Skip to content

API description review findings #207

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 WebRTC:

  • "WebRTC APIs aims" -> "aim"
  • Distinguish Call Handling from Registration / Event Subscription
  • "IA" -> "AI"; "all kind" -> "all kinds"; "tradition SIP" -> "traditional SIP"
  • Clarify the asynchronous event subscription
  • Remove inconsistent emoji/dash formatting. Try to format the use case section and the benefit section like it is done for the other APIs
  • Expand the registration lifecycle (register / refresh / remove / expire)
  • Use Case section: Please check if you can link exisiting use cases in the GSMA use case library
  • Use cases are understandable but could include more concrete developer scenarios
  • 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.
  • Additional business-oriented examples would strengthen the page (use cases and benefits)
  • Benefits could better explain why event-driven notifications simplify application development.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions