Skip to content

Publish JSON schema for activity configuration #6782

@bdash

Description

@bdash

I've seen from errors I've made while writing activity configurations that the provided activity configuration is validated against a JSON schema. Having the schema available would be useful for understanding the structure of the configurations, for times when it's hard to find details in the narrative documentation at http://docs.binary.ninja/dev/workflows.html.

Additionally, if the schema were checked into this repository it would be possible to leverage tools such as cargo typify to generate strongly-typed representations of the configuration. I have my own hand-rolled version of this at https://github.com/bdash/bn-bdash-extras/blob/dev/src/activity.rs because I'd rather lean on autocomplete to get the configuration structure right than have to re-read the documentation again.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Component: CoreIssue needs changes to the coreEffort: MediumIssue should take < 1 monthImpact: MediumIssue is impactful with a bad, or no, workaround

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions