Feature/spectral rule leading capability #87
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.
Closes #7
Summary
This PR adds a new Spectral rule enforcing that all OpenAPI specifications explicitly declare the leading business capability through the
info.x-leading-capabilityfield. This ensures every API is traceable to its primary business capability as defined in LeanIX.Changes Made
Spectral Rule:
info-leading-capabilityIntroduced a new rule requiring
info.x-leading-capabilityin all OpenAPI files.Validation checks that the value matches one of the approved UKHSA Business Capabilities.
Custom error message for violations:
UKHSA Business Capabilities List
Documentation Updates
x-leading-capabilityvalue and fix validation errors.Example Specifications
Added valid and invalid OpenAPI examples to demonstrate compliance and failure scenarios.
info.x-leading-capabilityvalue.