docs: fix stale references left by the API split (#184) - #186
Merged
clundie-CL merged 1 commit intoAug 26, 2026
Merged
Conversation
caubut-charter
requested review from
benhepworth,
clundie-CL and
mayur007
as code owners
August 25, 2026 16:55
caubut-charter
force-pushed
the
184-stale-reference-cleanup
branch
from
August 25, 2026 17:01
cd74499 to
f64a314
Compare
The repository used to define one monolithic `network-access-management` API. PR camaraproject#153 split it into `network-access-devices` and `network-access-domains`, but several references to the pre-split world, and several documents that had drifted from the tree, were never updated. Old API name where a split API name is now required: - `TrustDomainsUser_Story.md` said the API Provider must have implemented the "Network Access Management (NAM)" API; it is the Network Access Domains API, as the sibling device-registration story already states. - `code/Test_definitions/README.md` described a single API; it covers both. - Five schema descriptions placed their resource "within the network access management system"; each now names the API that actually exposes it. Documented behaviour that does not exist: - `TrustDomainsUser_Story.md` listed `409 INCOMPATIBLE_STATE` on Trust Domain deletion. `deleteTrustDomain` documents 204/400/401/403/404/500/503 and no 409 at all; the only 409 in that spec is `ALREADY_EXISTS` on creation. Replaced with the exception the spec actually defines. - `DeviceRebootRequest_User_Story.md` omitted the `409 ALREADY_EXISTS`, `409 INCOMPATIBLE_STATE` and `422 MISSING_IDENTIFIER` responses that the devices spec does document. Added. `code/README.md` drift: - The folder tree omitted `Test_definitions/` and three of the four files in `common/`. - The Component Breakdown table listed 5 of the 11 component files. It now lists all of them, with a "Used by" column stating which API pulls each one in; this was verified by resolving every `$ref` transitively from both specs. - `NAM_Common.yaml`'s contents were described three different ways in three places, none of them complete. Reconciled against the file. - Removed two now-redundant restatements of the same facts so each component is described once. Reference fixes: the root README pointed at a non-existent local `APIBacklog.md`, now linked to the file in camaraproject/APIBacklog.
caubut-charter
force-pushed
the
184-stale-reference-cleanup
branch
from
August 25, 2026 17:06
f64a314 to
35c196a
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
What this PR does / why we need it:
Fixes stale references left behind by the API split. The repository used to define one monolithic
network-access-managementAPI; #153 split it intonetwork-access-devicesandnetwork-access-domains, but several references to the pre-split world — and several documentsthat had drifted from the tree — were never updated.
Old API name where a split API name is required
TrustDomainsUser_Story.mdsaid the API Provider must have implemented the "Network AccessManagement (NAM)" API. It is the Network Access Domains API, as the sibling
device-registration story already states correctly.
code/Test_definitions/README.mddescribed a single API; the directory covers both.each now names the API that actually exposes it.
Documented behaviour that does not exist
TrustDomainsUser_Story.mdlisted409 Conflict (INCOMPATIBLE_STATE)for Trust Domain deletion.deleteTrustDomaindocuments 204/400/401/403/404/500/503 and no 409 at all; the only 409 in thatspec is
ALREADY_EXISTSon creation. Replaced with the exception the spec actually defines.DeviceRebootRequest_User_Story.mdomitted409 ALREADY_EXISTS,409 INCOMPATIBLE_STATEand422 MISSING_IDENTIFIER, all of which the devices spec does document. Added.code/README.mddriftTest_definitions/and three of the four files incommon/."Used by" column, produced by resolving every
$reftransitively from both specs.NAM_Common.yaml's contents were described three different ways in three places, none of themcomplete. Reconciled against the file.
Reference fix — the root README pointed at a non-existent local
APIBacklog.md; now links tothe file in
camaraproject/APIBacklog.Which issue(s) this PR fixes:
Fixes #184
Does this PR introduce a breaking change?
Special notes for reviewers:
rather than edited.
redocly lint: 0 errors, 9 warnings — unchanged frommain.so the resolution is "take this branch's version") and with the Remove incomplete thread specification #65 branch on
code/README.md.Reported, deliberately not fixed here:
CHANGELOG.md:30,31,32,57— four links point atcamaraproject/DeviceIdentifier/device-identifier.yamlinstead of this repository, a bootstrap template copy-paste. Not edited:released history, and
/CHANGELOG.mdrequires release-management review.documentation/. Not edited: the sentence sits inside aCAMARA:MANDATORYblock, so the fixbelongs upstream in Commonalities or in actually adding the document.
projects.tmforum.org, a retired Confluence instance, anddocumentation/API_documentation/README.MD:15links a login-gatedengage.tmforum.orgdownload.Not changed — no verified replacement URLs.
README.md:12says the repository "does not yet belong to a CAMARA Sub Project" while lines49–50 refer to "this Sub Project" and the
sp-nammailing list. Likely CAMARA-managedboilerplate, so left alone.
code/Test_definitions/README.md:111— a lint recipe labelled "from anywhere" whose lastargument is a repo-relative path, so it only works from the repository root.
Changelog input
Additional documentation
This section can be blank.