-
Notifications
You must be signed in to change notification settings - Fork 9
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
v0.2.0 - Update API documentation according to v0.2.0 API version #18
Comments
Being addressed in PR #19 |
PR #19 has been MERGED to This is part of the process described in the #27 issue to adapt the project to the release/versioning policy agreed in Commonalities, i.e. the |
There is a new issue in the Commonalities project Revisit API documentation template to reduce redundancy #164 that affects this. Basically because the way the CAMARA APIs are documented is being rethought. It is proposed not to have separate documentation at all, but to embed all documentation in the OAS definition itself (YAML). |
Still not resolved. Home Devices QoD current version has been nominated to provide the improved version of its spec file as a showcase for issue #164. The spec file is already self-documented as recommended. I'm waiting for the final agreement and issue resolution in Commonalities to complete and update the doc using a common format in the API spec. To be aligned with what it is being done in other subprojects as well (like QoD). |
Issue is addressed in #38. The PR updates API documentation according to v0.2.0 API version definition including changes from v0.1.0 release. The documentation is added to the API definition as discussed in camaraproject/WorkingGroups#164. |
…38) * jpengar/update-spec-doc-issue-18 * Missed changes in user stories doc * corrected deprecation disclaimer in old doc * Update code/API_definitions/home_devices_qod.yaml Co-authored-by: Rafal Artych <[email protected]> --------- Co-authored-by: Rafal Artych <[email protected]>
#38 is MERGED. Issue fixed. |
Update v0.1.0 API documentation according to v0.2.0 API version defintion.
The text was updated successfully, but these errors were encountered: