Repository to describe and document common guidelines and assets for CAMARA APIs
- 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: June 2023
- Location: virtually
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:
- templates for creating Github issues
- common data and error formats for CAMARA APIs in CAMARA_common.yaml
- OAS definition of CAMARA Event using CloudEvents: notification-as-cloud-event.yaml
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. |
| API-DocumentationTemplate.md | Template for documenting the APIs |
| API-Readiness-Checklist.md | A checklist that describes the minimum criteria for considering an API Ready |
| Camara_Versioning_Guidelines.md | Guidelines for API Subprojects on making releases |
| 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 |
|
- Release 0.3.0 of guidelines and assets for CAMARA APIs is available within the release-0.3.0 branch:
- Release 0.2.0 of guidelines and assets for CAMARA APIs is available within the release-0.2.0 branch:
- Release 0.1.0 of guidelines and assets for CAMARA APIs is available within the release-0.1.0 branch:
For changes see CHANGELOG.md
- Meetings are held virtually
- Schedule: bi-weekly, Monday, 4 PM CET/CEST (3 PM BST, 15:00 UTC)
- Meeting link: MS Teams
- To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit https://lists.camaraproject.org/g/sp-com.
- A message to all Contributors of this Sub Project can be sent using [email protected].