fix: clear release-review Spectral warnings (S-011/S-015/S-030/S-031) (#162)#163
Merged
clundie-CL merged 1 commit intoJun 29, 2026
Conversation
- 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
clundie-CL
requested review from
benhepworth,
caubut-charter and
mayur007
as code owners
June 29, 2026 21:16
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:
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:
description): added missing descriptions, and lifted descriptions that were nested insideallOfup 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 requestCreateexamples.itemsdescription): added descriptions to thesupportedSecurityModesandsupportedDestinationTypescapability item schemas.UUID→Uuidand updated all$refs (1 definition + 10 references across 7 module files).properties):TrustDomainCreateandTrustDomainDeviceCreatedeclared their create-only property (serviceId/externalId) as a sibling ofrequired, which the rule flags because it does not resolveallOf. Moved each property into theallOfbranch — mirroring the existingRebootRequestCreatestructure — sorequiredhas no siblingproperties. 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 withoutformat/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?
Special notes for reviewers:
UUID→Uuidrename touches the schema name only; the field type/format/pattern are unchanged, so it is not a wire-level breaking change.camaraproject/tooling.spectral-r4.yamlruleset 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
Additional documentation
This section can be blank.