Skip to content

Fix/api file names#59

Merged
stroncoso-quobis merged 7 commits intocamaraproject:mainfrom
stroncoso-quobis:fix/api-file-names
Jan 15, 2025
Merged

Fix/api file names#59
stroncoso-quobis merged 7 commits intocamaraproject:mainfrom
stroncoso-quobis:fix/api-file-names

Conversation

@stroncoso-quobis
Copy link
Collaborator

What type of PR is this?

  • subproject management

What this PR does / why we need it:

According to API Design Guidelines:
api-name is a kebab-case string used to create unique names or values of objects and parameters related to given AP

The API functionalities must be implemented following the specifications of the Open API version 3.0.3 using api-name as the filename and the .yaml

Servers url:
apiRoot variable and the fixed base path containing api-name
Identified by @rartych at #57

Which issue(s) this PR fixes:

Fixes #57

Special notes for reviewers:

Note that Notification-Channel will not be included on final release. Due that, the issue with the URL (ending with /deviceId) won't be fixed on this PR.

Changelog input

 release-note
 - Fixes #57 - File names and api-name renames according API design guidelines

Additional documentation

none

@rartych
Copy link
Collaborator

rartych commented Jan 14, 2025

Line 99 of webrtc-events.yaml

GET /vvoip/session/{vvoipSessionId} endpoint.

should reflect new path in webrtc-call-handling.yaml

@stroncoso-quobis
Copy link
Collaborator Author

Thanks @rartych for your feedback. Fixed on d45d8e3

Ready to be approved by @sushanthmavenir or @pradeepachar-mavenir and merged.

Release team was already informed about the API name changes, so waiting for this to be merged.

Best Regards,

@stroncoso-quobis stroncoso-quobis merged commit 38b14b6 into camaraproject:main Jan 15, 2025
1 check passed
@stroncoso-quobis stroncoso-quobis deleted the fix/api-file-names branch July 16, 2025 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

File names and api-name

3 participants