Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spring25 API requirements #51

Open
stroncoso-quobis opened this issue Sep 12, 2024 · 1 comment
Open

Spring25 API requirements #51

stroncoso-quobis opened this issue Sep 12, 2024 · 1 comment

Comments

@stroncoso-quobis
Copy link
Collaborator

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
@tanjadegroot
Copy link

In addition:

  • 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants