Convention for file names of API definition

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

Convention for file names of API definition #69

Closed rartych closed 1 week ago

rartych commented 3 weeks ago

Problem description There is currently no guidelines for file names of API definition files in CAMARA. The initially agreed proposal is to use the convention api-name.yaml as a guideline for the API definition file names.

Expected behavior Change the file name to home-devices-qod.yaml before or as a part of release PR for M4.

Alternative solution Wait for the final guidelines.

Additional context See the discussion in Commonalities

jpengar commented 3 weeks ago

I plan to address this as part of the public release PR. I think I will also update home_devices_qod_user_stories.md.

jpengar commented 3 weeks ago

To be fixed in https://github.com/camaraproject/HomeDevicesQoD/pull/70