Page Comparison

...

• Check Info object

  • version: aligned with the released API version and formatted correctly (per Commonalities)

  • description: check that it

    • contains sufficient in-line API documentation

    • does not use Telco Jargon / abbreviations (non blocking for release if in documentation), e.g. avoids use of

      • "customer", unless explicitly explained what is meant. Instead use as applicable “API consumer”, (application) “end-user”, or whatever else is applicable.

      • "Telco/operator/CSP", as also Aggregators, etc. may expose the API. Use a more general term e.g. “API exposure platform owner” as applicable. 

      • "subscriber". Use “Device” or “End-user” (defined as the application user) as applicable

      • “API customer”: use “API consumer” or (application) “end-user”, as applicable

    • contains the mandatory text from the section on authentication and authorization from the ICM CAMARA-API-access-and-user-consent.md.

  • contains the x-camara-commonalities version from the Commonalities release referenced in the API readiness checklist. This should be following the same versioning scheme as in the API URLs. so e.g. “x-camara-commonalities: 0.5”

• Check servers object has the correct version format e.g. v0.xrc1, v1rc1, v0.x or v1.

• Check security schemes: check presence and format (OIDC) and scope name format.

• In externalDocs: this field is optional, but recommend to point to the CAMARA API repository.
    description: Project documentation at CAMARA repository
    url: https://github.com/camaraproject/<api-repository>

• Ensure that error cases are sufficiently explained in in-line documentation in info.description field.

...

• API definition file (see details above)

• commonalities is respected

  • availability of linting report in release issue

• ICM is respected (see below)

• versioning (checked in yaml) is aligned with guidelines

• documentation (beyond in-line)

  • check for Telco jargon / abbeviations (same as in API definition details above)

• user stories - check for Telco jargon / abbeviations (same as in API definition details above)

• basic test files (for M3)

  • cover 2xx response and all error responses (tbc)

• enhanced test files (for M4)

  • cover all error responses

• release numbering is aligned with guidelines

• changelog (see details above)

• certification - for stable public APIs - check GSMA reference.

Commonalities updates (Spring25)

See also: Version 0.5.0 supporting documentation - CAMARA Project - CAMARA Project

ICM updates (Spring25)

Release actions - details

...