Skip to content

Move redocly.yaml and README.md from code/API_definitions/ to code/ #134

Description

@clundie-CL

Problem description

Two files currently in code/API_definitions/ aren't actually API definitions — they're a Redocly CLI configuration file and a directory-level README. After the layout refactor in #121, both fit more naturally at code/ as siblings of API_definitions/, common/, and modules/.

redocly.yaml

code/API_definitions/redocly.yaml is the Redocly CLI configuration file for spec linting and bundling, not an API definition. Two validation findings from PR #131 fire on this file because the validation framework treats everything under code/API_definitions/ as an API definition candidate:

  • Spectral unrecognized-format — "The provided document does not match any of the registered formats [OpenAPI 2.0 (Swagger), OpenAPI 3.x, …]"
  • Python P-019 — "API definition file 'redocly.yaml' is not listed in release-plan.yaml — possible orphan or naming mismatch"

Note that the central CAMARA tooling doesn't actually consume NAM's redocly.yaml — both the PR-time and snapshot-time bundlers invoke redocly bundle from the repo root without a --config flag, and Redocly CLI searches only the current working directory for its config (it doesn't walk parent directories). So the file is local-developer-only today, and its location doesn't affect central tooling. The move is purely about clearing the validation false positives.

README.md

code/API_definitions/README.md is the directory-level authoring and bundling guide. Its content already documents the full code/ tree — the folder-structure diagram shows code/ as the root, and the architecture rationale, file-purposes, and bundling sections span API_definitions/, common/, and modules/. The README is logically a code/-level doc that happens to live in the API_definitions/ subdirectory for historical reasons. Moving it up makes the document's scope match its physical location.

Expected action

  1. git mv code/API_definitions/redocly.yaml code/redocly.yaml.
  2. git mv code/API_definitions/README.md code/README.md.
  3. Update code/README.md for the new location:
    • Lint/bundle command examples change from cd code/API_definitions; redocly lint network-access-management.yaml to cd code; redocly lint API_definitions/network-access-management.yaml (Redocly CLI auto-discovers redocly.yaml in cwd).
    • File Purposes section currently uses ../common/ and ../modules/ paths (because the README lived inside API_definitions/). After the move these become common/ and modules/ (no ../) since the README is now adjacent to those directories.
    • Section headings can stay as-is; the document's existing structure already maps cleanly to a code/-level perspective.
  4. Verify the central CAMARA Validation Framework still discovers redocly.yaml if needed — most likely a no-op since the central tooling doesn't read it anyway (see "Problem description" above). README move has no tooling impact.

Additional context

Metadata

Metadata

Assignees

No one assigned

    Labels

    Fall26subproject managementIssues and PRs related to the management of the sub project

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions