Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 5.18 KB

README.md

File metadata and controls

56 lines (40 loc) · 5.18 KB

Commonalities

Repository to describe and document common guidelines and assets for CAMARA APIs

Scope

  • Guidelines and assets for “Commonalities” (see APIBacklog.md)
  • All deliverables are mandatory for all CAMARA Sub Projects
  • Describe, develop, document and test the deliverables
  • Started: October 2021
  • Location: virtually

Documents for CAMARA Sub Projects

The documents that are relevant for CAMARA API Sub Projects are found in the documentation directory (at the top-level). The rest of the sub-directories are primarily for internal working of the Commonalities Working Group.

The artifacts directory contains:

Frequently-accessed output documents

A list of some of the frequently accessed documents that are an output of the work done in the Commonalities Working Group is provided below. Note that the links are relative to the branch selected. Refer to the section below for released versions.

Document name Purpose
API-design-guidelines.md This document captures guidelines for the API design in CAMARA project. These guidelines are applicable to every API to be worked out under the CAMARA initiative.
Glossary.md A glossary of the common terms and their API parameter/field names for use in the APIs
API-Testing-Guidelines.md Guidelines for the API testing in CAMARA project

NOTE: Guidelines for Release Management of API versions, e.g. the API-Readiness-Checklist, are located within ReleaseManagement. The versioning of APIs is defined within the API-design-guidelines.md.

Status and released versions

For changes see CHANGELOG.md

Meetings

  • Meetings are held virtually on the LF Platform: Meeting Registration / Join
  • Schedule: bi-weekly, Monday, 4 PM CET/CEST (3 PM BST, 15:00 UTC). The date of the next meeting can be found in the previous meeting minutes.

Contributorship and mailing list