Uploaded image for project: 'Red Hat OpenShift Control Planes'
  1. Red Hat OpenShift Control Planes
  2. CNTRLPLANE-2781

Document valid character set for Azure offer field in API reference

XMLWordPrintable

    • None
    • False
    • Hide

      None

      Show
      None
    • False
    • None
    • None
    • None
    • None

      Resolve the TODO that appears in the generated docs/content/reference/api.md at line 3264: "TODO: What is the valid character set for this field?" for the Azure offer field.

      The docs file is auto-generated by make api-docs, so the TODO originates in the API Go type definitions under api/. The fix must be made in the API type comments, then regenerated with make api-docs.

      Why

      The API reference does not specify the valid character set or length constraints for the Azure offer field. Users have no way to validate their specs before submitting, leading to opaque errors.

      Acceptance Criteria

      • Locate the TODO in the API Go type definition under api/ that produces this generated doc text
      • Update the Go type comment to add the Azure Marketplace rules for the offer field (allowed characters, min/max length)
      • Link to the relevant Microsoft documentation for further reference
      • Remove the TODO comment from the API source
      • Run make api-docs to regenerate the documentation

      Technical Details

      • Generated file: docs/content/reference/api.md line 3264
      • Source: API Go type definitions under api/ (find the TODO matching this field)
      • TODO text: "TODO: What is the valid character set for this field?"
      • Context: Azure offer field in the API spec
      • Regenerate: make api-docs

              Unassigned Unassigned
              rh-ee-brcox Bryan Cox
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: