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.

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

Initial API Proposal for Dedicated Networks #18

Merged
merged 17 commits into from
Feb 24, 2025

Conversation

tlohmar
Copy link
Contributor

@tlohmar tlohmar commented Jan 22, 2025

What type of PR is this?

Add one of the following kinds:

  • enhancement/feature

What this PR does / why we need it:

This Pull Request provides an API specification for the Dedicated Networks API.

Which issue(s) this PR fixes:

Fixes #10

Special notes for reviewers:

Changelog input

 release-note

Additional documentation

This section can be blank.

docs

@eric-murray
Copy link
Contributor

Hi @tlohmar

The filenames should be the same as the API name in the path. So dedicated-network-accesses.yaml, and so on.

This comes from the API design guidelines:

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 or .json file extension.

@hdamker
Copy link
Contributor

hdamker commented Feb 6, 2025

@tlohmar initial "version" of all three YAML files in main should be wip, the version in server url accordingly vwip
(the API version will be set only in release (PRs), all PRs in between must set it to wip. First alpha release will get 0.1.0-alpha.1, there is no such thing then a patch version of 0.0 :-))

See https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#53-api-versions-throughout-the-release-process for more information

@tlohmar tlohmar merged commit 87e0557 into camaraproject:main Feb 24, 2025
2 checks passed
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.

API Design Requirements
6 participants