Skip to content

fix: clear release-review Spectral warnings (S-011/S-015/S-030/S-031) (#162)#163

Merged
clundie-CL merged 1 commit into
camaraproject:mainfrom
cablelabs:162-clear-release-review-spectral-warnings
Jun 29, 2026
Merged

fix: clear release-review Spectral warnings (S-011/S-015/S-030/S-031) (#162)#163
clundie-CL merged 1 commit into
camaraproject:mainfrom
cablelabs:162-clear-release-review-spectral-warnings

Conversation

@clundie-CL

Copy link
Copy Markdown
Contributor

What type of PR is this?

  • cleanup

What this PR does / why we need it:

The r3.1 release-review validation surfaced 29 warnings + 61 hints (0 errors) from the stricter release-review Spectral profile (.spectral-r4.yaml) — findings the PR-time profile does not promote, so the implementation PRs were green while these only appeared at snapshot time. This PR clears all 29 warnings so the RC snapshot validates cleanly.

Changes by rule:

  • S-011 (property/example description): added missing descriptions, and lifted descriptions that were nested inside allOf up to the property level so the linter sees them (ResourceIdentifier.id, ResourceAudit.createdAt/modifiedAt, ServiceSite.id, RebootRequestUpdate.atTime, TrustDomainUpdate.expiration, BootstrappingInfo.selectedProtocol, GenerateDeviceCredential.selectedType, TrustDomainDeviceUpdate.bootstrappingInfo); added node-level descriptions to the request Create examples.
  • S-031 (array items description): added descriptions to the supportedSecurityModes and supportedDestinationTypes capability item schemas.
  • S-015 (schema name PascalCase): renamed schema UUIDUuid and updated all $refs (1 definition + 10 references across 7 module files).
  • S-030 (required property not in properties): TrustDomainCreate and TrustDomainDeviceCreate declared their create-only property (serviceId / externalId) as a sibling of required, which the rule flags because it does not resolve allOf. Moved each property into the allOf branch — mirroring the existing RebootRequestCreate structure — so required has no sibling properties. This is semantically equivalent (the merged schema is unchanged).

The remaining 61 hints are all S-313 (owasp:api4:2023-string-restricted, free-form strings without format/pattern/enum) — the documented "acceptable / no fix needed" set, intentionally left as-is.

Which issue(s) this PR fixes:

Fixes #162

Does this PR introduce a breaking change?

  • Yes
  • No

Special notes for reviewers:

  • The UUIDUuid rename touches the schema name only; the field type/format/pattern are unchanged, so it is not a wire-level breaking change.
  • Verified by bundling each spec and running the camaraproject/tooling .spectral-r4.yaml ruleset against the bundle (the same engine the release review uses): result is now 0 errors / 0 warnings, with only the 61 S-313 hints remaining.

Changelog input

release-note Cleared all release-review Spectral warnings (S-011/S-015/S-030/S-031); renamed the UUID schema to Uuid (PascalCase) with no change to the on-the-wire value.

Additional documentation

This section can be blank.

docs

- S-011: add missing property/example descriptions; lift nested allOf
  descriptions to the property level (createdAt, modifiedAt, expiration,
  atTime, selectedProtocol, selectedType, bootstrappingInfo)
- S-015: rename schema UUID -> Uuid (PascalCase) and update all $refs
- S-030: move create-only properties into the allOf branch so the
  required list has no sibling properties (TrustDomainCreate,
  TrustDomainDeviceCreate)
- S-031: add descriptions to capability array items

@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 99c6b06 into camaraproject:main Jun 29, 2026
2 checks passed
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.

Clear release-review Spectral warnings (S-011/S-015/S-030/S-031) ahead of r3.1 RC

2 participants