Add remaining allowedValues annotations and CI check

[dheeraj12347]

Description

This PR completes the remaining allowedValues annotation work for the CloudStack API parameters identified during the allowed-values audit and adds a CI check to prevent missing annotations from being introduced.

Changes

• Added allowedValues annotations to the remaining statically-known enum-like API parameters.
• Added handling for the CheckAndRepairVolumeCmd.repair parameter and its associated inner enum.
• Added scripts/check_allowed_values.py to detect string parameters whose descriptions specify a closed set of valid/possible/allowed values but do not declare allowedValues.
• Extended the checker to cross-reference inner enums in command classes with their @Parameter fields.
• Added unit tests in scripts/test_check_allowed_values.py covering:
  • valid-value extraction
  • and-separated values
  • open-ended protocol values
  • string vs non-string parameters
  • missing allowedValues
  • existing allowedValues
  • inner enum detection
  • enum parameters using allowedValueType
• Added the allowed-values check to the CloudStack GitHub Actions CI workflow.

Validation

The following checks pass locally:

python3 -m unittest scripts.test_check_allowed_values -v
Ran 13 tests ... OK

python3 -m py_compile \
    scripts/check_allowed_values.py \
    scripts/test_check_allowed_values.py

python3 scripts/check_allowed_values.py
No missing allowedValues annotations found.

git diff --cached --check

The CI workflow added by this PR runs:

python3 scripts/check_allowed_values.py

against the CloudStack repository.

Scope

This check is intended to identify statically-known, closed sets of allowed values. Deployment-dependent values that require runtime discovery are not treated as static allowedValues.



---


# 3. Why this description is appropriate for your proposal


This isn't arbitrary wording.


Your proposal explicitly defines PR4/D4 as:


> **Tier 4 annotations + CI lint rules**, including a **description-pattern check + cross-reference check**. :contentReference[oaicite:1]{index=1}


And your Phase 4 plan specifically says the CI should:


- detect descriptions mentioning `"valid values"` or similar;
- detect missing `allowedValues`;
- cross-reference inner enums against `@Parameter` fields. :contentReference[oaicite:2]{index=2}


So the PR description is describing the actual deliverable you committed to.


---


# 4. Add this as the "Why" paragraph if GitHub asks for more context


If you want a short explanation of **why this change is needed**, use this:


```markdown
## Why


CloudStack already knows many API parameters have a fixed set of valid values, but some of this information is only present in human-readable parameter descriptions. This makes it difficult for clients such as CloudMonkey to consume the information reliably.


The `allowedValues` metadata introduced in the earlier API-discovery work provides a structured representation of these values. This PR completes the remaining static annotations identified during the audit and adds a CI guard so that future parameters with explicitly documented closed value sets are less likely to miss the metadata.

[dheeraj12347]

Hi @Pearl1594 and @soreana

I’ve opened PR #13904 for the remaining allowedValues annotations and the CI lint check.

The CI checker now covers the description-pattern check as well as the inner-enum/@parameter cross-reference, and I’ve added unit tests for the checker. Locally, all 13 tests pass, py_compile passes, and the repository-wide check reports no missing allowedValues annotations.

The PR is currently waiting for maintainer approval for the GitHub Actions workflow before the checks can run.

With PR #13904 covering the Tier 4 annotations + CI part of Phase 4, I’m planning to move on to the remaining Phase 4 deliverable: updating CloudMonkey’s bundled apis.json and adding the developer documentation/annotation guidelines.

Please let me know if you’d like anything adjusted in #13904 before I proceed with that.