Skip to content

[bulk] Sync Release Information section (2025-12-12-001) #89

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

Open
hdamker-bot wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[bulk] Sync Release Information section (2025-12-12-001) #89

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8874997
[bulk] Sync Release Information section (2025-12-12-001)
hdamker-bot Dec 12, 2025
06e7f68
Fix header comment wording
hdamker Dec 12, 2025
97b4194
Apply suggestion from @hdamker for "General Description" link
hdamker Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 27 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ Sandbox API Repository to describe, develop, document, and test the DedicatedNet

* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/XIArAQ)

* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/OICGAQ)

For background on Dedicated Networks concepts and workflows, see the [General Description](documentation/API_documentation/DedicatedNetworks_GeneralDescription.md).
Copy link
Contributor

@tlohmar tlohmar Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks generally good.

One question on the relative URL. The README.md document seem to be available via two urls:

  1. The content of the README.md document will be rendered at the bottom of the repo landing page, i.e. https://github.com/camaraproject/DedicatedNetworks/
  2. The README.md document sits in the main branch, i.e. one can open it via https://github.com/camaraproject/DedicatedNetworks/blob/main/README.md

Does this relative url (document/API_.... or ./document/API_...) work in both cases?

Copy link
Contributor

@hdamker hdamker Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this relative url (document/API_.... or ./document/API_...) work in both cases?

Yes they do. You can have a look and test on https://github.com/camaraproject/Commonalities/blob/main/README.md if you like (there is a wild mix of file relative and root relative links ... but both work in this case as README.md is at the root of the repository). The links are relative to the file in the repository or the root of the repository, independent of how they are shown in GitHub. Cf. https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#relative-links

Use full qualified links only if you want to ensure that the reader goes to a specific released version or always to the most current in main branch.


## Scope

* Service APIs for DedicatedNetworks (see [APIBacklog.md](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md))
Expand All @@ -27,34 +31,33 @@ Sandbox API Repository to describe, develop, document, and test the DedicatedNet
* Describe, develop, document, and test the APIs
* Started: October 2024

## Release Information

**Version Control Notice:** This project undergoes active development with frequent updates to the main branch. No backward compatibility is guaranteed for any code in development branches, including main, until an official release is published. Code changes, including potential reversions, may occur between commits. We recommend using the latest official release version.

**NEW**: r1.2 with initial public release of dedicated-network v0.1.0, dedicated-network-profiles v0.1.0 and dedicated-network-accesses v0.1.0 is available.

**The latest public release is [r1.2](https://github.com/camaraproject/DedicatedNetworks/releases/tag/r1.2), with the API versions listed below**

To facilitate understanding of these APIs, please consult the [General Description](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/documentation/API_documentation/DedicatedNetworks_GeneralDescription.md) for essential concepts and workflows prior to examining the technical specifications.
Copy link
Contributor

@tlohmar tlohmar Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest to keep this line, as it acts more as a general introduction to the APIs. Maybe we can move this into the first section, i.e. before Scope. @hdamker Do you have a opinion or suggestion?

Copy link
Contributor

@hdamker hdamker Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tlohmar Good point - the General Description reference is valuable for readers new to DedicatedNetworks given the complexity of the concepts (network slicing, NPNs, APNs, etc.).

Since this is foundational documentation rather than release-specific information, it should live outside the auto-managed Release Information section. Here are two options:

Option A: Single sentence before Scope (minimal change)

Add a brief reference line after the wiki link, before the Scope section:

* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/OICGAQ)

For background on Dedicated Networks concepts and workflows, see the [General Description](documentation/API_documentation/DedicatedNetworks_GeneralDescription.md).

## Scope

Option B: Dedicated section (more prominent)

Create a brief ## Background section for better visibility:

* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/OICGAQ)

## Background

For an introduction to Dedicated Networks concepts, key roles, and high-level workflows, see the [General Description](documentation/API_documentation/DedicatedNetworks_GeneralDescription.md).

## Scope

Recommendation: Option A is sufficient - it's concise and places the reference early without adding structural overhead. Option B makes sense if you want to add more context in the future.

Either way, using a relative path (documentation/API_documentation/...) rather than an absolute GitHub URL with branch reference is more maintainable (and will work also if the reader is looking on a specific release).

Copy link
Contributor

@tlohmar tlohmar Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, Option A is good. And yes, should be ok to have release specific information inside the doc.

Copy link
Contributor

@hdamker hdamker Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 97b4194

<!-- CAMARA:RELEASE-INFO:START -->
<!-- The following section is automatically maintained by the CAMARA project-administration tooling: https://github.com/camaraproject/project-administration -->

* **dedicated-network v0.1.0 (initial public release)**
[[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network.yaml)
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network.yaml&nocors)
[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network.yaml)
## Release Information

* **dedicated-network-profiles v0.1.0 (initial public release)**
[[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network-profiles.yaml)
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-profiles.yaml&nocors)
[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-profiles.yaml)
> [!NOTE]
> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.

* **dedicated-network-accesses v0.1.0 (initial public release)**
* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/DedicatedNetworks/releases/tag/r1.2) (Fall25), with the following API versions:
* **dedicated-network-accesses v0.1.0**
[[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network-accesses.yaml)
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-accesses.yaml&nocors)
[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-accesses.yaml)

Previous public releases and pre-releases are available here: https://github.com/camaraproject/DedicatedNetworks/releases

For changes see the [CHANGELOG.md](https://github.com/camaraproject/DedicatedNetworks/blob/main/CHANGELOG.md)
[[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-accesses.yaml&nocors)
[[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-accesses.yaml)
* **dedicated-network-profiles v0.1.0**
[[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network-profiles.yaml)
[[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-profiles.yaml&nocors)
[[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-profiles.yaml)
* **dedicated-network v0.1.0**
[[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network.yaml)
[[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network.yaml&nocors)
[[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network.yaml)
* The latest public release is always available here: https://github.com/camaraproject/DedicatedNetworks/releases/latest
* Other releases of this repository are available in https://github.com/camaraproject/DedicatedNetworks/releases
* For changes see [CHANGELOG.md](https://github.com/camaraproject/DedicatedNetworks/blob/main/CHANGELOG.md)

_The above section is automatically synchronized by CAMARA project-administration._
<!-- CAMARA:RELEASE-INFO:END -->

## Contributing
* Meetings are held virtually
Expand Down