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

v0.2.0 - Update API documentation according to v0.2.0 API version #18

Closed
jpengar opened this issue Jan 16, 2023 · 6 comments · Fixed by #38
Closed

v0.2.0 - Update API documentation according to v0.2.0 API version #18

jpengar opened this issue Jan 16, 2023 · 6 comments · Fixed by #38
Assignees

Comments

@jpengar
Copy link
Collaborator

jpengar commented Jan 16, 2023

Update v0.1.0 API documentation according to v0.2.0 API version defintion.

@jpengar
Copy link
Collaborator Author

jpengar commented Jan 16, 2023

Being addressed in PR #19

@jpengar
Copy link
Collaborator Author

jpengar commented Mar 14, 2023

PR #19 has been MERGED to dev-v0.2.0 branch with current documentation status (i.e. NOT including Doc changes related to issue #23 and PR #25).

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 main branch is assumed to be the latest. Documentation work corresponding to API release v0.2.0 (when resumed) will be done against the `main' branch until release v0.2.0 is agreed to be closed.

@jpengar jpengar changed the title dev-v0.2.0 - Update API documentation according to v0.2.0 API version v0.2.0 - Update API documentation according to v0.2.0 API version Mar 14, 2023
@jpengar
Copy link
Collaborator Author

jpengar commented Mar 14, 2023

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).
The Home Devices QoD spec file is already quite self-documented, so I'll wait for the final agreement in Commonalities to complete the documentation for release 0.2.0 to avoid unnecessary overhead.

@jpengar
Copy link
Collaborator Author

jpengar commented May 11, 2023

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

@jpengar
Copy link
Collaborator Author

jpengar commented May 23, 2023

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.

jpengar added a commit that referenced this issue Jun 6, 2023
…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]>
@jpengar
Copy link
Collaborator Author

jpengar commented Jun 6, 2023

#38 is MERGED. Issue fixed.

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

Successfully merging a pull request may close this issue.

1 participant