Skip to content

v0.1.0 - Initial release

Compare
Choose a tag to compare
@rartych rartych released this 22 Aug 08:41
051be00

Initial version of guidelines and assets based on the work done in Commonalities WG.

Please note:

The content of the release includes:

  • Commonalities approved deliverables in documentation folder:
    • API-Readiness-Checklist.md - A checklist to ensure minimum readiness of the API
    • API-design-guidelines.md - API design guidelines -the main document with guidelines for the API design in CAMARA project. These guidelines are applicable to every CAMARA API;
    • Camara_Versioning_Guidelines.md - Guidelines to create CAMARA subproject releases
    • Glossary.md - Glossary of terms and common parameter/field names to be used in every CAMARA API
    • Issue and PR template Howto.md - Instruction for use of Github templates for issues and pull request for CAMARA repositories
    • UE-Identification.md - an overview of methods that a 5G Core network has for enabling external parties to identify UEs in the network
    • Userstory-template.md - the template for documenting user stories related to API families in CAMARA project
    • API-DocumentationTemplate.md- API documentation template - currently obsoleted by embedding documentation into OAS YAML files
  • Commonalities approved artifacts in artifacts folder:
    • CAMARA_common.json - Common data and errors for CAMARA APIs in JSON file
    • Github_templates - .github folder with Github templates for issues and pull request