camaraproject / WebRTC

Repository to describe, develop, document and test the WebRTC API family
Apache License 2.0
5 stars 8 forks source link

Updated API documentation Linting rules - Issue#33 #37

Closed JavierVillaLabarra closed 5 months ago

JavierVillaLabarra commented 6 months ago

First version of API documents yaml. updated Linting rules #33

JavierVillaLabarra commented 5 months ago

@TEF-RicardoSerr @rartych Looking through the yaml of other APIs in Camara, I have seen that the documentation must be included in the Code API Yaml. Need to review this

Thanks

rartych commented 5 months ago

Looking through the yaml of other APIs in Camara, I have seen that the documentation must be included in the Code API Yaml.

Yes, the yaml files should be the single source of truth containing documentation that can be rendered by tools like Redoc or Swagger. Additional documentation can be placed in .md files.

I propose to open separate issue on that topic.