Skip to content

Reset API and test code version information in main branch to wip #21

@hdamker-bot

Description

@hdamker-bot

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/qa-assistant-service.yaml: info.version — currently 0.1.0, should be wip
  • code/API_definitions/qa-assistant-service.yaml: server URL version — currently v0.1, should be vwip
  • code/API_definitions/qa-assistant-manage.yaml: info.version — currently 0.1.0, should be wip
  • code/API_definitions/qa-assistant-manage.yaml: server URL version — currently v0.1, should be vwip
  • code/API_definitions/knowledge-base.yaml: info.version — currently 0.1.0, should be wip
  • code/API_definitions/knowledge-base.yaml: server URL version — currently v0.1, should be vwip

Test Definition Files:

  • code/Test_definitions/qa-assistant-service.feature (line 1): Feature header — currently v0.1.0, should be vwip
  • code/Test_definitions/qa-assistant-service.feature (line 14): resource URL — currently v0.1, should be vwip
  • code/Test_definitions/qa-assistant-manage.feature (line 1): Feature header — currently v0.1.0, should be vwip
  • code/Test_definitions/qa-assistant-manage.feature (line 14): resource URL — currently v0.1, should be vwip
  • code/Test_definitions/knowledge-base.feature (line 1): Feature header — currently v0.1.0, should be vwip
  • code/Test_definitions/knowledge-base.feature (line 14): resource URL — currently v0.1, should be vwip

Expected action

Codeowners should create a PR to update the affected files to use wip versions:

  • Set info.version to "wip" in OpenAPI YAML files
  • Set servers[].url to use /vwip path 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:


Automated check by CAMARA project-administration — checked 3 API definitions and 3 test files

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions