You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Problem description
A series of issues regarding API definition makes not possible to target Fall24 metarelease, this working points are needed regarding API definition
Expected behavior
Release tracker to be included
Review API versioning guidelines (v1 path)
Review Security and Interoperability profile
Review notifications to be aligned with CAMARA subscription model
Alternative solution
n/a
Additional context
Review guidelines and create PRs for them
The text was updated successfully, but these errors were encountered:
Under the code folder, create a folder called "Test_definitions"
Remove capital letters and abbreviations from the API . yaml file names
For each API, create the -API-Readiness-Checklist.md in the documentation/API_documentation folder. Then create all required assets in that list for the targeted API release, e.g. <api-name_User_Story.md, Test definitions, etc.
Move the content of the file: https://github.com/camaraproject/WebRTC/blob/main/code/API_definitions/README.MD to the repo home README.md, the CHANGELOG.md, and if applicable, into the API yaml file (all API documentation is expected to be inline inside the yaml file. The HTML section at the end would best go into the documentation/SupportingDocuments section.
The README.md of the Supporting documents - content s more for the wiki. This README.md can be deleted. The only README.md used in the folder is the one in the repo home folder.
Note: compare the repo content with that of the QualityOnDemand repo as a good example.
Problem description
A series of issues regarding API definition makes not possible to target Fall24 metarelease, this working points are needed regarding API definition
Expected behavior
Alternative solution
n/a
Additional context
The text was updated successfully, but these errors were encountered: