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
git mv code/API_definitions/redocly.yaml code/redocly.yaml.
git mv code/API_definitions/README.md code/README.md.
- 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.
- 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
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 atcode/as siblings ofAPI_definitions/,common/, andmodules/.redocly.yaml
code/API_definitions/redocly.yamlis 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 undercode/API_definitions/as an API definition candidate:unrecognized-format— "The provided document does not match any of the registered formats [OpenAPI 2.0 (Swagger), OpenAPI 3.x, …]"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 invokeredocly bundlefrom the repo root without a--configflag, 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.mdis the directory-level authoring and bundling guide. Its content already documents the fullcode/tree — the folder-structure diagram showscode/as the root, and the architecture rationale, file-purposes, and bundling sections spanAPI_definitions/,common/, andmodules/. The README is logically acode/-level doc that happens to live in theAPI_definitions/subdirectory for historical reasons. Moving it up makes the document's scope match its physical location.Expected action
git mv code/API_definitions/redocly.yaml code/redocly.yaml.git mv code/API_definitions/README.md code/README.md.code/README.mdfor the new location:cd code/API_definitions; redocly lint network-access-management.yamltocd code; redocly lint API_definitions/network-access-management.yaml(Redocly CLI auto-discoversredocly.yamlin cwd).../common/and../modules/paths (because the README lived insideAPI_definitions/). After the move these becomecommon/andmodules/(no../) since the README is now adjacent to those directories.code/-level perspective.redocly.yamlif 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
API_definitions/after the layout refactor in Move common/ and modules/ up one level under code/ #121 even though their content/role iscode/-level, not spec-level).code/{API_definitions,common,modules}/shape but leftredocly.yamlandREADME.mdinsideAPI_definitions/.