search

camaraproject / HomeDevicesQoD

Repository to describe, develop, document and test the Home Devices QoD API family
Apache License 2.0
3 stars 9 forks source link

Align subproject and API spec with Commonalities v0.3.0 #57

Closed jpengar closed 8 months ago

jpengar commented 9 months ago

Problem description Align subproject and API spec with Commonalities v0.3.0 release.

Possible evolution Include all required changes such as linting ruleset, securitySchemes & scopes names, etc. Any changes that are ultimately applied will be listed in this issue and/or in the corresponding PR(s) for the record.

Alternative solution N/A

Additional context https://github.com/camaraproject/Commonalities/issues/111

jpengar commented 8 months ago

https://github.com/camaraproject/Commonalities/releases/tag/v0.3.0 is available.

Main highlights of Commonalities 0.3.0 are:

  • API Testing Guidelines give best practices and recommendations how to fulfill the minimum criteria of API readiness with respect to test cases and documentation,
  • API Linting Rules and OpenAPI Linting Rules Implementation Guideline document the scope and usage of initial OpenAPI Specification linting ruleset,
  • CAMARA_common.yaml includes the following changes:
    • CAMARA_common.json was changed to CAMARA_common.yaml to be consistent with all CAMARA API specs,
    • Includes guidance for info object in OpenAPI Specification,
    • Adds the aligned and updated device schema.

You can find more details in the CHANGELOG file.

All CAMARA subprojects are encouraged to follow Commonalities guidelines and especially adopt linting rules tooling as described in Implementation Guideline.

In the test phase linting rules proved to be effective in enhancing API specifications compliance with Design Guidelines and improving specifications quality by eliminating simple yet hard to catch mistakes.