Skip to content

Incorporating config into schema definition #1253

@thompson-tomo

Description

@thompson-tomo

Is your feature request related to a problem? Please describe.
I want to have the documentation generated by weaver to contain the necessary config options which includes both global config options and local options.

Describe the solution you'd like
I want to be able to define on both signals and attributes the config option.

This definition would contain:

  • key which points to declarative config position
  • example value
  • value type
  • requirement
  • brief etc

Then after schema resolution these user defined config options are extended with the declarative config options ie the option to include attributes on the resource.

This enables docs and code generation to incorporate the relevant config options.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Annotations were considered but strongly typed is preferred due to use case of syncing config options to declarative config.

Tip: React with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding +1 or me too, to help us triage it. Learn more here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    modelModifies the model for signals and attributes used by Weaver.

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions