Skip to content

SP-141: Document BUSINESS validation layer#355

Open
Kastriot Salihu (ksalihu) wants to merge 2 commits into
mainfrom
ksalihu/SP-141-document-business-validations
Open

SP-141: Document BUSINESS validation layer#355
Kastriot Salihu (ksalihu) wants to merge 2 commits into
mainfrom
ksalihu/SP-141-document-business-validations

Conversation

@ksalihu
Copy link
Copy Markdown
Contributor

@ksalihu Kastriot Salihu (ksalihu) commented May 22, 2026

Description

Surfaces the BUSINESS validation layer in the config validate command so it's discoverable from --help and the user guide, instead of requiring prior knowledge of the pacman API.

  • --layers help now enumerates the allowed values (SCHEMA, BUSINESS) and notes they can be combined.
  • Adds a new "Validate Package Configurations" section to docs/user-guide/config-commands.md covering --layers, --nodeKeys, console output, and the JSON report shape.
  • Adds a "Validate During Import" subsection clarifying that config import --validate runs the SCHEMA layer only, and links to config validate for business-rule checks.
  • Same clarification + a config validate entry in the agentic dev guide and the asset-registry-endpoints Cursor skill.

Default behaviour and CLI surface are unchanged — this only adds help text and documentation.

Relevant links

Checklist

  • I have self-reviewed this PR
  • I have tested the change and proved that it works in different scenarios — existing config-validate Jest spec still passes (5/5)
  • I have updated docs if needed

… docs

Document the BUSINESS validation layer in `config validate` so it is
discoverable from `--help` and the user guide instead of requiring prior
knowledge of the pacman API.

- module.ts: `--layers` help now enumerates the allowed values
  (SCHEMA, BUSINESS) and notes that they can be combined.
- config-commands.md: new "Validate Package Configurations" section
  covering `--layers`, `--nodeKeys`, console output, and the JSON report
  shape; new "Validate During Import" subsection clarifying that
  `config import --validate` runs SCHEMA only.
- agentic-development-guide.md: agent step now mentions that import-time
  validation is SCHEMA-only and shows `config validate --layers SCHEMA
  BUSINESS` as the way to run business rules.
- asset-registry-endpoints SKILL: same clarification for agents plus a
  Quick reference entry for `config validate`.

Default behaviour and CLI surface are unchanged; this only adds help
text and docs.

Includes-AI-Code: true
Co-authored-by: Cursor <cursoragent@cursor.com>
@ksalihu Kastriot Salihu (ksalihu) requested review from a team as code owners May 22, 2026 09:15
The note about the ~2–3s window where a freshly-imported staging version
isn't yet queryable by the validate endpoint is being tracked as a
separate concern. Removing it from the skill so the documentation
doesn't lock the behaviour in before the bug fix lands.

Includes-AI-Code: true
Co-authored-by: Cursor <cursoragent@cursor.com>
@sonarqubecloud
Copy link
Copy Markdown

Quality Gate Failed Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

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.

2 participants