-
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
README, CHANGELOG and released versions update including Redoc/SwaggerEditor previews #54
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It will be discussed in Commonalities, but it can be helpful to provide also link to Swagger Editor to render the yaml for displaying the documentation: https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/HomeDevicesQoD/release-0.2.0/code/API_definitions/home_devices_qod.yaml Then the user can choose his preferred on-line tool.
I've added the Swagger Editor link in cfa1626. And CHANGELOG.md has been updated as well. In any case, I will wait for final agreement in Commonalities to do the same. Eventually the releases should also be updated with the same info as CHANGELOG.md. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Updated the README "Status and released versions" section. It also includes a Redoc preview link, which is more suitable for viewing API definition and documentation in a more visual and friendly way. The link to the API spec file has also been retained.
UPDATE (14/08): CHANGELOG.md and releases information will be updated accordingly as well.
Which issue(s) this PR fixes:
N/A
Special notes for reviewers:
This change is motivated by camaraproject/QualityOnDemand#199. Before MERGE, this PR will be aligned with the final agreement to be reached in the QualityOnDemand project.
Changelog input
N/A
Additional documentation
N/A