Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Convention for file names of API definition #69

Closed
rartych opened this issue Aug 20, 2024 · 2 comments · Fixed by #70
Closed

Convention for file names of API definition #69

rartych opened this issue Aug 20, 2024 · 2 comments · Fixed by #70
Labels
correction Suggest the correction of an issue in API specification or a misalignment with API design guidelines

Comments

@rartych
Copy link
Collaborator

rartych commented Aug 20, 2024

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
@rartych rartych added the correction Suggest the correction of an issue in API specification or a misalignment with API design guidelines label Aug 20, 2024
@jpengar
Copy link
Collaborator

jpengar commented Aug 20, 2024

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

This was referenced Aug 20, 2024
Closed
Merged
@jpengar
Copy link
Collaborator

jpengar commented Aug 22, 2024

To be fixed in #70

@bigludo7 bigludo7 mentioned this issue Sep 3, 2024
Closed
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
correction Suggest the correction of an issue in API specification or a misalignment with API design guidelines
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Public Release for Fall24 meta-release camaraproject/HomeDevicesQoD
2 participants
@jpengar @rartych