Skip to content

fix: remove 404 from GET /network-access-devices collection - #191

Merged
clundie-CL merged 2 commits into
camaraproject:mainfrom
cablelabs:188-remove-collection-404
Oct 16, 2026
Merged

clundie-CL merged 2 commits into
camaraproject:mainfrom
cablelabs:188-remove-collection-404

Conversation

@clundie-CL

Copy link
Copy Markdown
Contributor

What type of PR is this?

  • correction

What this PR does / why we need it:

GET /network-access-devices declared a 404 response. A collection endpoint has no identifier to miss: an authorized caller with no devices gets 200 with an empty array, which the spec's own Collection responses section already states ("an empty collection is never signalled with 404"). The other collection GETs (/reboot-requests, /trust-domains, /services) already declare no 404.

Changes:

  • code/API_definitions/network-access-devices.yaml: remove the 404 (Generic404) response from getNetworkAccessDevices. Its response set is now 200, 400, 401, 403, 500, 503.
  • code/Test_definitions/network-access-devices-getNetworkAccessDevices.feature: update the header's documented response codes. The feature has no 404 scenario.

Which issue(s) this PR fixes:

Fixes #188

Does this PR introduce a breaking change?

  • Yes
  • No

Special notes for reviewers:

  • Scope. 404 stays on GET /network-access-devices/{networkAccessDeviceId} and on every reboot-request operation, where a specific ID can be missing. GET /trust-domains/{trustDomainId}/devices also keeps its 404, since the parent Trust Domain can be missing.
  • Compatibility. This removes a response the operation could never correctly return. Design Guide §7.4 lists modifying or adding responses as breaking. A consumer that handles 404 is unaffected, and the API is still 0.x.
  • Release timing. This lands on main after the r3.1 RC, so it will be in the r3.2 initial public snapshot.
  • Verification. redocly lint (run from code/) exits 0 on both specs with warnings unchanged from main. The CAMARA release-review Spectral ruleset reports findings identical to main.

Changelog input

 release-note
GET /network-access-devices no longer declares a 404 response; an empty result is 200 with an empty array.

Additional documentation

This section can be blank.

…oject#188)

- Drop the Generic404 response from getNetworkAccessDevices. A collection
  GET has no identifier to miss; an empty result is 200 with [], as the
  spec's collection-responses section already states.
- Align the operation's test-definition header with the remaining codes.
@clundie-CL clundie-CL mentioned this pull request Oct 2, 2026
1 of 2 tasks
@clundie-CL
clundie-CL marked this pull request as ready for review October 7, 2026 12:43
caubut-charter
caubut-charter previously approved these changes Oct 16, 2026

@caubut-charter caubut-charter left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving.

Two optional improvements: add an explicit empty-result scenario, and include the existing 400 response in the feature header’s response-code list. Neither blocks approval.

@caubut-charter caubut-charter left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@clundie-CL
clundie-CL merged commit d695f9c into camaraproject:main Oct 16, 2026
2 checks passed
@clundie-CL clundie-CL mentioned this pull request Oct 16, 2026
6 tasks done
clundie-CL added a commit that referenced this pull request Oct 16, 2026
…ss-domains 0.3.0-rc.2

Delta against 0.3.0-rc.1 from the candidate PRs #174, #180, #185, #186,
#187 and #191. #170, #173, #192 and #193 are administrative or
README/tooling-only and are not listed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove 404 from the GET /network-access-devices collection endpoint

2 participants