-
Notifications
You must be signed in to change notification settings - Fork 5
Description
Problem description
The main branch of this repository contains API definitions and/or test files with version references that are not yet reset to wip. According to CAMARA guidelines, all version fields on the main branch must use work-in-progress (wip) versions between releases.
Files affected:
OpenAPI Definition Files:
code/API_definitions/device-roaming-status.yaml: info.version — currentlyvwip, should bewipcode/API_definitions/device-roaming-status-subscriptions.yaml: info.version — currentlyvwip, should bewip
Expected action
Codeowners should create a PR to update the affected files to use wip versions:
- Set
info.versionto"wip"in OpenAPI YAML files - Set
servers[].urlto use/vwippath segment (e.g.,{apiRoot}/api-name/vwip) - Update Feature lines in test files to reference
vwip - Update resource URLs in test files to use
/vwip/path segment
Additional context
This is a standard post-release procedure. It won't be necessary within the new CAMARA Release Workflow. The main branch will always stay in work-in-progress state, with version fields only updated to specific versions on dedicated release branches. Therefore the requested PR will prepare the repository for the next development cycle and aligns with the new CAMARA Release Workflow.
References:
- CAMARA API Design Guide - Versioning
- Original discussion: ReleaseManagement#328
- CAMARA Release Workflow and Metadata Concept
Automated check by CAMARA project-administration — checked 2 API definitions and 5 test files