Skip to content

fix(docs): system parameters schema and cue definition #335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 13 commits into
base: feat/signed-doc-spec-0.04
Choose a base branch
from

Conversation

nathanbogale
Copy link

Description

This PR introduces the following changes to the Brand, Campaign, Category and Decision Parameters document definition:

  1. Schema Integration:

    • Created brand, Campaign, Category specific cue files and respective json schema files with expected parameters and fields
    • Updated the payload.schema field to load and integrate the schema for Parameters from payload_schemas/(brand, campaign, category, decision)_parameters.schema.json.
  2. Metadata Enhancements:

    • Added detailed validation rules for parameters and collaborators metadata fields to ensure consistency and clarity in document references and collaboration processes.

Related Issue(s)

Parent issue: #122 (Brands, Campaigns, Categories analysis). (

Please confirm the following checks

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream module

@nathanbogale nathanbogale requested review from stevenj and neil-iohk May 19, 2025 07:05
@nathanbogale nathanbogale self-assigned this May 19, 2025
@nathanbogale nathanbogale added documentation Improvements or additions to documentation F14 labels May 19, 2025
@nathanbogale nathanbogale added the do not merge yet PR is not ready to merge yet label May 19, 2025
@nathanbogale nathanbogale requested a review from stevenj May 22, 2025 14:36
@nathanbogale nathanbogale removed the do not merge yet PR is not ready to merge yet label May 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation F14
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants