camaraproject / QualityOnDemand

Repository to describe, develop, document and test the QualityOnDemand API family
https://wiki.camaraproject.org/x/zwOeAQ
Apache License 2.0
41 stars 59 forks source link

Add documentation into API definition for release v0.9.0 #144

Closed hdamker closed 1 year ago

hdamker commented 1 year ago

Problem description

Documentation is not in sync with the API definition (some PRs changed the API documentation in parallel, some not).

Expected action

Add documentation to API definition as discussed in https://github.com/camaraproject/WorkingGroups/issues/164

Additional context

Agreement is that CAMARA documentation should be embedded within the OAS definition, and not separate. This reduces the effort required in maintaining documentation.